目录
创建和发布非作用域公共包
目录
作为 npm 用户,您可以创建无范围的包以在您自己的项目中使用,并将它们发布到 npm 公共注册表供其他人在其项目中使用。无范围的包始终是公开的,并且仅通过包名称引用。
包名
有关包范围、访问级别和可见性的更多信息,请参见 "包范围、访问级别和可见性"。
注意:在您发布公共无范围的 npm 包之前,您必须 注册 npm 用户帐户。
创建无范围的公共包
-
在命令行中,为您的包创建一个目录
mkdir my-test-package
-
导航到您的包的根目录
cd my-test-package
-
如果您使用 git 来管理您的包代码,在包的根目录中,运行以下命令,将
git-remote-url
替换为您包的 git 远程 URLgit initgit remote add origin git://git-remote-url -
在包的根目录中,运行
npm init
命令。 -
响应提示以生成
package.json
文件。有关命名包的帮助,请参见 "包名称指南"。 -
创建一个 README 文件,解释您的包代码是什么以及如何使用它。
-
在您喜欢的文本编辑器中,编写您的包的代码。
审查包内容以获取敏感或不必要的信息
将敏感信息发布到注册表可能会损害您的用户、危害您的开发基础设施、修复成本高昂,并使您面临法律诉讼的风险。我们强烈建议在将您的包发布到注册表之前删除敏感信息,例如私钥、密码、个人身份信息 (PII) 和信用卡数据。
对于不太敏感的信息,例如测试数据,请使用 .npmignore
或 .gitignore
文件来防止发布到注册表。有关更多信息,请参见 这篇文章.
测试您的包
为了降低发布错误的可能性,我们建议在将您的包发布到 npm 注册表之前对其进行测试。要测试您的包,请使用您的包目录的完整路径运行 npm install
npm install path/to/my-package
发布无范围的公共包
-
在命令行中,导航到您的包的根目录。
cd /path/to/package
-
要将您的公共包发布到 npm 注册表,请运行
npm publish
注意:如果您使用 GitHub Actions 来发布您的包,则可以为发布的每个包生成来源信息。有关更多信息,请参见 "生成来源声明"。
-
要查看您的公共包页面,请访问
https://npmjs.net.cn/package/*package-name*
,将*package-name*
替换为您的包的名称。公共包在 npm 网站上包名称下方的public
字样中显示。
有关 publish
命令的更多信息,请参见 CLI 文档.