如何发布和更新包
如何发布和更新包
您可以发布包含package.json
文件的任何目录。本章介绍如何首次发布程序包以及如何在以后更新程序包。
如何发布包
制备
了解npm政策
在开始之前,如果您对网站礼仪,命名,许可或其他指南有疑问,最好查看npm的政策。
创建用户帐户
要发布,您必须是npm注册表中的用户。如果您不是用户,请使用创建帐户 npm adduser
。如果您在网站上创建了用户帐户,请使用npm login
从终端访问您的帐户。
测试:
- 键入
npm whoami
从终端看,如果你已经登录(从技术上讲,这也意味着你的证书已经存储在本地)。
例如,
https://www.npmjs.com/~carolynawombat
查看包目录
查看内容
请注意,除非本地.gitignore
或.npmignore
文件忽略该目录,否则将包含目录中的所有内容。要了解如何使用这些命令,请参阅npm-developers
。
查看package.json文件
阅读使用package.json
以确保所需的详细信息反映在您的包中。
选择一个名字
为您的包选择一个唯一的名称。尝试选择一个描述性名称:
- 还没有其他人拥有
注意:如果您使用范围,则前3个警告不适用。
包含文档(readme.md)
npm建议您包含一个自述文件来记录您的包。自述文件必须具有文件名readme.md
。文件扩展名.md
表示该文件是markdown文件。当有人找到您的包裹时,此文件将显示在npm网站上。
在开始之前,请查看一些软件包页面,以获取可以添加到自述文件中的信息的想法,并了解为什么这么重要。
- 使用任何文本编辑器创建文件。
发布!
使用npm publish
发布包。
测试
去吧https://npmjs.com/package/<package>。你应该看到一个关于你的新包的页面。它可能看起来像这样:
恭喜!
如何更新包
如何更新版本号
进行更改时,可以使用更新包
npm version <update_type>
其中<update_type>是语义版本控制版本之一,补丁,次要或主要版本。
此命令将更改版本号package.json
。
注意:如果您已将一个标签与您的npm帐户相关联,那么这也会将更新后的版本号添加到您的git存储库中。
更新版本号后,npm publish
再次运行。
测试:转到https://npmjs.com/package/<package>。包裹号码应该更新。
如何更新自述文件
除非发布新版本的软件包,否则不会更新网站上显示的自述文件,因此您需要运行npm version patch
并npm publish
更新网站上显示的文档。