Node.js Commander詳解

Node.js已經成為前端開發者和全棧工程師最常用的語言之一。在Node.js開發中，命令行工具是極其方便的。而Node.js Commander就是為了簡化命令行開發而生的。

一、安裝和使用Node.js Commander

在開始使用Node.js Commander之前，需要先安裝Node.js。

使用npm安裝Commander：

npm install commander

引入Commander：

const commander = require('commander');

以上代碼引入了Commander的命令行解析器。

在代碼中使用Commander：

// 定義命令
commander
  .command('hello ')
  .description('say hello to user')
  .action((username) => {
    console.log('Hello, ' + username);
  });

// 解析命令行參數
commander.parse(process.argv);

以上代碼定義了一個名為hello的命令，可以通過命令行參數傳入username。使用description方法添加了命令的說明文字，使用action方法定義了該命令被調用時執行的操作。最後使用commander.parse解析命令行參數。

二、常用的Commander方法

1. option方法

option方法可以用來定義命令行參數。

// 定義命令行參數
commander
  .option('-p, --port <port>', 'set server port', 3000)
  .option('-d, --debug', 'output extra debug info');

console.log(commander.port);
console.log(commander.debug);

以上代碼定義了兩個命令行參數，-p和–port用來設置服務端口號，-d和–debug則是用來輸出額外的調試信息。

2. version方法

version方法可以設置命令行工具的版本號。

// 設置命令行工具的版本號
commander
  .version('1.0.0');

console.log(commander._version); // '1.0.0'

3. usage方法

usage方法用來顯示命令行工具的基本使用說明。

// 顯示命令行工具的使用說明
commander
  .usage('Usage: mytool [options] [command]');

console.log(commander._usage); // 'Usage: mytool [options] [command]'

4. command方法

command方法用來定義命令，並且對該命令添加諸如說明文字等信息。

// 定義命令
commander
  .command('hello ')
  .description('say hello to user')
  .action((username) => {
    console.log('Hello, ' + username);
  });

console.log(commander.commands); // [ { _name: 'hello' } ]

5. action方法

action方法用來定義命令被執行時的操作。

// 定義命令並添加action操作
commander
  .command('start')
  .description('start the server')
  .action(() => {
    console.log('Server started');
  });

6. parse方法

parse方法用來解析命令行參數。

// 解析命令行參數
commander.parse(process.argv);

console.log(commander.args);
// 對於命令hello world，輸出: [ 'hello', 'world' ]
// 對於命令start，輸出: []

三、使用案例

1. 命令行工具

假設我們正在開發一個文件轉換器，在將文件轉換為不同格式時，需要通過命令行工具來執行相應功能。為了完成這個任務，可以使用Commander來創建一個命令行工具。

首先，我們需要安裝Commander。

npm install -g commander

接下來，可以在一個空目錄中創建一個command.js文件。在該文件中，使用Commander來創建一個將文件轉換為JSON格式的命令。

#!/usr/bin/env node

const commander = require('commander');
const fs = require('fs');

commander
  .version('1.0.0')
  .option('-f, --file <path>', 'path to file')
  .option('-o, --output <path>', 'path to output')
  .description('Convert file to JSON format')
  .action((options) => {
    const data = fs.readFileSync(options.file, 'utf8');
    const jsonData = JSON.stringify(data);
    fs.writeFileSync(options.output, jsonData);
  });

commander.parse(process.argv);

以上代碼定義了一個名為convert的命令，命令行參數包括-file和-output。其中-file用於讀取源文件，-output用於將文件轉換為JSON格式並保存輸出文件。

執行命令：

node command.js --file input.txt --output output.json

以上命令將會把input.txt文件轉換成JSON格式，並保存到output.json文件中。

2. 配合Express使用

在Express框架中，可以使用Commander方便的控制應用程序的行為。

假設我們有一個Express應用程序，要在啟動時動態地設置端口號和日誌級別。通過Commander，我們可以很容易地實現這個需求。

首先，需要安裝Commander。

npm install --save commander

引入Commander：

const commander = require('commander');

在Express應用程序啟動時，使用Commander定義兩個命令行參數-port和- log-level。並根據參數值來設置服務端口號和日誌級別。

// 定義命令行參數
commander
  .option('-p, --port <port>', 'set server port', 3000)
  .option('-l, --log-level <level>', 'set log level', 1);

// 解析命令行參數
commander.parse(process.argv);

// 根據命令行參數設置端口號和日誌級別
const port = commander.port || 3000;
const logLevel = commander.logLevel || 1;

// 啟動Express應用程序
const app = express();
app.listen(port, () => {
  console.log(`Server started on port ${port}, log level ${logLevel}`);
});

以上代碼啟動Express應用程序，並且根據命令行參數調整端口號和日誌級別。