如何发布一个新的 NPM 包及其后续更新

在 JavaScript 的世界里，npm 是最流行的包管理器之一，它允许开发者分享和使用其他开发者编写的代码。如果你有一个很棒的项目想要分享给全世界，那么发布一个 npm 包是一个不错的选择。本文将指导你如何发布一个新的 npm 包以及如何更新这个包。

1 发布新的 NPM 包

1.1 准备工作

在开始之前，你需要确保已经安装了 Node.js 和 npm。Node.js 的安装会自动包含 npm，所以你不需要单独安装 npm。你可以通过在命令行中运行以下命令来检查它们是否已经安装：

node -v
npm -v

如果这些命令返回了版本号，那么你就准备好了。如果没有，请前往 Node.js官网 下载并安装。

1.2 创建 NPM 账号

在发布包之前，你需要一个 npm 账号。如果你还没有账号，可以通过 npm官网 注册，或者通过命令行注册：

npm adduser

按照提示填写用户名、密码和邮箱即可。

1.3 初始化项目

如果你的项目还没有初始化，请在项目根目录下运行：

npm init

这个命令会引导你填写一些基本信息，比如项目名称、版本、描述等，最终会生成一个 package.json 文件。请确保项目名称是唯一的，否则在发布时会遇到名称冲突。（可以在 npm 官网查询是否有你的项目名称，如果没有就可以用）

1.4 创建 .npmignore 文件（可选）

创建 .npmignore 文件来指定在发布包时应该忽略的文件和目录。这可以帮助你减小包的大小，避免不必要的文件被上传。

1.5 编写和测试代码

在发布之前，请确保你的代码已经编写完成，并且通过了所有的测试。良好的单元测试可以大大提高你的包的质量。可以使用 npm link 来进行本地测试。

npm link

1.6 登录到 NPM

如果你尚未登录，使用 npm login 命令登录到你的 npm 账户。

npm login

1.7 发布包

当一切准备就绪后，你可以通过以下命令来发布你的包：

npm publish

如果你的包是公开的，那么这个命令就足够了。如果你想发布一个私有包，请使用：

npm publish --access=restricted

1.8 验证发布

发布后，到 npm 网站上检查你的包，确保新版本被正确发布。

2 更新 NPM 包

2.1 拉取最新代码

在开始之前，确保你的本地项目是最新的。如果你与他人协作，在进行任何更改之前，先从远程仓库拉取最新的代码。

2.2 应用更改

在你的本地代码库中进行必要的更改。这可能包括添加新特性、修复 bug 或更新文档等。确保你的更改清晰、高效，并且不会引入新的问题。

2.3 更新版本号

根据所做更改的性质，更新 package.json 文件中的版本号。遵循语义化版本控制（SemVer）原则：

• 主版本（major）：不兼容的 API 修改；
• 次版本（minor）：向下兼容的新功能；
• 修订号（patch）：向下兼容的问题修正。

使用 npm 的 version 命令自动更新版本号并为新版本创建一个 Git 标签：

npm version patch # 更新修订号
npm version minor # 更新次版本
npm version major # 更新主版本

2.4 运行测试

在发布之前，确保通过所有单元测试和集成测试。这一步至关重要，因为它可以帮助你确保你的更改不会引入任何新的 bug。

2.5 登录到 NPM

如果你尚未登录，使用 npm login 命令登录到你的 npm 账户。

npm login

2.6 发布新版本

使用 npm publish 命令将更新后的包发布到 npm

npm publish

2.7 更新文档

如果你的包有外部文档，确保更新文档以反映新版本的变更。

---

发布和更新 npm 包是一个相对简单的过程，但是确保你的包质量是非常重要的。良好的文档、充分的测试以及遵循语义化版本规范都是必不可少的。希望这篇文章能帮助你成功发布和更新你的 npm 包。