如何在 2020 年发布 NPM 软件包

介绍

一步一步

结论

介绍

本质上，发布 npm 包只是一个命令，但在执行此操作之前，您必须注意一些事项。

一步一步

这是我在发布第一个包之前遵循的步骤：

1. 在https://www.npmjs.com/上创建一个免费帐户。
2. 通过运行登录 npm CLI npm login。
3. 为您的新包创建一个通常具有相同名称的文件夹。
4. 确保您运行npm init并在文件中填写了所有正确的值package.json。
5. 仔细选择名称，因为这将是每个人安装您的软件包时使用的名称。
6. 使用语义版本控制格式设置版本号。它应该类似于：“v1.2.3”。第一个数字是主版本号，每次部署重大变更时都会递增。第二个数字是次版本号，每次新增非重大功能时都会递增。最后，我们设置补丁/修复版本号。同时，在 GitHub（或其他版本控制系统）中创建一个与版本号匹配的新版本。（阅读更多）
7. 添加一个types指向类型定义文件的字段。您并非必须执行此步骤，但随着 TypeScript 和更强大的 IDE 的快速发展，这无疑为开发人员带来了巨大的便利。类型文件将是一个用 TypeScript 编写的 *.ts 文件，用于描述包的类型、接口等。（阅读更多）
8. 填写字段，指定代码托管位置repository。（阅读更多）
9. 仔细考虑一下您希望如何为您的软件包授予许可证，并设置正确的license值。如果您不确定，请访问此网站https://choosealicense.com/，这将非常方便您完成此操作。
10. 检查您的.gitignore文件并确认您的存储库中没有包含任何个人或不必要的文件。
11. 添加一个.npmignore文件，用于从 npm 包中排除特定文件。我个人在这里添加了测试文件，因为我们不需要将它们包含在包中。
12. 不妨花点时间写一个简洁的README.md文件，向未来的用户解释如何安装、如何使用这个软件包，或许还可以提供一些示例。该文件的内容也会发布在这个网站上。
13. 现在你几乎可以发布了，但在发布之前，请运行npm pack，它将生成一个*.tgz文件，其中包含所有文件，它们最终会以你 npm 包中的形式出现。这将让你再次检查所有设置是否正确，以及你准备发布的内容是否正确。
14. 在发布之前，你需要在本地进行一个快速测试。创建一个新文件夹，初始化 npm ( npm init)，然后使用 来安装你的包npm install -S ./path/to/your/package。这将从你的本地目录安装包，你可以尝试使用它，就像它已经发布过一样。
15. 假设您已完成上述所有步骤并且一切按预期进行，那么您现在可以使用 发布您的包npm publish。

结论

恭喜，您现在拥有一个全新的 npm 包。

您可以在 npm 上看到您的包，如下所示：https://www.npmjs.com/package/inline-webassembly