什么是npm系列：3、如何发布本身的npm包

读完本篇文章后，你将学到"开发"、“配置”、"发布"，最终拥有属于你本身的npm包。

1. 初始化npm

经过npm init命令能够建立初始项目，须要逐步完善一下信息：

package name: (npmtest)
version: (1.0.0)
description:
entry point: (index.js)
test command:
git repository:
keywords:
author:
license: (ISC)
复制代码

建立完package.json以后，咱们就能够轰轰烈烈的写代码了。

2. 开发Tips

2.1 调试

开发中如何调试是一个痛点，不少人会把代码复制到node_modules中再调试结果，其实咱们有更好的办法："npm link"，使用流程以下：

1. 在包根目录执行npm link
2. 在项目中执行npm link package-name
3. 这个时候在项目中实时访问到package-name

目前这种方式在yarn中没法使用。

3. 发布

3.1 建立/登陆帐号

首先须要在www.npmjs.com/signup注册帐号。

完成以后在终端中执行npm login，输入帐号密码以后即登陆成功。

这里有一点须要注意，若是设置过taobao源，须要修改成npm源，使用以下指令还原：

npm config set registry http://registry.npmjs.org
复制代码

可是鉴于实际状况，咱们在taobao和npm源之间互相切换其实太麻烦了，比较好的解决方案就是配置package.json中的publishConfig字段，配置说明看下一段落。

3.2 package.json 配置

此次主要介绍：

• publishConfig
• main
• files

publishConfig

发布使用的配置。

"publishConfig": {
    "registry": "https://registry.npmjs.org/",
    "tag": "beta",
    "access": "public"
}
复制代码

• registry 源地址
• tag 发布对应的dist-tag标签
• access 若是是scoped包，必定须要设置为public（付费帐号除外）

main

包的入口执行文件，一般咱们会指定为index.js。

files

咱们须要控制npm包的大小，避免安装过程当中花费太多时间。通常来讲咱们只输出编译过的内容、文档、样式等。

package.json的files字段的做用就是控制包含在项目中的内容，它能够设置为文件或者文件名组成的数组。

除此以外，咱们还能够在根目录或子目录下建立.npmignore文件，写法和gitignore一致。

有些文件是没法忽略的：

• package.json
• README
• CHANGES / CHANGELOG / HISTORY
• LICENSE / LICENCE
• NOTICE
• The file in the "main" field

如下文件是默认忽略的：

• .git
• CVS
• .svn
• .hg
• .lock-wscript
• .wafpickle-N
• .*.swp
• .DS_Store
• ._*
• npm-debug.log
• .npmrc
• node_modules
• config.gypi
• *.orig
• package-lock.json

3.3 版本管理

版本号遵循语义化版本的规则，由MAJOR.MINOR.PATCH组成，在末尾还能够加上扩展的预发布版本号信息。

• MAJOR：当你作了不兼容的 API 修改，
• MINOR：当你作了向下兼容的功能性新增，
• PATCH：当你作了向下兼容的问题修正。

版本号能够手动修改，也能够经过npm version命令管理：

// 假设当前版本号 v1.0.0

npm version patch
// v1.0.1

npm version prepatch
// v1.0.2-0

npm version minor
// v1.1.0

npm version major
// v2.0.0
复制代码

npm version的完整命令以下：

npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=<prerelease-id>] | from-git]
复制代码

若是咱们要生成1.0.0-alpha.1风格的版本号，能够带上参数--preid:

npm version prerelease --preid=alpha
复制代码

当咱们执行了npm version以后，脚本会自动修改版本号，并在git中建立提交和标签，若是想要禁用该行为，能够传入--no-git-tag-version来阻止。

3.4 tag

npm的tag是用于标记不一样用途的版本，一个npm包至少会有latest标签，咱们能够根据测试版、预览版等不一样需求定制标签。

好比咱们有一个测试版本要发布，咱们能够指定dist tag为beta：

npm publish --tag beta
复制代码

当咱们测试完成，准备正式发布的时候，就能够把beta对应版本号演进到latest上。

3.5 发布

当一切准备就绪以后，咱们就能够进入发包的冲刺了。

npm publish
复制代码

注意！可能有人说我为何看到的只有错误，通常这个时候能够这样排查：

• registry检查是否正确
• 包名是否为@somescope/somepackagename形式
• 版本号是否未更新

若是包属于某个组织下，即@somescope/somepackagename形式的包名，执行命令须要调整为npm publish --access public。

通过千辛万苦以后，咱们终于发布成功了，但是若是咱们发现某个文件漏掉了，再发布一个版本也不太值得，咱们就可使用npm unpublish命令取消24小时以内发布的包，须要注意的是unpublish并不推荐使用。

4. 最佳实践

• semantic-release 自动生成changelog以及版本管理
• 代码规范+commit规范 magic-lint
• cgr 切换npm、yarn源

5. 场景讲解

• 每次发布操做流程
• 移除tag

5.1 每次发布流程

1. 开发功能，并提交代码
2. npm version major or minor or patch
3. npm publish

5.2 移除tag

npm dist-tag rm <pkg> <tag>
复制代码

系列汇总

• 什么是npm系列：1、npm简介
• 什么是npm系列：2、install 的十八般武艺
• 什么是npm系列：3、如何发布本身的npm包
• to be continued

本文同步发表于做者博客: 什么是npm系列：3、如何发布本身的npm包