Creating and publishing unscoped public packages

注意:您只能将无作用域的软件包发布到npm公共注册表. 您无法将无作用域的程序包发布到npm Enterprise注册表.

作为npm用户,您可以创建不受范围限制的软件包以在自己的项目中使用,并将它们发布到npm公共注册表中,供其他人在其项目中使用. 无作用域的软件包始终是公共的,并且仅由软件包名称引用:

package-name

有关包范围,访问和可见性的更多信息,请参阅" 包范围,访问级别和可见性 ".

注意:必须先注册一个npm用户帐户,然后才能发布公共的无作用域npm软件包.

Overview

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

Creating an unscoped public package

注意:您只能将无作用域的软件包发布到npm公共注册表. 您无法将无作用域的程序包发布到npm Enterprise注册表.
  1. 在命令行上,为包创建目录:
      mkdir my-test-package 
  2. 导航到包的根目录:
      cd my-test-package 
  3. 如果要使用git管理软件包代码,请在软件包根目录中运行以下命令,将git-remote-url替换为软件包的git远程URL:
      git init git remote add origin git://git-remote-url 
  4. 在软件包根目录中,运行npm init命令.
  5. 响应提示以生成package.json文件. 有关命名软件包的帮助,请参阅" 软件包名称准则 ".
  6. 创建一个README文件 ,说明您的程序包代码是什么以及如何使用它.
  7. 在您喜欢的文本编辑器中,为您的程序包编写代码.

Reviewing package contents for sensitive or unnecessary information

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

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

Testing your package

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

npm install my-package

Publishing unscoped public packages

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

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


< About package README files | Creating and publishing scoped public packages >

by  ICOPY.SITE