文学起点网
当前位置: 首页 文学百科

cli怎么打开(打造属于自己的一款命令行)

时间:2023-07-17 作者: 小编 阅读量: 2 栏目名: 文学百科

前言如果你想了解命令行脚手架,这篇将带你入个门了解commander和inquirer库的使用。然后通过一个Demo示例来示范如何创作一个脚手架。commander首先需要知道commander这个npm库,它帮我们封装了解析命令行的能力。我们之后要做的脚手架都是基于commander的。但离人性化的命令行工具还有点距离,下面提供几种技巧:控制台输出语句的颜色有个仓库叫chalk,让我们可以自定义console.log输出的颜色。这对于命令行有非常好的可视化效果。

前言

如果你想了解命令行脚手架,这篇将带你入个门了解 commanderinquirer 库的使用。然后通过一个 Demo 示例来示范如何创作一个脚手架。

commander

首先需要知道 commander 这个 npm 库,它帮我们封装了 解析命令行 的能力。我们之后要做的脚手架都是基于 commander 的。

先了解几个简单的使用方式显示帮助&版本信息

const program = require('commander');// 定义程序名称,版本program.name(cliName).version(pkg.version);// 解析命令行program.parse(process.argv);

执行 node ./bin/fl-cli –help ,将看到如下效果:

D:\project\frontend-learn-cli>node ./bin/fl-cli --helpUsage: fl [options]Options:-V, --versionoutput the version number-h, --helpdisplay help for command

这个 program.parse 方法必须调用,不然命令行工具就不能“正常的工作了”。

输出信息中,能看到 Usage 条目,默认它向我们展示如何去使用这个命令,当然我们也可以更改它:

program.usage('<command> [options]');

Usage: fl <command> [options]

如何约定命令 Command?

命名一个 create 命令,约定用于创建应用(类似 vue create)

program.command('create').description('创建应用').action(() => {console.log('hello command');});

通过 help 命令,能看到 Commands 条目中增加的新命令信息:

D:\project\frontend-learn-cli>node ./bin/fl-cli --helpUsage: fl <command> [options]Options:-V, --versionoutput the version number-h, --helpdisplay help for commandCommands:create创建应用help [command]display help for command

执行 create 命令:

D:\project\frontend-learn-cli>node ./bin/fl-cli createhello command

如何定义命令参数 Options?

我们需要额外增加参数,来让命令应对多种情况,比如可以设置 -f 使得创建的应用强制覆盖当前路径:

program.command('create').description('创建应用').option('-f,', '是否强制创建').action((options, command) => {console.log(options);});

D:\project\frontend-learn-cli>node ./bin/fl-cli create -f{ f: true }

我们也能自定义参数值:

.option('-f,--force <path>', '是否强制创建')

D:\project\frontend-learn-cli>node ./bin/fl-cli create --force /use/local{ force: '/use/local' }

需要注意,如果用户输入了 非预期 的参数将报错:

D:\project\frontend-learn-cli>node ./bin/fl-cli create -abcerror: unknown option '-abc'

我们可以添加 allowUnknownOption() 方法,防止 非预期 参数影响命令的执行:

program.command('create').description('创建应用').option('-f,--force <path>', '是否强制创建').allowUnknownOption().action((options, command) => {console.log(options);});

D:\project\frontend-learn-cli>node ./bin/fl-cli create -abc{}

进阶技巧

如上,我们就能进行开发简单的命令行工具了。但离 人性化 的命令行工具还有点距离,下面提供几种技巧:

控制台输出语句的颜色

有个仓库叫 chalk ,让我们可以自定义 console.log 输出的颜色。这对于命令行有非常好的可视化效果。

我们对 –help 命令做个封装,在 help 信息末尾添加蓝色的帮助命令语句:

const chalk = require('chalk');exports.outputHelp = (cliName) => {console.log();console.log(`Run ${chalk.cyan(`${cliName} <command> --help`)} for detailed usage of given command.`);console.log();};

program.on('--help', () => {outputHelp(cliName);});

同时,遍历每个 Command 命令,也为其添加这一功能:

program.commands.forEach((c) => c.on('--help', () => outputHelp(cliName)));

效果展示

“命令/参数”错误的封装

由于命令错误,参数错误或者值漏填会导致命令行的出错,对于这类非预期的错误需要及时提示使用者,而不是只展示:error: option ‘-f,–force ‘ argument missing 这样的信息。

参考 Vue 的错误处理 我们可以覆写 commander 的方法,结合 chalk 加强输出错误信息:

var enhanceErrorMessages = (methodName, log) => {program.Command.prototype[methodName] = function (...args) {if (methodName === 'unknownOption' && this._allowUnknownOption) {return;}this.outputHelp();console.log(``chalk.red(log(...args)));console.log();process.exit(1);};};// 类似有:missingArgument,unknownOption,optionMissingArgument 方法enhanceErrorMessages('missingArgument', (argName) => {return `Missing required argument ${chalk.yellow(`<${argName}>`)}.`;});

加强错误显示

交互式命令行 inquirer

通过 commandoption 可以定义所有命令行需要的功能,但在与使用者交互会相当不友好(会面对大量的命令说明)。

相信用过 vue-cli 都知道:在创建项目时,我们可以跟随命令行的提示来选择对应需要的功能。

这种交互式的命令行可以通过 inquirer 来完成。

下面是采用了这种方式的效果图:

效果图

先定义一批 questions 交互问题:

const defaultQuestions = [// 列表选择{type: 'list',name: 'template',message: '请选择模板',choices: [{ name: 'express' }, { name: 'vue2' }],},// 输入{type: 'input',name: 'appName',message: '请输入应用名称',default() {return 'app';},},];const expressQuestions = [{type: 'checkbox',name: 'express.middleware',message: '请选择中间件',choices: [{ name: 'express.json', checked: true },{ name: 'express.urlencoded', checked: false },],when(answers) {return answers.template == 'express';},},];const questions = [...defaultQuestions, ...expressQuestions];

然后在命令的 action 回调中调用 inquirer.prompt 方法:

program.command('create').description('创建应用').option('-f,--force <path>', '是否强制创建')// .allowUnknownOption().action((options, command) => {inquirer.prompt(questions).then(async (answers) => {console.log(answers);});});

当交互结束后,这个 answers 将是我们自定义的结果值:

{template: 'express',appName: 'app',express: { middlewares: [ 'json' ] }}{template: 'express',appName: 'app',express: { middlewares: [ 'json' ] }}

Demo

再了解上面有关命令行的工具操作后,下面可以实际“造”一个脚手架工具了。

下面将提供一个创建 express 代码模板的脚手架。用于快速生成相关代码目录,而不用去技术栈网站去拷贝大量代码。(具体代码逻辑,在 npm 搜索 frontend-learn-cli 即可)

简单实现思路:

通过commander,实现对创建create指令的命令行解析

program.command('create').description('创建应用').action((options, command) => {//inquirer...});

添加inquirer定义好相关可选问题

inquirer.prompt(questions).then(async (answers) => {// 模板逻辑...// 模板类型(express, vue...)// 项目名称// 中间件选择// ...});

定义模板固定代码

根据自己对 express 的习惯,定义相关代码结构:

template|- express|- bin| www.ejs|- routes| health.js.ejs| app.js.ejs| package.json.ejs

注意:上面的文件都已 ejs 作为后缀。具体原因是:模板变量会根据 answers 变量,动态注入自定义值。

ejs 文件模板会张这个样子:

# app.js.ejs<% if (express.middlewares.includes('json')) { -%>app.use(express.json())<% } -%><% if (express.middlewares.includes('urlencoded')) { -%>app.use(express.urlencoded())<% } -%>

为什么选择 ejs

是抄 express-generate 这个库的,当然也可以根据自己喜好选择模板引擎。这种模板方式让我做这种脚手架变得很方便,只要把历史项目 demo 复制进来,改一通后缀即可。

通过 fs 读模板到指定路径

将模板内的文件通过 fs-extra 写到指令执行的当前路径下(文件具体操作这里就不详述了)

inquirer.prompt(questions).then(async (answers) => {try {// 创建目录_mkdirProjectDir(answers.appName, options.f);_writeFiles([{ dirtory: 'bin', fileName: 'www', answers },{ dirtory: 'routes', fileName: 'health.js', answers },{ dirtory: 'util', fileName: 'index.js', answers },{ fileName: 'app.js', answers },{ fileName: 'package.json', answers },]);} catch (err) {console.log(chalk.red(err.message));}});

发布脚手架

package.json 文件中,约定 bin 属性,并指向我们实现的 commander 的文件:

"bin": {"fel": "bin/fel-cli.js"},

然后通过 npm publish 发布我们的脚手架包,最后使用者通过 npm i xxx -g 下载就能用了。

    推荐阅读
  • 苏州旅游攻略景点必去(苏州旅游必去景点有哪些)

    位于苏州市东北街一百七十八号,始建于明朝正德年间。虎丘是AAAAA级景区及全国文明单位,首批十佳文明风景旅游区示范点。中午,周庄最为欢闹,游人穿梭熙熙攘攘,船儿来回摇摇荡荡,各地的游客与热情的商铺融为一体,热闹非凡,安静的古镇着实多了些欢闹的气息。狮子林为苏州四大名园之一,位于苏州市市城东北园林路。

  • 买的玉米种子是瘪的(去年买的玉米种子剩了很多)

    去年买的陈玉米种子建议不要用针对去年的陈玉米种子,大多情况下不建议再次使用,会影响到玉米后期的生长和产量情况。陈年的因为保管的问题,可能会出现很多因素影响玉米的出苗率或者后期的生长。陈玉米种子隔了一年后再种植,种子自身水分含量降低,水分降低严重的情况下,影响播种的效率和玉米的后期生长,由于活性降低,即使能出芽,也不一定能出苗。

  • 173.2亿!国庆消费火爆 国庆消费市场

    今年国庆、重阳两节叠加,全省消费市场呈现平衡较快增长态势,服装、家电、汽车等商品消费亮点突出,大众餐饮、旅行休闲、文体娱乐等主要服务消费备受青睐。根据商务部业务统一平台生存必需品监测系统显示,国庆黄金周期间,全省生存必需品市场供应充沛,价格总体平衡。除了买买买,国庆还是婚庆、团圆、会友高峰,各地亲友聚餐、婚寿宴等大众化餐饮生意兴隆。

  • 吴承恩是怎么写出的西游记(吴承恩怎么写出的西游记)

    吴承恩怎么写出的西游记诸葛长青:吴承恩写西游记诸葛长青:吴承恩怎么写出的《西游记》西游记,广泛流传西游记,作者吴承恩西游记,包含了儒释道大智慧那么,吴承恩是怎么写出的《西游记》呢?诸葛长青把自己对吴承恩写《西游记》,研究成。

  • 李逵扮演者(大家一起来看看吧)

    我们一起去了解并探讨一下这个问题吧!李逵扮演者赵小锐的李逵应该算是很多人印象当中的经典所在了,他的李逵也是很粗犷,但是这种粗犷当中却带着细腻,也是因为这个角色,他开始受到了不少的观众的关注和喜爱。其实之前的他也有出演过一些电视剧的,但是可惜的是一直都没能够真正的红起来,是李逵这个角色,让他一夜成名爆火了。

  • 汽车空间大小怎么看轴距(什么因素会影响车内空间)

    大众速腾,长度4655mm,轴距2651mm。看外观就明白了,因为宝马320i是后驱车,发动机采用纵置布局;而大众速腾是前驱车,发动机采用横置布局。而且由于发动机纵置,后驱设计,对于车内空间侵占较为严重,所以宝马320的长轴距实际上对于空间的帮助是“虚高”的。前面我们就提到了,宝马3系采用了后驱,大众速腾采用了前驱。回到我们的主题,通常来说,麦弗逊与扭力梁对于车辆空间的侵占是最小的,而多连杆和双叉臂对于车辆空间侵占是要更大的。

  • 湖南省医保局2015年工作思路与安排 湖南省医疗保障局领导班子组成人员

    督促指导各统筹地区核实提高缴费基数,强化保险费足额征收。继续加强工伤认定参与,把好工伤入口关。认真核实、积极处理群众举报问题,始终保持高压态势。加强生育医疗服务管理,规范生育津贴发放。二是启动实施工伤保险信息系统改造升级,改进工伤职工异地就医联网结算,方便工伤职工救治。三是加强财务、业务数据清理,提高数据质量;通报全省“三险”基金运行分析,指导市州加强基金运行风险管控。

  • 民国最渣四大渣男(民国著名4大渣男)

    当时很多文人在接受自由恋爱的思想时,家中已经有了父母为之安排的妻子。郁达夫一生有过三位妻子,一位同居情人。郁达夫后来还是和王映霞离婚,1940年在新加坡认识了比他小20岁的播音员李莜英,两人很快就同居了。第二任妻子佐藤富子,是个日本女人,为了和郭沫若在一起,不仅改名为“郭安娜”,还和父母断绝了关系。1937年,郭沫若抛弃妻子回国,和女明星于立群同居,两人于2年后再重庆结婚。

  • 电脑怎么连打印机教程(教会你快速学会电脑如何连接打印机的安装使用方法)

    最近很多网友都在私信给小编,小编也无法一一回复,有些问题也无法简约介绍,所以只能在头条文章内与大家共享。

  • 爱吃鸡蛋的注意了这3种鸡蛋不能买(这些鸡蛋没你想的那么好)

    营养均衡的孩子没必要补这种元素;真正缺乏硒,靠富硒蛋补,根本起不了多大作用。这类蛋再好,也别给孩子吃那就是全生或半熟的蛋,比如溏心蛋。一般溏心蛋的加热时间短,不能完全杀死细菌,生蛋液根本没有处理细菌,对于抵抗力低、易感染的宝宝来说,非常容易被细菌感染。