node.js 命令行的命令注册和配置工具（最新版） commander.js 实用教程（含自研脚手架的创建流程）

npm init -y

#!/usr/bin/env node
console.log("成功运行 mycli");

"bin": {
    "mycli": "./index.js"
  },

npm link

mycli

cnpm install commander

import { Command } from "commander";
// 实例化一个 commander
const program = new Command();

"type": "module",

// 给实例 program 注册并配置命令
program
  .command("init") // 注册命令，参数 init 为自定义的命令名称
  .description("初始化") // 描述命令的描述,在帮助信息中会展示
  // 命令的具体行为（执行的代码）
  .action((params, options, cmd) => {
    console.log("---- 开始对 mycli 进行初始化 ----");

    // 自定义初始化需执行的代码，此范例为打印当前目录
    console.log("当前目录为：" + process.cwd());

    console.log("---- 完成了 mycli 的初始化 ----");
  });

// 解析 commander
program.parse();

mycli init

program
  .command("split") // 注册命令
  .alias("sp") // 命令的别名
  .description("将字符串分割成数组") // 对命令功能的描述
  .option("-s, --separator <char>", "分割符", ",") // 命令的配置信息,最后的 ","为默认值
  .argument("<string>", "被分割的字符串") // 命令的参数
  .action((params, options, cmd) => {
    // action中函数的第一个参数为命令的参数,此范例中params是一个字符串
    console.log(params);
    // action中函数的第二个参数为命令的配置信息
    // 此范例中 options 是一个对象，有一个属性 separator, 属性值为分割符
    console.log(options);
    // action中函数的第三个参数为命令对象自己
    // console.log(cmd);

    // 命令的功能代码为分割字符串，打印最终分割成的数组
    console.log(params.split(options.separator));
  });

// 解析 commander
program.parse();

mycli split --separator=/ a/b/c

mycli split --separator / a/b/c

mycli sp --separator=/ a/b/c

mycli sp -s/ a/b/c

mycli sp -s / a/b/c

mycli sp 'a,b,c'

argument(参数字段和类型定义,参数描述，参数默认值)

program.arguments('<username> <password>');
 

program
  .command("login")
  .description("登录")
  .argument("<username>", "用户名") // 必要参数
  .argument("[password]", "密码", "123456") // 可选参数（“123456”为默认值）
  .argument("[permissions...]", "权限") // 可变参数
  .action((username, password, permissions) => {
    console.log("username:", username);
    console.log("password:", password);
    permissions.forEach((item) => {
      console.log("权限 %s", item);
    });
  });

program
  .command("init", { isDefault: true }) // 注册默认命令
  .description("初始化") // 描述命令的描述,在帮助信息中会展示
  // 命令的具体行为（执行的代码）
  .action((params, options, cmd) => {
    console.log("---- 开始对 mycli 进行初始化 ----");

    // 自定义初始化需执行的代码，此范例为打印当前目录
    console.log("当前目录为：" + process.cwd());

    console.log("---- 完成了 mycli 的初始化 ----");
  });

program
  .command("split") // 注册命令
  .description("将字符串分割成数组") // 对命令功能的描述
  .requiredOption("-s, --separator <char>", "分割符") // 必填的命令配置信息
  .argument("<string>", "被分割的字符串") // 命令的参数
  // 命令的具体行为（执行的代码）
  .action((params, options, cmd) => {
    // 命令的功能代码为分割字符串，打印最终分割成的数组
    console.log(params.split(options.separator));
  });

import pkg from "./package.json" assert { type: "json" };
// version() 完成版本号指令的注册和配置
program.version(pkg.version);

// 解析 commander
program.parse();

mycli --version

mycli -V

program.usage("<命令> [配置]");

program.helpInformation = function () {
  return "《mycli使用说明》\n命令列表\ninit —— 初始化\nsplit —— 字符串分割";
};