@gerhobbelt/nomnom

中文文档
1.8.4-31发布于 2021/02/04MITCommonJS近 30 天下载 4.3万

选项解析生成的用法和命令

中文使用文档

原件的折旧通知

原作者的书 nomnom 已贬值; 此分叉不是: 我们继续更新此库 .

当您不确定使用此图书馆的叉子( 或其他) 时, 您可能希望查看 https://github.com/tj/commander.js (英语)。 。 。 .

我个人更喜欢用 nomnom 结束 commander 或其他选项解析器, 所以我会保留这个。 。 )

无名

build status

nomnom是节点的选项解析器. 它点出你的标语 并用散文还给你.

var opts = require("@gerhobbelt/nomnom")
   .option('debug', {
      abbr: 'd',
      flag: true,
      help: 'Print debugging info'
   })
   .option('config', {
      abbr: 'c',
      default: 'config.json',
      help: 'JSON file with tests to run'
   })
   .option('version', {
      flag: true,
      help: 'print version and exit',
      callback: function() {
         return "version 1.2.4";
      }
   })
   .parse();

if (opts.debug)
   // do stuff

如果不想的话,你不需要说明:

var opts = require("@gerhobbelt/nomnom").parse();

var url = opts[0];     // get the first positional arg
var file = opts.file   // see if --file was specified
var verbose = opts.v   // see if -v was specified
var extras = opts._    // get an array of the unmatched, positional args

安装

页:1 节点.js 财务报告和审定财务报表 无数字 :

npm install @gerhobbelt/nomnom

更多细节

Nomnom 支持诸如 -d, (中文(简体) ), --debug, (中文(简体) ), --no-debug, (中文(简体) ), --file=test.txt, (中文(简体) ), --file test.txt, (中文(简体) ), -f test.txt, (中文(简体) ), -xvf和姿势。 位置是不符合 -a 或者说 --atomic 格式,而不附加在选项上.

价值是JSON解析的,所以 --debug=true --count=3 --file=log.txt 会给你:

{
   "debug": true,
   "count": 3,
   "file": "log.txt"
}

图标

Nomnom 支持基于命令的接口(例如使用 git : git add -p 财务报告和审定财务报表 git rebase -i 地点 add 财务报告和审定财务报表 rebase 命令为:

var parser = require("@gerhobbelt/nomnom");

parser.command('browser')
   .callback(function(opts, command) {
      runBrowser(opts.url);
   })
   .help("run browser tests");

parser.command('sanity')
   .option('outfile', {
      abbr: 'o',
      help: "file to write results to"
   })
   .option('config', {
      abbr: 'c',
      default: 'config.json',
      help: "json manifest of tests to run"
   })
   .callback(function(opts, command) {
      runSanity(opts.filename);
   })
   .help("run the sanity tests")

parser.parse();

每个命令在 -h 或者说 --help 与命令一起指定.

使用量

Nomnom 打印出一个使用消息, 如果 --help 或者说 -h 这是一个争论。 如果没有命令被调用( 脚本只是在没有参数的情况下运行) , -h 除非您使用 .autoShowUsage(false) API电话.

这些选项在 test.js数字 :

var opts = require("@gerhobbelt/nomnom")
   .script("runtests")
   .options({
      path: {
         position: 0,
         help: "Test file to run",
         list: true
      },
      config: {
         abbr: 'c',
         metavar: 'FILE',
         help: "Config file with tests to run"
      },
      debug: {
         abbr: 'd',
         flag: true,
         help: "Print debugging info"
      }
   }).parse();

...会是这样的:

usage: runtests <path>... [options]

path     Test file to run

options:
   -c FILE, --config FILE   Config file with tests to run
   -d, --debug              Print debugging info

选项

您可以添加一个选项的规格 nomnom.option('name', spec) 或将规格传递给 nomnom.options() as a 散列键于选项名。 每个选项规格可以有以下字段:

腹部并满

abbr 是匹配此选项的单一字符串, full 是全长字符串(默认为选项名称).

此选项匹配 -d 财务报告和审定财务报表 --debug 在命令行上 :

nomnom.option('debug', {
   abbr: 'd'
})

此选项匹配 -n 3, (中文(简体) ), --num-lines 12 在命令行上 :

nomnom.option('numLines', {
   abbr: 'n',
   full: 'num-lines'
})

旗帜

如果设置为真,则选项会充当一面旗帜,不会吞下命令行上下一个值. 默认是 false,所以通常,如果你有一个命令行 --config test.js, (中文(简体) ), config 将获得价值 test.js 在选项散列中。 而如果指定:

nomnom.option('config', {
   flag: true
})

config 将获得价值 true 和 test.js 将是一个自由位置的参数.

元图

metavar 用于打印,例如. "PATH" 内 "-f PATH, --file PATH"。 。 。 .

字符串

缩写 abbr, (中文(简体) ), full,以及 metavar。例如,在 -c 财务报告和审定财务报表 --config 使用一个 string: "-c FILE, --config=FILE"

帮助

用于打印的选项的字符串描述 .

默认

参数中未指定选项的值 .

类型

如果您不想使用 JSON 选项, 请指定类型 "string"。 。 。 .

回调

一旦遇到选项, 将立即执行回调 。 如果调用返回字符串, 它会打印字符串并退出 :

nomnom.option('count', {
   callback: function(count) {
      if (count != parseInt(count)) {
         return "count must be an integer";
      }
   }
})

职位

如果选项是一个位置参数,则选项的位置. 如果选项应当与第一个位置参数使用位置相匹配 0等 (中文(简体) ).

列表

指定选项为列表。 附加可以通过在命令行上多一次指定参数来实现:

node test.js --file=test1.js --file=test2.js

如果选项有: position 财务报告和审定财务报表 list 实值 true,所有位置参数包括和之后 position 将附加到数组中.

所需经费

如果设定为 true 而选项不在参数中,则会打印一个消息并退出程序.

选择

选项的可能值列表(例如:. ['run', 'test', 'open']) (中文(简体) ). 如果解析值不在列表中, 信件会被打印, 程序会退出 .

转换

将选项值作为输入值并返回新值的函数将被视为选项值.

nomnom.option('date', {
   abbr: 'd',
   transform: function(timestamp) {
     return new Date(timestamp);
   }
})

隐藏

选项不会在用法中打印

解析器接口

require("nomnom") 将给出选项解析器。 您也可以用 require("nomnom")()。您可以在解析器中链接其中的任何函数:

选项

添加带有给定名称的选项规格 :

nomnom.option('debug', {
   abbr: 'd',
   flag: true,
   help: "Print debugging info"
})

选项

添加选项作为按住选项名的散列键, 有利于含有数以吨计选项的 cli 此示例数字 :

nomnom.options({
   debug: {
      abbr: 'd',
      flag: true,
      help: "Print debugging info"
   },
   fruit: {
      help: "Fruit to buy"
   }
})

使用量

将覆盖默认生成的使用消息的字符串 .

帮助

附加在用法上的字符串 .

自动显示设备

这个 enable 参数决定当没有指定命令行参数时,nomnom是否会自动打印使用;默认是 true 即该特性被启用。 过 false 改为 禁用 这个功能.

获取用户

返回生成的用法消息 。 何时 .command(...) 已调用,将生成最后一个“ 活性” 命令的用法信息.

脚本

诺姆诺姆无法检测用于运行您脚本的别名. 你用得着 script 以提供打印的正确名称,而不是例如. node test.js。 。 。 .

打印机

覆盖使用打印功能.

命令

使用命令名称并给您一个命令对象,您可以在其中链路命令选项.

当您通过 .callback() API,然后当命令行已被解析并在那里找到给定的命令时会引用回调 . 见 .callback() 详细情况.

当您未提供名称参数或无效/ 未定义名称时, 此API 相当于引用 .nocommand()。 。 。 .

无命令

给出一个在未调用命令时会使用的命令对象 .

当您通过 .callback() API,然后当命令行解析和 无论是 没有找到命令 或者说 为 which 找到一个命令, 没有指定回调 . 见 .callback() 详细情况.

无颜色

禁用使用消息的颜色.

颜色

覆盖您自己的帮助/ 报告格式化对象, 以提供自定义的配色方案 。 它应履行这些职能:

{
  usageHeadingColor: f1,
  usageStringColor: f2,
  positionalHelpColor: f3,
  optionsHeaderColor: f4,
  helpColor: f5,
  requiredArgColor: f6
};

地点 f1 结束 f6 是接收单个字符串并应当返回一个(已处理/已转换)字符串的函数引用,包括所期望的色彩控制台逃出序列.

剖析

解析节点 process.argv 并返回已解析过的散列选项。 您也可以提供 argv:

var opts = nomnom.parse(["-xvf", "--atomic=true"])

编号

一样 parse()。 。 。 .

命令接口

命令以 nomnom.command('name')。所有这些功能都可以被链条绑在一个命令上:

选项

专门为此命令添加一个选项 .

选项

添加此命令的选项为按名键的选项散列 .

回调

命令使用时会随解析选项调用回调 。 传回的论据是满满的 options 对象和命令名称.

当 .command() 设置代码的章节 没有 指定回调,然后取而代之的是“回调回调”。 此回调是定义于 .nocommand() a.k.a.为空 .command() (无) name 参数)。 接下来 command 名称参数传递到提供的回调 null。 。 。 .

帮助

描述此命令功能的帮助字符串 .

使用量

覆盖此命令的默认生成的使用字符串 .

版本与发布记录

@gerhobbelt/nomnom 共发布 17 个版本,首次发布于 2017/08/20;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.8.4-31latest2021/02/045 年前
1.8.4-302020/04/266 年前
1.8.4-292019/06/247 年前
1.8.4-282019/01/287 年前
1.8.4-272018/09/168 年前
1.8.4-262018/09/168 年前

关于 @gerhobbelt/nomnom 的常见问题

@gerhobbelt/nomnom 是什么?

选项解析生成的用法和命令

如何安装 @gerhobbelt/nomnom?

在项目目录运行 npm install @gerhobbelt/nomnom,或使用 pnpm add / yarn add / bun add。

@gerhobbelt/nomnom 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/gerhobbelt__nomnom 是否存在。

@gerhobbelt/nomnom 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@gerhobbelt/nomnom 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=4.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@gerhobbelt/nomnom 可以商用吗?

@gerhobbelt/nomnom 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gerhobbelt/nomnom 的下载量有多少?

根据 npm 官方下载统计,@gerhobbelt/nomnom 在 2026/10/16 – 2026/11/14 这 30 天内被下载 42,513 次,日均约 1,417 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gerhobbelt/nomnom 还在维护吗?

最新版本 1.8.4-31 发布于 2021/02/04(5 年前);至今共发布 17 个版本,其中过去 12 个月发布了 0 个;首次发布于 2017/08/20。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。