NPM 包—发布、更新、撤销发布

1、初始化NPM

1.1 建项目文件夹

先建一个工程文件夹或者拉取远程git上的已有项目

mkdir my-test-project

1.2 初始化git

进入该文件夹，先初始化git（如果还没有的话），用于版本控制。在github（也可以其他）上新建一个与项目同名的远程仓库，并添加README.md文件，拷贝仓库地址，如：

// 拷贝github上的仓库地址
git@github.com:username/my-test-project.git

git init
git remote add origin git@github.com:usename//my-test-project.git
git push -u origin master

这样就把本地仓库和远程仓库关联起来了

1.3 初始化npm

在项目根目录下即my-test-project目录下执行，npm init，然后根据提示填写相关信息，有些可以略过后续修改。

通过npm init命令可以创建初始项目，需要逐步完善一下信息：

package name: (myNpm)
version: (1.0.0)
description:
entry point: (index.js)
test command:
git repository:
keywords:
author:
license: (ISC)

要注意的是name字段，有几个点要提醒：

这个是唯一的，不能和npm上所有已有的包重名，否则在publish的时候回会提示权限错误

npm ERR! You do not have permission to publish "my-test-project". 
Are you logged in as the correct user? : my-test-project

另外命名也有规范，不能出现下划线、大写字母、空格等字符，可以有连字符（中划线）。
先创建index.js文件，作为测试，在里面写几行简单代码，并export一个默认变量。

创建完package.json文件之后，我们就可以在index.js文件里写代码了。

2、调试

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

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

3、发布

3.1 创建/登录账号

如果没有npm账号，可在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 表示小的bug修复

npm version minor
// v1.1.0 表示新增一些小功能
npm version major
// v2.0.0 表示大的版本或大升级

npm version preminor
// v1.1.0-0 后面多了个0，表示预发布

npm version prepatch
// v1.0.2-0 表示预发布布丁版本

npm version的完整命令如下：

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

其语义为：

major：主版本号（大版本）
minor：次版本号（小更新）
patch：补丁号（补丁）
premajor：预备主版本
preminor: 预备次版本
prepatch：预备补丁版本
prerelease：预发布版本

如果我们要生成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并不推荐使用。

由于撤销发布会让把要撤销的包作为依赖的包不能正常工作，所以npm官方对包的撤销是有限制的：

不允许撤销发布已经超过24小时的包（unpublish is only allowed with versions published in the last 24 hours）
如果在24小时内确实要撤销，需要加--force参数
即使撤销了发布的包，再次发布的时候也不能与之前被撤销的包的名称/版本其中之一相同，因为这两者构成的唯一性已经被占用，官方并没有随着撤销而删除。

♢ npm unpublish

撤销发布的命令为 npm unpublish

npm unpublish my-test-project
// 报错
npm ERR! Refusing to delete entire project.
npm ERR! Run with --force to do this.
npm ERR! npm unpublish [<@scope>/]<pkg>[@<version>]

// 加 --force参数重新撤销发布
npm unpublish my-test-project --force
npm WARN using --force I sure hope you know what you are doing.
- my-test-project

♢ npm deprecate

npm unpublish的推荐替代命令：

npm deprecate <pkg>[@<version>] <message>

这个命令，并不会在npm上里撤销已有的包，但会在任何人尝试安装这个包的时候得到deprecated的警告，例如：

npm deprecate my-test-project 'this package is no longer maintained'

4. 最佳实践

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

5. 场景讲解

每次发布操作流程
移除tag

5.1 每次发布流程

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

5.2 移除tag

npm dist-tag rm <pkg> <tag>