commander入门教程及高级用法

简介

commander是一个轻巧的nodejs模块，提供了用户命令行输入和参数解析强大功能

安装

cnpm i -S commander

最小力度的脚手架

入门教程及高级用法

// 注册命令：commander
// 与yargs不同的是，commander默认支持hjy-cli --version和hjy-cli --help，而yargs不支持
// 执行：lio-imooc-test --version打印出版本号
const commander = require('commander')
const pkg = require('../package.json')
// 实例化一个Command示例
const program = new commander.Command()
program
    .name(Object.keys(pkg.bin)[0])  // 在usage最前面添加项目名称，与usage配套使用。控制台打印：Usage: lio-imooc-test <command> [options]
    .usage('<command> [options]')// 使用建议，与yargs一样：usage里的内容会打印在最前面
    .version(pkg.version)
    .option('-d, --debug', '是否开启调试模式', false)    // lio-imooc-test --debug
    .option('-e, --envName <envName>', '获取环境变量名称')          // lio-imooc-test -e 111

// commander脚手架命令注册的两种方法：1、command注册命令 2、addCommand 注册子命令
// 1、command注册命令
// lio-imooc-test clone
// <source>必须要传入的参数 lio-imooc-test clone aa
// [destination]可传可不传
const clone = program.command('clone <source> [destination]');
clone
    .description('clone a repository')                  // 描述
    .option('-f, --force', '是否强制克隆')    // 执行：lio-imooc-test clone aa bb --force
    .action((source, destination, cmdObj) => {          // 传入的参数解析。cmdObj对应的是强制克隆
        console.log(source, destination, cmdObj.force)      // aa bb true
    })

// 2、addCommand 注册子命令
const service = new commander.Command('service')
// 执行：lio-imooc-test service start 8080
service
    .command('start [port]')
    .description('start service at some port')
    .action((port) => {
        console.log('do service start', port)   // 8080
    })
// 执行：lio-imooc-test service stop
service
    .command('stop')
    .description('stop service')
    .action(() => {
        console.log('stop service')
    })
program.addCommand(service)

// 可实现A脚手架调用B脚手架，执行命令lio-imooc-test install
// 执行命令lio-imooc-test install init 相当于执行 imooc-cli init
program
    .command('install [name]', 'install package', {
        executableFile: 'imooc-cli',
        // isDefault: true// 默认执行命令
    })
    .alias('i')

// 除了上面注册的命令，其他的都会命中到这里
// lio-imooc-test test option
// program
//     .arguments('<cmd> [options]')
//     .description('test command', {  // 参数解释，执行lio-imooc-test test -h进行查看
//         cmd: 'command to run',
//         options: 'options for command'
//     })
//     .action(function (cmd, options) {
//         console.log(cmd, options)   // test option
//     })

// 高级定制1：自定义help信息，执行lio-imooc-test -h
// program.helpInformation = function () {
//     return 'help1'
// }
// program.on('--help', function () {
//     console.log('help2')
// })

// 高级定制2：实现debug模式，执行lio-imooc-test --debug
program.on('option:debug', function () {
    if (program.debug) {
        process.env.LOG_LEVEL = 'verbose'
    }
    console.log(process.env.LOG_LEVEL)
})

// 高级定制3：对未知命令监听
// 执行：lio-imooc-test aaa bbb
program.on('command:*', function (obj) {
    console.log(obj)    // [ 'aaa', 'bbb' ]
    console.log('未知的命令：' + obj[0])  // 未知的命令：aaa

    const availableCommands = program.commands.map(cmd => cmd.name())
    console.log('可用的命令：' + availableCommands.join(',')) // 可用的命令：clone,service,install
})

program
    .parse(process.argv);

// program.outputHelp()            // 打印出帮助信息
// console.log(program.opts())  // 打印传入的参数
// console.log(program.debug)   // 运行：lio-imooc-test -e 111 --> false
// console.log(program.envName) // 运行：lio-imooc-test -e 111 --> 111