npm文档翻译-向注册表提供包-创建发布私有包

640 阅读3分钟

要与特定的用户或团队共享你的代码,你可以发布私有的用户作用域或组织作用域的包到npm注册表。
关于作用域和私有包的更多信息,查看"About scopes"和"About private packages"。

注意:在你发布私有用户作用域npm包之前,必须注册付费的npm用户账户。
此外,发布私有组织作用域包,必须创建npm用户账户,然后创建付费的npm组织。

创建私有包

  1. 如果你正在使用npmrc管理多个注册表上的账户,在命令行,切换到相应的配置文件:
npmrc <profile-name>
  1. 在命令行,为你的包创建目录:
mkdir my-test-package
  1. 导航到包的根目录:
cd my-test-package
  1. 如果你正在使用git管理你的包代码,在包的根目录运行以下命令,用包的git远程地址代替git-remote-url:
git init
git remote add origin git://git-remote-url
  1. 在包的根目录,运行npm init命令并将作用域传递给作用域标志:
    • 对于组织作用域包,用你的组织名称代替my-org
    npm init --scope=@my-org
    
    • 对于用户作用域包,用你的用户名代替my-username
    npm init --scope=@my-username
    
  2. 响应提示去生成package.json文件。帮助命名您的包请参阅"Package name guidelines"。
  3. 创建一个README文件解释你的代码是什么及如何使用。
  4. 在你选择的文本编辑器中,为你的包编写代码。

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

发布敏感信息到注册表可能伤害你的用户,损害您的开发基础架构,付出昂贵的代价去修复,让你面临法律诉讼的风险。我们强烈建议在发包之前移除敏感信息,例如私钥,密码,个人身份信息(PII),以及信用卡数据。即使你的包是私有的,如果包被公开或者下载到一个可被更多用户访问的电脑,则敏感信息可能会暴露。
不太敏感的信息,例如测试数据,使用.npmignore或者.gitignore文件去阻止发布到注册表。详细信息请参阅this article

测试你的包

为了减少发布bug的机会,我们建议在发布到npm注册表之前测试你的包。测试你的包,使用包目录的全路径运行npm install

npm install my-package

发布私有包

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

  1. 在命令行,导航到包的根目录。
cd /path/to/package
  1. 发布你的私有包到npm注册表,运行:
npm publish
  1. 查看公共包页面,访问 npmjs.com/package/*pa… ,用你的包名称代替package-name*。公共包将会在npm网站的包名下写public
    有关publish的更多信息,请参见[CLI documentation]