Commander写自己的Nodejs命令

Commander写自己的Nodejs命令

在使用Node.js的过程中，有很多工具都支持全局安装，并且提供了一个命令行接口，使得我们在命令行中可以方便地执行一些任务，比如 express、grunt、bower、yeoman、reap、karma 和 requirejs 等。有时候，我们也需要自己开发这样的命令行工具。

commander.js 是一个强大的库，它可以帮助我们简化命令行工具的开发过程。本文将详细介绍如何使用 commander.js 来创建自己的 Node.js 命令行工具。

commander介绍

commander.js 是一个用于 Node.js 的命令行参数解析器。它基于 node-optimist，并提供了更丰富的功能，如子命令、选项解析等。通过 commander.js，我们可以轻松地创建复杂的命令行界面。

commander安装

首先，我们需要安装 commander.js：

npm install commander --save

commander的API

commander.js 提供了一些核心的 API，包括 program 对象，它用于定义命令行参数和选项。以下是一些常用的 API：

• program.version(version)：设置程序的版本号。
• program.option('-o, --option [value]', 'Option description')：定义选项。
• program.command('command-name')：定义子命令。
• program.action(fn)：当没有匹配的子命令时，执行的回调函数。
• program.parse(process.argv)：解析命令行参数。

开发自定义的命令

假设我们要创建一个名为 mycli 的命令行工具，它可以显示帮助信息、版本信息以及执行一些自定义操作。

// mycli.js
const program = require('commander');

program
  .version('1.0.0')
  .description('A custom CLI tool')
  .option('-v, --verbose', 'Enable verbose mode')
  .command('greet <name>', 'Greet a person')
  .action((cmd) => {
    console.log(`Running ${cmd}`);
  })
  .parse(process.argv);

if (program.args.length === 0) {
  program.help();
}

if (program.greet) {
  console.log(`Hello, ${program.greet}!`);
}

在这个例子中，我们定义了以下几个部分：

• 版本号：1.0.0
• 描述信息：A custom CLI tool
• 选项：-v, --verbose，用于启用详细模式
• 子命令：greet <name>，用于向某人打招呼

发布为运行命令

为了使 mycli 成为一个全局可执行的命令，我们需要将其打包为一个 npm 包，并在 package.json 中添加 bin 字段：

{
  "name": "mycli",
  "version": "1.0.0",
  "description": "A custom CLI tool",
  "main": "index.js",
  "bin": {
    "mycli": "./mycli.js"
  },
  "scripts": {
    "start": "node mycli.js"
  },
  "dependencies": {
    "commander": "^7.2.0"
  }
}

然后，我们可以通过以下命令来安装和使用该工具：

npm install -g .

现在，你可以在命令行中直接使用 mycli 命令了：

mycli greet John

这将在命令行中输出 Hello, John!。

通过以上步骤，你就可以使用 commander.js 创建自己的命令行工具了。