创建和发布作用域内的公共包

要公开分享您的代码到用户或组织命名空间,您可以将公共用户范围或组织范围的包发布到 npm 注册表。

有关范围的更多信息,请参见 "关于范围"。

注意:在您发布用户范围的 npm 包之前,您必须注册一个 npm 用户帐户。

此外,要发布组织范围的包,您必须创建一个 npm 用户帐户,然后创建一个 npm 组织

创建作用域公共包

  1. 如果您使用 npmrc 来管理多个注册表上的帐户,请在命令行上切换到相应的配置文件

    npmrc <profile-name>
  2. 在命令行上,为您的包创建一个目录

    mkdir my-test-package
  3. 导航到包的根目录

    cd my-test-package
  4. 如果您使用 git 管理您的包代码,请在包根目录中运行以下命令,将 git-remote-url 替换为您的包的 git 远程 URL

    git init
    git remote add origin git://git-remote-url
  5. 在包根目录中,运行 npm init 命令并将范围传递给 scope 标志

    • 对于组织范围的包,请将 my-org 替换为您的组织名称

      npm init --scope=@my-org
    • 对于用户范围的包,请将 my-username 替换为您的用户名

      npm init --scope=@my-username
  6. 响应提示以生成一个package.json 文件。有关命名包的帮助,请参见 "包命名指南"。

  7. 创建一个README 文件,解释您的包代码是什么以及如何使用它。

  8. 在您喜欢的文本编辑器中,编写您的包代码。

审查包内容以查找敏感或不必要的信息

将敏感信息发布到注册表可能会损害您的用户,危及您的开发基础设施,修复成本高昂,并使您面临法律诉讼的风险。我们强烈建议在将您的包发布到注册表之前,删除敏感信息,例如私钥、密码、个人身份信息 (PII) 和信用卡数据。

对于不太敏感的信息,例如测试数据,请使用 .npmignore.gitignore 文件来防止发布到注册表。有关更多信息,请参见本文

测试您的包

为了降低发布错误的可能性,我们建议在将您的包发布到 npm 注册表之前对其进行测试。要测试您的包,请使用您的包目录的完整路径运行 npm install

npm install my-package

发布作用域公共包

默认情况下,作用域包以私有可见性发布。要以公共可见性发布作用域包,请使用 npm publish --access public

  1. 在命令行上,导航到您包的根目录。

    cd /path/to/package
  2. 要将您的作用域公共包发布到 npm 注册表,请运行

    npm publish --access public

    注意:如果您使用 GitHub Actions 发布您的包,您可以为发布的每个包生成来源信息。有关更多信息,请参见 "生成来源陈述"。

  3. 要查看您的公共包页面,请访问https://npmjs.net.cn/package/\*package-name\*, 将 *package-name* 替换为您的包的名称。公共包将在 npm 网站上包名称下方的 public 部分显示。

    Screenshot of a public npm Teams package

有关 publish 命令的更多信息,请参见CLI 文档