npm 发布和更新包
你可以发布任何包含package.json
文件的目录。本章介绍了如何首次发布包,以及如何在以后更新包。
如何发布包
了解 npm 政策
在开始之前,最好查看 npm 的政策,以防你对站点礼仪、命名、许可或其他准则有疑问。
创建用户帐户
想要发布包,你必须是 npm 注册表的用户。如果你不是用户,请使用 npm adduser
。 如果你在网站上创建了一个用户帐户,请使用npm login
从你的终端访问你的帐户。
测试:
- 从终端输入
npm whoami
,查看你是否已经登录(从技术上讲,这也意味着你的证书已经存储在本地)。 - 检查你的用户名是否已添加到 https://npmjs.com/~username 的注册表中.
例如
https://www.npmjs.com/~carolynawombat
查看包目录
查看内容
请注意,除非本地的.gitignore
或.npmignore
文件忽略目录中的所有内容,否则将包含该目录中的所有内容。要了解如何使用这些命令,请参阅NPM 开发者指南。
查看 package.json 文件
阅读NPM package.json 文件以确保你想要的详细信息反映在你的包中。
选择一个名字 为你的包选择一个唯一的名称,尝试选择一个具有描述性的名称:
- 尚未被他人使用
- 拼写不像另一个名字,除了拼写错误
- 不会混淆其他作者的身份
- 符合 npm 政策指南。例如,不要将你的包命名为具有冒犯性的名称,也不要使用其他人的商标名称。
- 在 package.json 文件的相应行中指定名称。
注意:如果你使用scopes ,则前 3 个警告不适用。
包含文档 (readme.md)
npm 建议你包含一个自述文件来记录你的包。自述文件必须具有 readme.md
文件。文件扩展名.md
表示该文件是一个Markdown文件。当有人找到你的包时,这个文件会出现在 npm 网站上。
在开始之前,请查看一些包页面以获取有关可以添加到自述文件中的信息的想法,并了解为什么这如此重要。
- 使用任何文本编辑器创建文件。
- 将其保存在项目目录中,名称为readme.md
- 当发布时,此文档将显示在人们下载你的软件包的网页上。
发布!
使用npm publish
发布包。
测试
去https://npmjs.com/package/<package>
。你应该会看到一个关于你的新包的页面。它可能看起来有点像这样:
更新包
如何更新版本号
当你进行更改时,你可以使用更新包
npm version <update_type>
其中 <update_type> 是语义版本控制版本类型之一,补丁、次要或主要。
此命令将更改package.json
.
注意: 如果你已将一个标签链接到你的 npm 帐户,这还将在你的 git 存储库中添加一个带有更新版本号的标签。
更新版本号后,npm publish
再次运行。
测试:去https://npmjs.com/package/<package>
。应该更新包的编号。
如何更新自述文件
除非发布包的新版本,否则站点上显示的 README 不会更新,因此你需要运行npm version patch
并npm publish
更新站点上显示的文档。
更多建议: