inquirer：命令行中与用户进行交互的js库

一&＃xff0c;概述

在写前端项目的脚手架之类的配置时&＃xff0c;需要在命令行中进行交互&＃xff0c;以获取用户的配置。这时就可以使用这个js库。

二&＃xff0c;基本用法

1&＃xff0c;使用的语法结构

const inquirer &＃61; require(&＃39;inquirer&＃39;);const promptList &＃61; [// 具体交互内容&＃xff0c;每一个对象里都是一次交互{...},{...}
];
inquirer.prompt(promptList).then(answers &＃61;> {console.log(answers); // 返回的结果是一个promise对象&＃xff0c;交互的结果就存储在这里
})


2&＃xff0c;参数概述

type&＃xff1a;表示提问的类型&＃xff0c;包括&＃xff1a;input, confirm, list, rawlist, expand, checkbox, password, editor&＃xff1b;
name: 存储当前问题回答的变量&＃xff1b;
message&＃xff1a;问题的描述&＃xff1b;
default&＃xff1a;默认值&＃xff1b;
choices&＃xff1a;列表选项&＃xff0c;在某些type下可用&＃xff0c;并且包含一个分隔符(separator)&＃xff1b;
validate&＃xff1a;对用户的回答进行校验&＃xff1b;
filter&＃xff1a;对用户的回答进行过滤处理&＃xff0c;返回处理后的值&＃xff1b;
transformer&＃xff1a;对用户回答的显示效果进行处理(如&＃xff1a;修改回答的字体或背景颜色)&＃xff0c;但不会影响最终的答案的内容&＃xff1b;
when&＃xff1a;根据前面问题的回答&＃xff0c;判断当前问题是否需要被回答&＃xff1b;
pageSize&＃xff1a;修改某些type类型下的渲染行数&＃xff1b;
prefix&＃xff1a;修改message默认前缀&＃xff1b;
suffix&＃xff1a;修改message默认后缀。


三&＃xff0c;对应常用的类别

1&＃xff0c;input

const promptList &＃61; [{type: &＃39;input&＃39;,// input类型带测试message: &＃39;设置一个用户名:&＃39;,name: &＃39;name&＃39;,default: "test_user" },{type: &＃39;input&＃39;,//input类型带校验message: &＃39;请输入手机号:&＃39;,name: &＃39;phone&＃39;,validate: function(val) {if(val.match(/\d{11}/g)) { // 校验位数return true;}return "请输入11位数字";}}
];


效果&＃xff1a;

2,rawList

{type: &＃39;rawlist&＃39;,//rawlist类型message: &＃39;请选择一种水果:&＃39;,name: &＃39;fruit&＃39;,choices: ["Apple","Pear","Banana"]
},


3,list

{type: &＃39;list&＃39;,//list类型name: &＃39;env&＃39;,message: &＃39;请选择你要部署的环境&＃xff1f;&＃39;,choices: [&＃39;生产环境&＃39;, &＃39;准生产环境&＃39;, &＃39;测试环境&＃39;]},


4,checkoutBox

{type: "checkbox",message: "选择颜色:",name: "color",choices: [{name: "red"},new inquirer.Separator(), // 添加分隔符{name: "blur",checked: true // 默认选中},{name: "green"},new inquirer.Separator("--- 分隔符 ---"), // 自定义分隔符{name: "yellow"}]}


5,comfirm

{type: "confirm",message: "是否使用监听&＃xff1f;",name: "watch",default:true},{type: "confirm",message: "是否进行文件过滤&＃xff1f;",name: "filter",when: function(answers) { // 当watch为true的时候才会提问当前问题return answers.watch}}


四&＃xff0c;完整的代码

const inquirer &＃61; require(&＃39;inquirer&＃39;);
const promptList &＃61; [{type: &＃39;input&＃39;,// input类型带测试message: &＃39;设置一个用户名:&＃39;,name: &＃39;name&＃39;,default: "test_user" },{type: &＃39;input&＃39;,//input类型带校验message: &＃39;请输入手机号:&＃39;,name: &＃39;phone&＃39;,validate: function(val) {if(val.match(/\d{11}/g)) { // 校验位数return true;}return "请输入11位数字";}},{type: &＃39;rawlist&＃39;,//rawlist类型message: &＃39;请选择一种水果:&＃39;,name: &＃39;fruit&＃39;,choices: ["Apple","Pear","Banana"]},{type: &＃39;list&＃39;,//list类型name: &＃39;env&＃39;,message: &＃39;请选择你要部署的环境&＃xff1f;&＃39;,choices: [&＃39;生产环境&＃39;, &＃39;准生产环境&＃39;, &＃39;测试环境&＃39;]},{type: "checkbox",message: "选择颜色:",name: "color",choices: [{name: "red"},new inquirer.Separator(), // 添加分隔符{name: "blur",checked: true // 默认选中},{name: "green"},new inquirer.Separator("--- 分隔符 ---"), // 自定义分隔符{name: "yellow"}]}
];
const nextPromptList&＃61;[{type: "confirm",message: "是否使用监听&＃xff1f;",name: "watch",default:true},{type: "confirm",message: "是否进行文件过滤&＃xff1f;",name: "filter",when: function(answers) { // 当watch为true的时候才会提问当前问题return answers.watch}}
]async function test(){const res&＃61;await inquirer.prompt(promptList)//参数是一个数组&＃xff0c;数组中每个对象就是一次交互console.log("----",res)const res2 &＃61; await inquirer.prompt(nextPromptList);console.log("&＃43;&＃43;&＃43;&＃43;",res2)
}test()