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

什么是 npm-bin

npm-bin 可以让你将本地的二进制文件引用为 npm 包的命令，同时支持使用 $PATH 环境变量，方便了使用本地 CLI 工具。

安装 npm-bin

在使用 npm-bin 之前，需要先安装 npm-install-missing，该包的作用是避免出现缺失 npm 包的情况。在全局安装 npm-install-missing：

npm install --global npm-install-missing

创建 npm-bin 包

创建一个新目录并初始化 npm 包。在终端中，输入以下命令：
```
mkdir my-cli
cd my-cli
npm init
```
安装需要用到的 CLI 依赖包。例如，需要使用 yargs 和 shelljs，就可以输入以下命令：
```
npm install yargs shelljs --save-dev
```

创建一个脚本文件 index.js，并添加以下代码到该文件：

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

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

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

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

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

在 package.json 文件中，添加配置来指定该包的可执行文件。在 scripts 对象中添加以下内容：
```
"bin": {
  "my-cli": "./index.js"
}
```
运行 npm link，将该包链接到系统范围的 npm 包目录下。运行以下命令：
```
npm link
```

使用 npm-bin 包

现在，你已经成功创建了一个 CLI 工具。你可以输入 ./index.js --name yourname 来使用该工具，但是这样很不方便。为了方便使用，你可以添加可执行文件到 $PATH 环境变量，从而将该工具作为全局命令使用。

在已有的 npm 包中安装 npm-bin：
```
npm install npm-bin --save-dev
```
在 package.json 文件的 scripts 对象中，添加以下内容：
```
"npm-bin": "npm-bin"
```
运行 npm run npm-bin，查看该工具的可执行文件的真实路径。
```
/usr/local/bin/my-cli
```
将该路径添加到 $PATH 环境变量中，在 ~/.bashrc 文件或 ~/.zshrc 中添加以下内容：
```
export PATH=$PATH:/usr/local/bin/
```
运行以下命令，更新 $PATH 环境变量：
```
source ~/.bashrc
```

现在，你可以在命令行中输入 my-cli --name yourname 来使用该工具了。

总结

本文详细介绍了使用 npm-bin 创建本地 CLI 工具的方法，并且提供了使用方法。npm-bin 使得 CLI 工具的使用更为方便，同时也可以避免缺失 npm 包的情况。通过本文的学习，你可以更为深入地了解 npm-bin 的使用方法，也可以更好地拓展自己的技能栈。

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