浅读cac.js-- 一、常用api

820 阅读1分钟

通俗来讲,cac.js用于Node 命令行程序的制作。

例如安装vue脚手架工具@vue/cli后,在命令行工具中就可以输入vue create my-project创建空项目。

cac.js可以帮助完成,接收到create命令后,执行自定义逻辑的功能。

以下例子中index.js是测试文件名

1.command(name,description,config?) //命令名,描述,附加命令

const cac = require('cac');//引入
const cli = cac();//实例化

cli.command('myInfo', '尝试command 功能') .action(() => {     
    console.log("您的myInfo触发");
})

cli.parse();

conmand参数name:尖括号表示必需的命令参数,而方括号表示可选参数

.command('myInfo [params]' , '尝试command 功能') 

.command('myInfo ' , '尝试command 功能') 

2.option(name,description,config?)//名字,描述,附加命令

const cac = require('cac');//引入
const cli = cac();//实例化
  cli
    .command('logInfo', '尝试option功能')
    .option("--age","尝试option")
    .action((options) => { 
       console.log(options);
    })

 cli.parse();

option参数name:尖括号表示需要字符串/数字值,而方括号表示该值也可以是true.

3.action(callback)

如1所示,action用来定义,命令匹配后的回调函数。

4.parse()

当调用此方法时,cli.rawArgs cli.args cli.options cli.matchedCommand也将可用。

5.version() 定义版本号

cli.version("1.0.500");

6.输出版本号

cli.outputVersion();

7.help(callback?)

 const cac = require('cac');//引入
 const cli = cac("vue200");//实例化cli.help(()=>{    
    console.log("打印帮助信息")
}) cli.parse();