Creating and publishing private packages

要与一组有限的用户或团队共享代码,您可以将私有的用户范围或组织范围的包发布到npm注册表.

有关范围和私有软件包的更多信息,请参阅" 关于范围 "和" 关于私有软件包 ".

注意:在发布私有的用户范围npm软件包之前,您必须注册一个付费npm用户帐户. 另外,要发布私有的组织范围的软件包,您必须创建一个npm用户帐户 ,然后创建一个付费的npm Org .

Overview

  1. Create your package
  2. Review package contents for sensitive or unnecessary information
  3. Test your package
  4. Publish your package

Creating a private package

  1. 如果要使用npmrc来管理多个注册表上的帐户 ,请在命令行上切换到适当的配置文件:
      npmrc <profile-name> 
  2. 在命令行上,为包创建目录:
      mkdir my-test-package 
  3. Navigate to the root directory of your package:
     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替换为您的组织名称:
    • 对于用户范围的软件包,将my-username替换为您的用户名:
  6. 响应提示以生成package.json文件. 有关命名软件包的帮助,请参阅" 软件包名称准则 ".
  7. 创建一个README文件 ,说明您的程序包代码是什么以及如何使用它.
  8. 在您喜欢的文本编辑器中,为您的程序包编写代码.

Reviewing package contents for sensitive or unnecessary information

将敏感信息发布到注册表可能会损害用户,损害开发基础结构,修复成本高昂,并使您面临法律诉讼的风险. 我们强烈建议您在将程序包发布到注册表之前,删除敏感信息,例如私钥,密码,[个人身份信息] pi(PII)和信用卡数据. 即使您的软件包是私有的,但如果将该软件包公开或下载到可供更多用户访问的计算机上,则可能会暴露敏感信息.

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

Testing your package

为了减少发布错误的机会,建议您在将程序包发布到npm注册表之前对其进行测试. 要测试您的软件包, npm install使用软件包目录的完整路径运行npm install

npm install my-package

Publishing private packages

默认情况下,有作用域的程序包以私有可见性发布.

  1. 在命令行上,导航到包的根目录.
     cd /path/to/package 
  2. 要将私有软件包发布到npm注册表,请运行:
     npm publish 
  3. 要查看您的私人包页,请访问https://npmjs.com/package/ 包名 ,用你的包的名称替换包名 . 私有软件包将在npm网站上的软件包名称下方表示private .

private package page showing private below package name

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


< Creating and publishing scoped public packages | Package name guidelines >

by  ICOPY.SITE