如何将包发布到npm

npm是包管理工具，里面有大量的插件供开发者使用，当然我们也可以发布到npm上供其他开发者使用，以下是个index.js：

//index.js
export default () => {
  console.log("这里可以写发布的方法...");
};

这里希望将以上这个方法发布到npm，需要以下五步：

一、注册npm账户

这个比较简单，到npm站点自行注册一个npm账号即可，还需要验证邮箱，不然没有权限发布。

二、生成package.json

在项目根目录下执行npm init命令生成package.json。

// package.json
{
  "name": "publish-npm",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

默认字段简介：

• name：发布的包名，默认是上级文件夹名。不得与现在npm中的包名重复。包名不能有大写字母/空格/下滑线！
• version：包的版本，默认是1.0.0。对于npm包的版本号有一系列的规则，模块的版本号采用X.Y.Z的格式，具体体现为：
  1、修复bug，小改动，增加z。
  2、增加新特性，可向后兼容，增加y
  3、有很大的改动，无法向下兼容,增加x
• description：项目简介
• mian：入口文件，默认是index.js，可以修改成自己的文件
• scripts：包含各种脚本执行命令
• test：测试命令。
• author：写自己的账号名
• license：这个直接回车，开源文件协议吧，也可以是MIT，看需要吧。

三、通过命令行登录到npm

执行npm login，输入用户名，邮箱和密码即可登录。

liaoxiuli@liaoxiulideMacBook-Pro publish-npm % npm login
Username: liaocoder
Password: 
Email: (this IS public) xxx@163.com
Logged in as liaocoder on https://registry.npmjs.org/.

四、执行发布命令

在项目根目录下执行npm publish即可。

liaoxiuli@liaoxiulideMacBook-Pro publish-npm % npm publish
npm notice 
npm notice 📦  liaoxiulitestforjust1@1.0.1
npm notice === Tarball Contents === 
npm notice 78B  index.js    
npm notice 197B package.json
npm notice === Tarball Details === 
npm notice name:          liaoxiulitestforjust1                   
npm notice version:       1.0.1                                   
npm notice package size:  353 B                                   
npm notice unpacked size: 275 B                                   
npm notice shasum:        3f5fac11d7fe74be14265c5ff6bfd16faa60c74f
npm notice integrity:     sha512-V3ShbDY+j8KqB[...]y7mZeBdJPDYVQ==
npm notice total files:   2                                       
npm notice 
+ liaoxiulitestforjust1@1.0.1

登录到npm站点就可以看见发布的包。

image.png

五、使用方法

通过npm将包安装到项目中。

npm i liaoxiulitestforjust1

在项目中import引入就能使用。

import fn from "liaoxiulitestforjust1";
console.log( fn() );  //这里可以写发布的方法...