如何发布一个npm包

引言

一直在使用npm,但是关于npm究竟是什么,其工作原理等,还不是很了解,于是研究了一下 npm官方文档,准备系统学习一下npm,作为一个开始,先实践一下如何发布npm包。

开始

npm包的Scope

Scope,我想把它翻译为空间,比如:

1
npm i @vue/compiler-dom

它的作用有两个:

  1. 标识相关库,比如@vue就表示和vue相关的库
  2. 防止重名,只要Scope不同,slash后面的包名称可以和其他库相同

为了有一个Scope,我们需要 注册 一个npm账号,以及 创建 一个npm组织。

创建一个 package.json 文件

可以手动创建该文件,也可以使用进入到你的包的根目录下,使用 npm init 进行创建。

创建一个 module

1
2
3
exports.printMsg = function() {
console.log("hello world");
}

登录你的npm账号

1
npm login

输入账号、密码和OTP后就可以登录了

发布你的包

1
npm publish

这样就可以发布了