注意:你只能发布非作用域包到npm公共注册表。你不能发布非作用域包到npm企业注册表。
作为一个npm使用者,你可以创建在自己项目中使用的非作用域包,并将它们发布在npm公共注册表中,以便其他人在他们的项目中使用。非作用域包总是公共的,并且仅由包名引用:
package-name
有关包范围、访问、可见性的更多信息,请参阅"Package scope, access level, and visibility"。
注意:在发布公共、非作用域包之前,必须注册npm用户账户。
创建非作用域公共包
- 在命令行,为你的包创建目录:
mkdir my-test-package
- 导航到包的根目录:
cd my-test-package
- 如果你正在用git来管理你的包代码,在包的根目录,运行以下命令,用包的git远程地址代替git-remote-url:
git init
git remote add origin git://git-remote-url
- 在包的根目录,运行
npm init
命令。 - 响应提示来生成package.json文件。帮助命名你的包,参见"Package name guidelines"。
- 创建README文件解释你包中的代码是什么以及如何使用。
- 在您首选的文本编辑器中,为你的包编写代码。
检查包内容是否有敏感或不必要信息
发布敏感信息到注册表可能伤害你的用户,损害您的开发基础架构,付出昂贵的代价去修复,让你面临法律诉讼的风险。我们强烈建议在发包之前移除敏感信息,例如私钥,密码,个人身份信息(PII),以及信用卡数据。
不太敏感的信息,例如测试数据,使用.npmignore或者.gitignore文件去阻止发布到注册表。详细信息请参阅this article。
测试你的包
为了减少发布bug的机会,我们建议在发布到npm注册表之前测试你的包。测试你的包,使用包目录的全路径运行npm install
。
npm install my-package
发布非作用域公共包
- 在命令行,导航到包的根目录。
cd /path/to/package
- 发布你的包到npm注册表,运行:
npm publish
- 查看公共包页面,访问 npmjs.com/package/*pa… ,用你的包名称代替package-name*。公共包将会在npm网站的包名下写
public
。
有关publish
的更多信息,请参见CLI documentation。