ChoDocs

外观

使用 dumi 发布个人的 npm 包 ​

作者:Choi Yang
发表于:2022-11-26
更新于:6 个月前
字数统计:869 字
阅读时长:3 分钟
阅读量:
【编程】基于 dumi 2.0 发布属于个人的 npm 包 | 造轮子必备技能 | 手把手 publish | 提供文档开箱即用 B 站视频传送门

前期准备 ​

  • 一个 npm 账号，如果没有的话需要自行注册。
npm 注册地址
https://www.npmjs.com/signup
  • dumi 基础，可以观看如下视频快速学习文档。
【编程】dumi 2.0 发布，上手使用 | 文档介绍 | 居然发现 bug？
https://www.bilibili.com/video/BV1KG4y1Z7ZX/

使用 dumi ​

通过脚手架安装，根据提示选择对应的模版，由于我们要发布 npm 包，所以选择 React Library。

sh
npx create-dumi

发布前注意事项 ​

第一，npm 源需要使用 npmjs

sh
npm config set registry https://registry.npmjs.org

第二，需要执行 npm login，填写用户名，邮箱等。

第三，package.json 里边 name 需要用小写，不能用大写

第四，确保 package.json 里边的 name 和目前

npmjs
https://www.npmjs.com/
网站已发布的不冲突。

版本号规范 ​

npm 包的版本通常遵循

semver 语义化版本
https://semver.org/lang/zh-CN/
规范。

版本格式为：major.minor.patch，每个字母代表的含义如下：

主版本号（major）：当你做了不兼容的 API 修改， 次版本号（minor）：当你做了向下兼容的功能性新增， 修订号（patch）：当你做了向下兼容的问题修正。

先行版本号是加到修订号的后面，作为版本号的延伸；当要发行大版本或核心功能时，但不能保证这个版本完全正常，就要先发一个先行版本。

先行版本号的格式是在修订版本号后面加上一个连接号（-），再加上一连串以点（.）分割的标识符，标识符可以由英文、数字和连接号（[0-9A-Za-z-]）组成。举个例子：

sh
1.0​​.0-alpha
1.0.0-alpha.1
1.0.0-0.2.5

常见的先行版本号有：

  • alpha：不稳定版本，一般而言，该版本的 Bug 较多，需要继续修改，是测试版本
  • beta：基本稳定，相对于 Alpha 版已经有了很大的进步，消除了严重错误
  • rc：和正式版基本相同，基本上不存在导致错误的 Bug
  • release：最终版本
此处参考：从零开始发布自己的 NPM 包
https://juejin.cn/post/7052307032971411463

当然，我们最好是使用命令来规范我们的版本，举例：

以下主要介绍常用的几个命令

  • npm version major （3.1.0 --> 4.0.0）
  • npm version minor（2.0.1 --> 2.1.0）
  • npm version patch（2.0.0 --> 2.0.1）

至于 prexxx 开头的，以及 release 相关可以查询下述文档拓展学习。

文档指引：npm version
https://www.npmjs.cn/cli/version/

补充相关命令 ​

sh
// 登录自己的 npm 账号
npm login

// 退出当前账号
npm logout

// 查看当前身份
npm who am i

// 发布
npm publish

// 撤销发布某个版本
npm unpublish [pkg]@[version]

解决遇到的问题 ​

403 问题 ​

sh
npm ERR! code E403
npm ERR! 403 403 Forbidden — PUT https://registry.npmjs.org/xxx — You do not have permission to publish xxx. Are you logged in as the correct user?
npm ERR! 403 In most cases, you or one of your dependencies are requesting
npm ERR! 403 a package version that is forbidden by your security policy.

一般是两种情况：

参考

Solve the error when npm publish for the first time.
https://medium.com/@su_bak/solve-the-error-when-npm-publish-for-the-first-time-a4cca150f379

Contributors ​

Choi Yang