手把手教你如何使用nodejs编写cli命令行

关于“手把手教你如何使用Node.js编写CLI命令行”的攻略，我会详细讲解以下步骤：

步骤一：创建一个node项目

首先，我们需要在本地环境上创建一个 Node.js 项目，以便于后续的操作：

mkdir my-cli
cd my-cli
npm init -y

执行完上述命令后，会在当前目录下创建一个名为 my-cli 的文件夹，并在该目录下生成一个 package.json 文件。

步骤二：安装依赖项

Node.js 提供了一个名为 commander 的常用库，可以用来快速创建命令行接口。我们需要通过 npm 安装该库依赖：

npm install commander

步骤三：创建代码

接下来，我们在 my-cli 目录下创建一个名为 index.js 的文件，并添加以下代码：

#!/usr/bin/env node

const { Command } = require('commander');
const program = new Command();

program
  .version('0.0.1')
  .description('A simple CLI for greeting')
  .option('-t, --title <title>', 'Specify the title')
  .requiredOption('-n, --name <name>', 'Specify your name')
  .option('-u, --uppercase', 'Uppercase the message')
  .action((options) => {
    let message = `Hello, ${options.title ? options.title + ' ' : ''}${options.name}!`;
    message = options.uppercase ? message.toUpperCase() : message;
    console.log(message);
  });

program.parse(process.argv);

这段代码定义了一个 program 命令行对象，该对象使用 commander 库提供的功能，添加了一个 -t, --title <title> 选项，指定标题；一个 -n, --name <name> 必选选项，指定输出信息的接收者姓名；以及一个 -u, --uppercase 选项，用来控制是否将输出信息转换成大写。

在 action() 方法中，我们定义了创建输出信息字符串的逻辑，并打印出来。程序通过调用 program.parse(process.argv) 方法解析命令行参数并执行相关逻辑。

步骤四：构建npm包

接下来，我们需要将这个脚本命令打包为一个可执行的 npm 包。

1. 在该项目的根目录下创建一个 bin 目录，然后在该目录下创建一个名为 mycli 的可执行文件，并且在可执行文件中编写以下代码：

javascript
#!/usr/bin/env node
require('../index.js');

1. 修改 package.json 中的 main 属性和 bin 属性：

json
{
"name": "my-cli",
"version": "0.0.1",
"main": "index.js",
"bin": {
"mycli": "bin/mycli"
},
"dependencies": {
"commander": "^8.3.0"
}
}

这里的 bin 属性定义了可执行文件的名称。

1. 使用 npm 执行 npm install -g 命令，将该包发布到 npm 上，即可通过命令行执行该脚本命令了。

现在，执行 mycli --name Jane --title Ms -u 命令，可以在终端输出 HELLO, Ms Jane! 。

另外，下面是两个示例说明：

示例一：创建一个生成密码的命令

#!/usr/bin/env node

const { Command } = require('commander');
const CryptoJS = require('crypto-js');

program
  .version('0.0.1')
  .description('A simple CLI for generating password')
  .requiredOption('-l, --length <length>', 'Specify password length', 16)
  .option('-s, --symbols', 'Include symbols')
  .option('-n, --numbers', 'Include numbers')
  .action((options) => {
    let chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
    let additionalChars = '';
    if (options.symbols) {
      additionalChars += '!@#$%^&*()_-+={}[]|:;"<>,.?/~';
    }
    if (options.numbers) {
      additionalChars += '0123456789';
    }
    chars += additionalChars;

    let password = '';
    for(let i=0; i<options.length; i++) {
      let randomPos = Math.floor(Math.random() * chars.length);
      password += chars[randomPos];
    }
    console.log(password);
  });

program.parse(process.argv);

在该代码中通过 CryptoJS 库生成随机密码，通过命令行调用时，可以通过 --length 指定密码长度，通过 --symbols 控制是否包含符号，通过 --numbers 控制是否包含数字。

示例二：创建一个简单的模板生成命令

#!/usr/bin/env node

const { Command } = require('commander');
const fs = require('fs');

program
  .version('0.0.1')
  .description('A simple CLI for generating template files')
  .requiredOption('-t, --template <template>', 'Specify the template')
  .requiredOption('-o, --output <output>', 'Specify the output directory')
  .option('-n, --name <name>', 'Specify the name')
  .action((options) => {
    let templateFilePath = `./templates/${options.template}.html`;
    let templateFile = fs.readFileSync(templateFilePath);
    let outputFilePath = `${options.output}/${options.name || options.template}.html`;
    fs.writeFileSync(outputFilePath, templateFile);
    console.log('File generated!');
  });

program.parse(process.argv);

在该代码中通过 fs 库读取模板文件，并将其写入到指定的输出目录。通过 --template 指定要生成的模板，通过 --output 指定要输出到的目录，通过 --name 指定生成文件的文件名，不指定时默认为模板名称。

以上两个示例只是演示了一些常用的 CLI 需求，当然你可以根据自己的实际需要和领域业务场景，结合 Node.js 的特性，构建出更强大的 CLI 工具。