乐趣区

关于前端:工程化关于npm如何发布自己的npm包

jiezi

筹备工作

  1. node 版本 v14.18.0 以上
  2. 将 npm 更新至新版本（npm install -g [email protected]）

一、注册 npm 账号

注册地址：https://www.npmjs.com/

二、初始化我的项目

新建我的项目目录，应用 npm init 命令创立 package.json 文件，依照提醒填入初始信息。

如模块名称：mikey-npm-test（只能是小写）

初始版本号抉择：v1.0.0

模块名称需遵循相干政策要求：https://www.npmjs.com/policies，不可能与已有 NPM 模块名抵触等等。

创立入口文件如 index.js

function npmPublishTest(){
    var name = 'Mr.Mikey';
    var test = function() {console.log('Hello, my first NPM package')
    }
    return {
    name,
    test,
    }
}

module.exports = npmPublishTest()

创立 README.md 文件，填写阐明文档如：

一个根本的 npm 包文件构造如下

三、登录 npm

留神源的问题，只有 npm 官网源能够登录胜利，如果报错 403，个别是因为非 npm 官网源，可通过 npm get registry 命令查看源信息，切换源能够应用 nrm 进行治理。

简略的解决形式是在不确定源的状况下间接命令后带上源地址：

npm login --registry https://registry.npmjs.org

依据提醒输出之前注册的用户名、明码、邮箱，按回车后会发送验证邮件到注册邮箱，需填入验证码后再次回车确认，登录胜利如下图所示

四、公布 npm 包

留神源的问题，只有 npm 官网源能够公布胜利，命令后带上源地址即可

npm publish --registry https://registry.npmjs.org

公布胜利状态如下图所示

登录 npm 官网即可看到曾经公布的包

五、后续更新 npm 包

批改代码后，执行命令主动叠加版本号：

npm version patch

每次产生批改公布必须要批改版本号，npm 不容许批改内容后公布雷同的版本号

npm version 前面参数阐明：

patch：小变动，比方修复 bug 等，版本号变动 v1.0.0->v1.0.1

minor：减少新性能，不影响现有性能, 版本号变动 v1.0.0->v1.1.0

major：毁坏模块对向后的兼容性，版本号变动 v1.0.0->v2.0.0

迭代版本号之后反复第四步：

npm publish --registry https://registry.npmjs.org

六、撤销公布（慎用）

npm unpublish 包名 @版本号 –force（依据须要接上 npm 源地址）

示例：npm unpublish [email protected] --force --registry https://registry.npmjs.org

阐明：撤销公布的包被认为是一种不好的行为，因为如果有团队应用和依赖你的包时，撤销便会造成很大的影响。

  1. 依据标准，只有在发包的 24 小时内才容许撤销公布的包
  2. 即便你撤销了公布的包，发包的时候也不能再和被撤销的包的名称和版本反复了（即不能名称雷同，版本雷同，因为这两者形成的惟一标识曾经被 ” 占用 ” 了）

本文由博客一文多发平台 OpenWrite 公布！

退出移动版