~ 使用 NPM 发布自定义的包

为了将整个 NPM 的流程串联起来,以下操作是:

  • 如何编写一个包
    • 将其发布到 NPM 仓库
      • 并通过 NPM 安装回本地

也就是说,在实际的开发过程中,我们可以把自己写的模块编写为一个包,方便代码的重用。


[1] 编写模块:模块的内容尽量保持简单,以 sayhello 为例


[2] 初始化包描述文件 package.json

package.json 文件的内容尽管相对较多,但是实际发布一个包时并不需要一行一行编写,可以通过命令生成:

// 进入hello.js所在目录,执行:
// 不熟悉的直接回车、回车即可
   npm init
   或 npm init -y  // 非交互式,直接以默认值生成 package.json

使用上述命令会帮助我们通过提问式的交互问答的形式,生成一个 package.json 文件


[3] 注册包仓库账号并登录

为了维护包,NPM 必须要使用仓库账号(已激活的)才允许将包发布到仓库中

// 注册账号(官网:https://www.npmjs.com),并完成邮件里的激活
   npm adduser
// 然后,在包的目录下执行以上命令,之后,按顺序输入已注册的账户名、密码和邮箱即可在命令行中完成登录

[4] 上传包

在刚刚创建的 package.json 文件所在的目录下,执行:

npm publish   // 开始上传包

在这个过程中,NPM 会将目录打包为一个存档文件,然后上传到官方源仓库中


[5] 安装包:为了体验和测试自己上传的包,可以在其他目录中执行 npm install <pkgname> 进行安装、使用