使用inquirer,chalk来创建一个交互式的nodejs-cli

官方有详细的文档,只记录自己用到的,方便后面查阅

  • 最近接触到了两个npm包inquirer,学习一下

inquirer.js ---- 提供命令行与用户的交互接口

var inquirer = require('inquirer');
inquirer
  .prompt([
    /* Pass your questions in here */
  ])
  .then(answers => {
    // Use user feedback for... whatever!!
  });
  • 从示例可以看到,使用.prompt()来提出问题,得到一个封装好的promise,在then()中执行操作
  • 一个问题由一个question object来表示,只记录常用:
    name (String) : 必选参数,问题的名字,在问题被回答完毕后,需要通过answers.name获取到该问题的答案
    type (String) :交互问题的类型.默认是 input。支持: input, number, confirm, list, rawlist, expand, checkbox, password, editor
    message (String | Function) : 提出的问题,也可以通过一个function来定制,该方法会拿到当前会话的answer对象,你可以在funciton中根据之前answer中的回答来制定当前的问题。
    default (String | Number | Boolean | Array | Function) : 问题的默认值,根据前面问题的类型而定,特殊的也可以类似于message来通过方法来定制
    choices (Array | Function) : 提供一个数组来为问题提供选择,数组中可以提供简单的直接值,也可以使用如下形式:
[{
  name : "han", //展示出来的选项
  value :  "gaara han", //该选项实际对应的值
  short : "h", //选择后展示的简称
},...]

还可以在其中使用inquirer提供的分隔符类

简单尝试

const inquirer = require('inquirer');
inquirer.prompt([
  {
    name : 'my-name',
    type : 'list',
    message : 'which of this is my name?',
    default : 'i don\'t know',
    choices : [
      {
        name : 'gaara han',
        value : 'gaara han',
        short : 'gaara',
      },
      {
        name : 'han',
        value : 'han',
        short  : 'han',
      },
      {
        name : "i don't know",
        value : 'undefined',
        short : 'no-name'
      },
    ],
  }
]).then(ans=>{
  console.log(ans);
})
使用inquirer,chalk来创建一个交互式的nodejs-cli_第1张图片
使用inquirer,chalk来创建一个交互式的nodejs-cli_第2张图片

chalk --- 给输出带上颜色

  • chalk.js , chalk的使用较为简单, 通过官网的示例就可以很快了解用法
const chalk = require('chalk');
const log = console.log;
// 为普通字符串结合样式
log(chalk.blue('Hello') + ' World' + chalk.red('!'));
// 可以同时添加多个样式
log(chalk.blue.bgRed.bold('Hello world!'));
// 可以传递多个值
log(chalk.blue('Hello', 'World!', 'Foo', 'bar', 'biz', 'baz'));
// 可以相互嵌套
log(chalk.red('Hello', chalk.underline.bgBlue('world') + '!'));
log(chalk.green(
  'I am a green line ' +
  chalk.blue.underline.bold('with a blue substring') +
  ' that becomes green again!'
));
// 支持模版字符串
log(`
  CPU: ${chalk.red('90%')}
  RAM: ${chalk.green('40%')}
  DISK: ${chalk.yellow('70%')}
  `);
let cpu = { totalPercent : 80, }
let ram = { used : 4, tota : 8, }
let disk = { used : 20, total : 50, }
log(chalk`
  CPU: {red ${cpu.totalPercent}%}
  RAM: {green ${ram.used / ram.total * 100}%}
  DISK: {rgb(255,131,0) ${disk.used / disk.total * 100}%}
  `);
// 使用关键字,rgb,十六进制
log(chalk.keyword('orange')('Yay for orange colored text!'));
log(chalk.rgb(123, 45, 67).underline('Underlined reddish color'));
log(chalk.hex('#DEADED').bold('Bold gray!'));
使用inquirer,chalk来创建一个交互式的nodejs-cli_第3张图片

你可能感兴趣的:(使用inquirer,chalk来创建一个交互式的nodejs-cli)