npm包自定义执行命令

在创建 npm 包时，你可以自定义一些执行命令让用户在安装包后能够直接调用。这些命令定义在包的 package.json 文件的 bin 字段中。自定义命令允许你为包提供一个或多个执行入口点，通常用于构建命令行工具。

这里是如何自定义执行命令的一个步骤：

1. 创建可执行的文件： 首先，你需要一个可执行的 JavaScript 文件。记得在文件的顶部添加 #!/usr/bin/env node 这行，它是一个 shebang（哈希磅），用来告诉操作系统使用 Node.js 执行环境来运行这个文件，否则他将尝试使用默认改的shell执行，而不是node.js,可能会导致语法错误。

   #!/usr/bin/env node
   // mycli.js
   console.log("Hello from my command-line tool!");
   

2. 在 package.json 中配置 bin 字段： 在你的 package.json 中，添加一个 bin 字段来指定命令名称和对应的文件路径。

   {
     "name": "my-cli-tool",
     "version": "1.0.0",
     "bin": {
       "mycli": "./bin/mycli.js"
     },
     // 其他配置项...
   }
   

   在这个例子中，命令的名称是 mycli，当包被安装后，用户可以在命令行里直接运行 mycli 来执行 ./bin/mycli.js 文件。 当你在你的项目中安装这个包时，在node_modules/.bin目录下会查看到mycli。在项目根目录下执行命令可以查看项目下的所有可执行命令。

ls node_modules/.bin

3. 设置文件权限： 确保可执行文件具有执行权限。你可以通过以下命令来设置这个权限：

   chmod +x ./bin/mycli.js
   

4. 安装并测试你的命令： 本地测试你的命令可以通过将包链接到全局路径来完成。在包的根目录下运行：

   npm link
   

   这会创建一个全局的符号链接到你的包。之后，你就可以在命令行中输入 mycli 来运行你的命令了。如果命令执行成功，你会看到输出 "Hello from my command-line tool!"。

5. 发布到 npm： 一切就绪之后，你可以使用 npm publish 命令来发布你的包到 npm。当其他用户通过 npm install -g my-cli-tool 全局安装你的包时，mycli 命令会通过创建软连接的方式自动添加到他们的 PATH 环境变量中，使得该命令在任何位置都可以被调用。本地项目安装npm install my-cli-tool,mycli命令会被添加到node_modules/.bin目录中。 npm package.json中的bin

通过这种方式，开发者可以方便地创建和分发命令行工具，为其他用户提供便利的命令行操作。