CLI生成幫助庫(kù)的工具

molyzzx 發(fā)布于2019-08-23 10:38 / 2640人閱讀

摘要：均可用于為命令行工具生成幫助庫(kù)。的執(zhí)行結(jié)果返回一個(gè)對(duì)象。可選根據(jù)生成幫助文本參數(shù)是否顯示的指定數(shù)據(jù)去覆蓋和文本將改變的文本內(nèi)容改為生成的幫助文本為指定的生成拓展的幫助文本。是在幫助文本中放置在之前的可選字符串。特殊的用于打印幫助信息

Optionator, Commander均可用于為Node命令行工具(CLI)生成幫助庫(kù)。

源碼：https://github.com/cuizhirong...

Optionator

Optionator是一個(gè)JavaScript選項(xiàng)解析和幫助生成庫(kù)。

npm install optionator

require("optionator")返回一個(gè)function，一個(gè)VERSION參數(shù)(optionator的版本)。
function接收一個(gè)對(duì)象參數(shù)，參數(shù)中包含配置信息。function的執(zhí)行結(jié)果返回一個(gè)對(duì)象。

  var optionator = require("optionator")({
    prepend: "Usage: cmd [options]",
    append: "Version 1.0.1",
    options: [{
      option: "help",
      alias: "h",
      type: "Boolean",
      description: "displays help"
    }, {
      option: "count",
      alias: "c",
      type: "Int",
      description: "number of things",
      longDescription: "text longDescription",
      example: "cmd --count 2"
    }]
  });
  const options = optionator.parseArgv(process.argv);

  if (options.help) {
    console.log(optionator.generateHelp());
  }

parse(input, parseOptions)
根據(jù)settings處理輸入，并返回包含結(jié)果的對(duì)象。

參數(shù)：
input－想要解析的內(nèi)容
parseOptions－Int型，表示input是數(shù)組還是字符串，默認(rèn)0是字符串，2是數(shù)組

returns：解析后的對(duì)象

parseArgv(input)
parseArgv和parse相似，但是parseArgv只接收數(shù)組，切掉前兩個(gè)元素。

  parseArgv(process.argv)

generateHelp(helpOptions(可選))
根據(jù)settings生成幫助文本

參數(shù)：
helpOptions{showHidden: Boolean, interpolate: Object}
showHidden: 是否顯示hidden的option
interpolate: 指定數(shù)據(jù)去覆蓋prepend和append文本

//將改變append的文本內(nèi)容：Version {{version}} 改為 Version 0.4.2
generateHelp({interpolate: {version: "0.4.2"}})

return: String-生成的幫助文本

generateHelpForOption(optionName)
為指定的optionName生成拓展的幫助文本。如果option有example，則會(huì)顯示這個(gè)example。如果指定了longDescription，它將顯示longDescription而不顯示Description。

generateHelpForOption("count");

Settings格式

prepend: 是在幫助文本中放置在options之前的可選字符串。

append: 是在幫助文本中放置在options之前的可選字符串。

options: 配置信息的數(shù)組

helpStyle: 對(duì)象，改變一些默認(rèn)樣式

Options格式

option(必須) 名字

alias(可選) 縮寫

type(必須) 類型，被用作驗(yàn)證輸入值

description(可選) 介紹

example(可選) option的例子－當(dāng)generateHelpForOption被調(diào)用的時(shí)候才會(huì)打印

required(可選) 設(shè)置為true時(shí)，如果沒(méi)有定義這個(gè)參數(shù)打印將會(huì)失敗

Commander

提供了用戶命令行輸入和參數(shù)解析的強(qiáng)大功能。

npm install commander --save

#! /usr/bin/env node

var program = require("commander");

program
  .version("0.0.1")
  .option("-p, --pepprs", "Add peppers", function() { console.log("-p, --pepprs callback"); })
  .option("-b, --bbq-sauce", "Add bbq sauce")
  .option("-c | --control-thing", "Add ct")
  .parse(process.argv);

if (program.controlThing) console.log("  - cttt");

Options在Commander中通過(guò).option()定義。例子中解析了來(lái)自process.argv的參數(shù)和options(--help默認(rèn)添加)

option()接收四個(gè)參數(shù);

第一個(gè)參數(shù)是option名稱，"short option, long option" 或者寫成 "short option | long option"; long option中多個(gè)單詞組成的，比如--template-engine將被解析成駝峰式命名templateEngine; 在short/long option之后還可以指定參數(shù)(必填參數(shù), [db]可選參數(shù))

第二個(gè)參數(shù)是option的描述;
第三個(gè)參數(shù)是回調(diào)函數(shù);
第四個(gè)參數(shù)是回調(diào)函數(shù)默認(rèn)值。

對(duì)于未定義的option，程序會(huì)拋出錯(cuò)誤，如下圖的第一條命令; Commander的解決方法是提供方法.allowUnknownOption(), 直接退出取消這個(gè)自動(dòng)報(bào)錯(cuò)機(jī)制, 如下圖的第二條命令。

Command－特殊的options

program
  .command("rm ")
  .option("-r, --recursive ", "Remove recursively")
  .action(function (dir, cmd) {
    console.log("dir " + dir + " cmd " + cmd);
  });

.outputHelp(cb) .help(cb)用于打印幫助信息