npm 包 organisation 使用教程-JavaScript中文网-JavaScript教程资源分享门户

什么是 npm 包 organisation？

npm 包 organisation 是一种组织 npm 包的方式。通常情况下，当我们开发一个 npm 包时，都会把它放在自己的 npm registry 上，这样别人在使用时需要手动添加包名及注册表地址。而使用 npm 包 organisation，我们可以将自己的 npm 包统一放置在一个组织下，供其他人统一下载使用，方便直接。

如何创建一个 npm 包 organisation？

首先，我们需要在 npm 上创建一个组织，可以通过以下命令进行：

npm create-org <org-name>

这个命令将会创建一个以 <org-name> 命名的 npm 组织，创建完成后我们可以使用以下命令获取组织信息：

npm org ls <org-name>

接下来，我们需要将我们的包添加到这个组织中：

npm access grant read-write <user>:<org-name>

<user> 表示包的作者，<org-name> 则表示我们上一步中创建的组织名称。这条命令可以将 <user> 的这个包添加到 <org-name> 组织中，并授予读写权限。

最后，我们需要在我们的包的 package.json 文件中添加以下信息：

"publishConfig": {
  "@<org-name>:registry": "https://registry.npmjs.org/"
},
"access": "restricted",
"publish": "@<org-name>"

其中，publishConfig 指定了我们的包将要发布到哪个注册表地址，access 设置为 restricted 可以确保我们的包只能通过组织进行发布，publish 则是指定发布时使用哪个 scope。

如何使用一个 npm 包 organisation？

要使用一个组织中的包，我们需要先在 package.json 文件中添加以下信息：

"@<org-name>/<package-name>": "^<version>"

其中，<org-name> 是组织名称，<package-name> 则是我们要使用的包名称，<version> 则是我们要使用的包版本号。

接下来，使用以下命令安装依赖：

npm install

安装完成后，在代码中就可以使用这个包了：

const packageName = require('@<org-name>/<package-name>')

示例代码

本示例演示如何使用一个在组织 my-org 下的名为 my-package 的包。

创建组织

npm create-org my-org

将包添加到组织中

npm access grant read-write your-username:my-org

在 `package.json` 文件中添加必要信息

-- -------------------- ---- -------
-
  ---
  ---------------- -
    ------------------- -----------------------------
  --
  --------- -------------
  ---------- ----------
  ---
-

在其他项目中使用该包

在 package.json 文件中添加依赖：

{
  ...
  "@my-org/my-package": "^1.0.0",
  ...
}

然后使用以下命令安装依赖：

npm install

最后，在代码中使用该包：

const myPackage = require('@my-org/my-package')

总结

npm 包 organisation 为我们提供了一种方便管理 npm 包的方式。通过将自己的包统一放置在一个组织下，其他人只需要添加组织名称就可以方便地使用我们的包了。希望本文能给大家带来帮助。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/600671a730d0927023822669

npm 包 organisation 使用教程