npm 发布 工具包

60 阅读3分钟

准备工具包

使用 rollup 打包

使用 father 打包

git练习仓库

添加LICENSE

LICENSE即开源协议文件,这里使用MIT协议类型。

项目根目录添加文件LICENSE,复制一下内容放进去:

MIT License

Copyright (c) 2022 zyj

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Copyright © 2022 zyj 这一行,2022是年份,自行修改为当前年份,zyj是作者姓名。 package.json里修改license字段值为MIT

npm包发布

npm包类:有UI组件库,有工具函数库,还有使用的插件等,这里以工具函数库为例。

登录npm账号

执行 npm login 命令登录npm image.png

步骤:输入登录名-->输入密码-->输入邮箱(获取验证码)-->输入验证码

首次发布该工具库

登录成功之后即可执行发布命令:npm publish (确保npm包名称独一无二,否则会发布失败),发布成功如下图:

image.png

在npm中可以查看到刚刚发布的工具包 image.png

使用刚刚发布的npm包

首先安装我们发布的npm包,执行命令 npm install zyj-test-npm , 如下图: image.png

install 成功后可以直接在页面中使用:

image.png

更新npm包版本

  • 执行 npm version <版本号类型> (更新包的版本号)
  • 执行 npm publish

image.png

常用命令

弃用npm包

弃用npm 包,就是给npm包打上已作废的标签,表示不再更新维护,命令:npm deprecate <package-name> "<message>"

image.png

npm 上还是可以查到已弃用的npm包,包名也将继续被占用,如下图所示:

image.png

删除npm包

这是非常危险的行为,除非你确定这个包没有其他人使用,命令:npm unpublish <package-name> -force

image.png

再在npm网站上查找则查不到了:

image.png

删除后再发布,会报错,提示需要等待24小时后才可以重新发布该包

image.png

成员权限

发布npm是用自己的账号发布的,默认只有自己能更新包,如果想要给其他人更新npm包的权限,按以下方式: 打开npm包所在页面,点击右方settings栏,然后在Invite maintainer模块,输入要加入权限的npm账号的username,然后点击invite就加入,下方Maintainers就是有权限的npm项目成员列表。