创建和发布无范围的公共包

作为 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 用户账户。

Note: Before you can publish public unscoped npm packages, you must sign up for an npm user account.

创建无范围的公共包

Creating an unscoped public package

  1. 在命令行上,为你的包创建一个目录:

    On the command line, create a directory for your package:

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

    Navigate to the root directory of your package:

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

    If you are using git to manage your package code, in the package root directory, run the following commands, replacing git-remote-url with the git remote URL for your package:

    git init
    git remote add origin git://git-remote-url
  4. 在包根目录下,运行 npm init 命令。

    In the package root directory, run the npm init command.

  5. 根据提示生成 package.json 文件。如需命名包的帮助,请参阅“包名指南”。

    Respond to the prompts to generate a package.json file. For help naming your package, see "Package name guidelines".

  6. 创建一个 README 文件,说明你的包代码是什么以及如何使用它。

    Create a README file that explains what your package code is and how to use it.

  7. 在你首选的文本编辑器中,为你的包编写代码。

    In your preferred text editor, write the code for your package.

查看包内容是否有敏感或不必要的信息

Reviewing package contents for sensitive or unnecessary information

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

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

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

    On the command line, navigate to the root directory of your package.

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

    To publish your public package to the npm registry, run:

    npm publish

    注意:如果你使用 GitHub Actions 发布你的包,你可以为你发布的每个包生成出处信息。欲了解更多信息,请参阅“生成出处声明”。

    Note: If you use GitHub Actions to publish your packages, you can generate provenance information for each package you publish. For more information, see "Generating provenance statements."

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

    To see your public package page, visit https://npmjs.com/package/*package-name*, replacing *package-name* with the name of your package. Public packages will say public below the package name on the npm website.

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

For more information on the publish command, see the CLI documentation.

npm 中文网 - 粤ICP备13048890号