npm 发布和更新包
如何发布和更新程序包
您可以发布任何包含package.json
文件的目录。
本章说明如何首次发布程序包,以及以后如何更新程序包。
如何发布程序包
做包
这个参考 如何创建npm包
了解npm发包的规则
在开始之前,最好先查看npm的政策,以防对网站规则,命名,许可或其他准则有疑问。
创建一个用户帐号
要发布,您必须是npm注册表上的用户。
如果您不是用户,请使用创建帐户 npm adduser
。
如果您在网站上创建了用户帐户,请使用npm login
从终端访问您的帐户。
测试
npm whoami
在终端上键入以查看您是否已经登录(从技术上讲,这也意味着您的凭据已存储在本地)。- 检查您的用户名是否已添加到
https://npmjs.com/~username
的注册表中.
例如
https://www.npmjs.com/~zhubangbang
当然也可以是一个组织
https://www.npmjs.com/org/axihe
查看软件包目录
查看内容
请注意,目录中的所有内容都将包括在内,
除非被本地.gitignore
或.npmignore
文件忽略。
要了解如何使用这些命令,请参阅npm-developers。
查看package.json文件
阅读“使用package.json工作”,以确保所需的详细信息反映在包中。
选择一个名字
为您的包裹选择一个唯一的名称。尝试选择以下描述性名称:
- 还不是别人所有的
- 除了拼写错误外,拼写不像其他名字
- 不会混淆他人的著作权
- 符合npm政策准则。
- https://www.npmjs.com/policies
- 例如,不要给您的包裹起冒犯性的名字,也不要使用别人的商标名称。
- 在package.json文件的相应行中指定名称。
注意:如果使用 scopes ,则前三个警告不适用。
https://docs.npmjs.com/cli/version
包含readme.md文档
npm建议您包含一个自述文件(readme.md)来记录您的软件包。
自述文件必须具有文件名readme.md。
当有人找到您的软件包时,该文件将出现在npm网站上。
在开始之前,最好先把别人的项目拉下来看看,先看看别人是怎么写的,然后再发包;
- 使用任何文本编辑器创建文件。
- 将其保存在项目目录中,名称为
readme.md
- 发布时,此文档将显示在人们下载您的软件包的网页上。
发布!
使用 npm publish 发布包。
测试
转到https://npmjs.com/package/<package>
。
您应该会看到有关新软件包的全部页面。它可能看起来像这样:
https://www.npmjs.com/package/json-rpc-cli
恭喜你!
如何更新包
如何更新版本号
进行更改时,您可以使用
npm version <update_type>
其中,<update_type>
是语义版本控制发布类型,补丁,次要或主要版本之一。
此命令将更改中的版本号package.json。
注意:如果您已经将一个带有更新发行版号的标签添加到您的git存储库中,则将其链接到您的npm帐户。
你也可以直接修改package.json
里面的 version
更新版本号后,npm publish
再次运行。
测试
转到https://npmjs.com/package/<package>
。
包裹号应更新。
如何更新自述文件
除非发布了软件包的新版本,否则不会更新网站上显示的自述文件,
因此您需要运行npm version patch
并npm publish
更新网站上显示的文档。
更多
-
要了解有关节点模块和软件包的更多信息,
-
要了解语义版本控制
-
要了解有关标签的更多信息
-
要了解有关package.json文件的更多信息
-
要了解有关命名的更多信息