发布自己的npm组件库

前期准备

**git上建立自己的仓库,这样子是为了在本地初始化时,可以直接生成对应的 package.json **



克隆仓库

创建仓库成功后,gitbush本地,执行 git clone giturl

git蛮人性化的,在空仓库中有命令行提示,不懂得可以直接复制在本地执行

克隆成功后,假设现在,我是安装在D盘的 D:\ReactLearn\person 目录下,在该目录执行cmd打开命令行工具,针对于winodws用户,mac请自行打开命令行

初始化项目

初始化npm项目

在打开的命令行工具中执行 npm init -y -y 的意思是npm所询问的问题,默认都选择 y 初始化项目成功后,会发现 package.json 的名字默认就是git仓库的名称,这也是为什么初期要建立仓库的原因。

引入组件开发文档工具

对于自己的组件库,自然需要有文档供其他人的查阅与使用,这里选择 dumi 框架作为组件开发文档的框架,dumi中我们只需要专注组件功能与逻辑的开发,文档都是配置生成的,如果有其他的框架取代,后续涉及dumi的知识可以略过,dumi其实只是懒于写文档的一种捷径罢了,与发npm包其实没直接关系

初始化dumi项目

D:\ReactLearn\person 中执行 yarn create @umijs/dumi-lib --site site代表使用dumi的文档形式,这里注意,dumi的使用node版本必须是 v10.13.0 以上

初始化dumi项目之后,记得更新我们原本的package.json的name属性,避免与框架文件起冲突,这里只需要主要name即可,依赖还是dumi的依赖这里的name涉及到后续发布npm包的名称

注意下dumi的文件结构,可以按照该结构,先建立文件,在这我就不介绍dumi的使用,有兴趣的参考文档



这里需要注意,/src/index.ts必须导出你所需要别人使用的组件,为何在此导出后续讲到打包时会提及的,代码可以参考如下



这里导出的组件,就是后续别人使用的入口

使用方法:import {Foo} from '组件名称'

这里我们只导出简单的Foo组件,功能就是传入一个值页面展示罢了

<Foo value='Hello World'>

配置package.json

这里涉及到几个知识点

打包工具

因为组件库是需要我们打包后上传,例如dist文件夹,因此需要选择一种打包工具,dumi框架中默认使用了father的打包工具,因此无需过多关心打包的事情,只需要执行 yarn build 即可

打包类型

打包主流的目前所知,分为 esm cjs umd三种格式

esm:导出方式为 export import

cjs:导出方式为require

umd:整合为对象,通过script标签进行引入。

package.json 配置项

讲完打包的一些内容,就进入了发包的过程,npm发包主要看pck文件的配置,例如入口文件,发包文件夹等等,因此介绍下pck的配置便于更好的理解打包发包流程。贴上简单的配置图

main:入口文件,这指的是其他人使用时,从这个路径引入组件

module:es6编译入口文件

files:包含在项目中的文件(夹)数组,也就是你要发送到远端的文件夹

typings:TypeScript 的入口文件

打完包,完成pck的配置,我们就可以进入最后一个阶段了:发包到远端

发送npm包至远端

首先你得有一个npm账号,如何建立不赘述

先执行 npm login 进行登录

在执行 npm publish 将你的组件库发布到官网上。

在此可能会遇到一个错误403,这代表这你的npm包名称已经被占用了,或者当前的包版本不对。名称不对该名称或者使用组织名。包版本不对就升一个版本看看就好

好了,现在你拥有了属于自己的组件库,好好维护吧

发布自己的npm组件库的更多相关文章

  1. 基于Vue的npm组件库

    前言(*❦ω❦) 思维导图可能有点高糊,有点太大了,项目和导图文件放到github或giteee上,这个思维导图也是我文章的架构,思维导图是用FeHelper插件生成的,这个是一款开源chrome插件 ...

  2. 在npm上发布自己的vue组件库(使用npm install 或者 CDN的方式引用)

    一.npm publish发布包到npm库的命令是npm publish npm publish发布包,需要先配置webpack.json文件,如果没有webpack.json文件,可以通过npm i ...

  3. 如何发布自定义的UI 组件库到 npmjs.com 并且编写 UI组件说明文档

    记录基于 antd 封装业务组件并发布到npm 上的过程:(TS + React + Sass) 初始化项目: 1.yarn create react-app winyhui --typescript ...

  4. 如何使用@vue/cli 3.0在npm上创建,发布和使用你自己的Vue.js组件库

    译者按: 你可能npm人家的包过成千上万次,但你是否有创建,发布和使用过自己的npm包? 原文: How to create, publish and use your own VueJS Compo ...

  5. 创建一个自己的Vue UI组件库,并将它发布在npm上

    本文仅限于入门级,没有成规模制作,希望能对你有所帮助. 因为在开发多个项目中可能会用到同一个组件,那么我们通过复制粘贴的形式更新,无异于是笨拙的,我们可以通过上传到npm后,不断迭代npm包来实现更新 ...

  6. 如何快速为团队打造自己的组件库(上)—— Element 源码架构

    文章已收录到 github,欢迎 Watch 和 Star. 简介 详细讲解了 ElementUI 的源码架构,为下一步基于 ElementUI 打造团队自己的组件库打好坚实的基础. 如何快速为团队打 ...

  7. Vite+TS带你搭建一个属于自己的Vue3组件库

    theme: nico 前言 随着前端技术的发展,业界涌现出了许多的UI组件库.例如我们熟知的ElementUI,Vant,AntDesign等等.但是作为一个前端开发者,你知道一个UI组件库是如何被 ...

  8. Vue3 企业级优雅实战 - 组件库框架 - 1 搭建 pnpm monorepo

    前两篇文章分享了基于 vite3 vue3 的组件库基础工程 vue3-component-library-archetype 和用于快速创建该工程的工具 yyg-cli,但在中大型的企业级项目中,通 ...

  9. 从零开发一款自己的小程序UI组件库(一)

    写在前面:有开发过小程序的朋友肯定知道组件化开发的特性,高内聚与低耦合.使用已有的UI组件库,诸如:vantUI-weapp.minUI-weapp等UI组件库的诞生使我们的开发速度大大的加快,丰富的 ...

随机推荐

  1. 如何使用Docker构建前端项目

    原文链接 Docker单独部署前端项目和Node项目是非常便捷的,在这里分享一下Docker的使用,主要聊聊它的部署实践.(我是window10专业版安装Docker) Docker Docker是一 ...

  2. CRM项目的整理---第一篇

    CRM:cunstomer relationship management  客户管理系统 1.项目的使用者:销售  班主任    讲师  助教 2.项目的需求分析 2.1.注册 2.2.登录 2.3 ...

  3. OAuth2密码模式已死,最先进的Spring Cloud认证授权方案在这里

    旧的Spring Security OAuth2停止维护已经有一段时间了,99%的Spring Cloud微服务项目还在使用这些旧的体系,严重青黄不接.很多同学都在寻找新的解决方案,甚至还有念念不忘密 ...

  4. 665. Non-decreasing Array - LeetCode

    Question 665. Non-decreasing Array Solution 题目大意: 思路:当前判断2的时候可以将当前元素2变为4,也可以将上一个元素4变为2,再判断两变化后是否满足要求 ...

  5. jeecgboot-vue3笔记(三)弹窗的使用

    需求描述 点击按钮,弹窗窗体(子组件),确定后在子组件中完成业务逻辑处理(例如添加记录),然后回调父组件刷新以显示最近记录. 实现步骤 子组件 子组件定义BasicModal <BasicMod ...

  6. 小样本利器1.半监督一致性正则 Temporal Ensemble & Mean Teacher代码实现

    这个系列我们用现实中经常碰到的小样本问题来串联半监督,文本对抗,文本增强等模型优化方案.小样本的核心在于如何在有限的标注样本上,最大化模型的泛化能力,让模型对unseen的样本拥有很好的预测效果.之前 ...

  7. django框架5

    内容概要 模板语法之过滤器(类似于内置函数) 模板语法之标签(类似于流程控制) 自定义过滤器.标签.inclusion_tag 模板的导入 模板的继承 注释语法补充 前期数据准备(测试环境搭建) al ...

  8. python基础学习8

    python基础学习8 内容概要 字典的内置方法 元组的内置方法 集合的内置方法 垃圾回收机制 内容详情 字典的内置方法 一.类型转换 res = dict(name='jason', pwd=123 ...

  9. Myers差分算法的理解、实现、可视化

    作者:Oto_G QQ: 421739728 目录 简介 基础 差异的描述 好的差异比较 算法介绍 名词解释 两个定理 绘制编辑图 感谢 简介 本文章对Myers差分算法(Myers Diff Alg ...

  10. sklearn练习1 回归

    from sklearn.svm import SVR from sklearn.pipeline import make_pipeline from sklearn.preprocessing im ...