作为 npm 用户,你可以创建非作用域的包,用于你自己的项目,并将它们发布到 npm 公共注册表,以便其他人可以在他们的项目中使用。非作用域的包总是公开的,并仅通过包名称来引用:
🌐 As an npm user, you can create unscoped packages to use in your own projects and publish them to the npm public registry for others to use in theirs. Unscoped packages are always public and are referred to by the package name only:
package-name
有关包的范围、访问权限和可见性的更多信息,请参见“包作用域、访问级别和可见性”。
🌐 For more information on package scope, access, and visibility, see "Package scope, access level, and visibility".
注意: 在你可以发布公开的非作用域 npm 包之前,你必须先注册一个 npm 用户账户。
🌐 Creating an unscoped public package
在命令行上,为你的包创建一个目录:
mkdir my-test-package
导航到包的根目录:
cd my-test-package
如果你使用 git 来管理你的包代码,在包的根目录下运行以下命令,并将 git-remote-url 替换为你的包的 git 远程 URL:
git initgit remote add origin git://git-remote-url
在包的根目录中,运行 npm init 命令。
根据提示生成package.json文件。有关包命名的帮助,请参见"包名指南"。
创建一个 自述文件 来解释你的软件包代码是什么以及如何使用它。
在你首选的文本编辑器中,为你的包编写代码。
🌐 Reviewing package contents for sensitive or unnecessary information
将敏感信息发布到注册表可能会对你的用户造成伤害,危及你的开发基础设施,修复成本高昂,并使你面临法律诉讼风险。我们强烈建议在将软件包发布到注册表之前,移除敏感信息,例如私钥、密码、个人可识别信息(个人身份信息)和信用卡数据。
🌐 Publishing sensitive information to the registry can harm your users, compromise your development infrastructure, be expensive to fix, and put you at risk of legal action. We strongly recommend removing sensitive information, such as private keys, passwords, personally identifiable information (PII), and credit card data before publishing your package to the registry.
对于不太敏感的信息,例如测试数据,请使用 .npmignore 或 .gitignore 文件以防止发布到注册表。更多信息,请参见 这篇文章。
🌐 For less sensitive information, such as testing data, use a .npmignore or .gitignore file to prevent publishing to the registry. For more information, see this article.
🌐 Testing your package
为了减少发布错误的可能性,我们建议在将包发布到 npm 注册表之前先测试你的包。要测试你的包,请使用包含包目录完整路径的命令 npm install:
🌐 To reduce the chances of publishing bugs, we recommend testing your package before publishing it to the npm registry. To test your package, run npm install with the full path to your package directory:
npm install path/to/my-package
🌐 Publishing unscoped public packages
重要: 发布到 npm 需要以下条件之一:
欲了解更多信息,请参阅 npm 关于发布包时要求两步验证的文档。
🌐 For more information, see the npm documentation on requiring 2FA for package publishing.
在命令行上,导航到包的根目录。
cd /path/to/package
要将你的公共包发布到 npm 注册表,请运行:
npm publish
要查看你的公共包页面,请访问 https://npmjs.com/package/*package-name*,并将 *package-name* 替换为你的包名称。公共包在 npm 网站上包名称下方会显示 public。
有关 publish 命令的更多信息,请参阅 命令行接口文档。
🌐 For more information on the publish command, see the CLI documentation.