参数 - 提示
一个基于公约的论证解析和格式化库,并有严格的验证检查. 这个 实值 没有 命令行接口.
import { parse } from '@boost/args';
interface Options {
help: boolean;
logLevel: 'info' | 'error' | 'warn';
version: boolean;
}
const { command, errors, options, params, rest } = parse<Options>(process.argv.slice(2), {
commands: ['build', 'install', 'update'],
options: {
help: {
default: false,
description: 'Show a help menu',
type: 'boolean',
short: 'H',
},
logLevel: {
choices: ['info', 'error', 'warn'],
default: 'info',
description: 'Customize logging level',
},
version: {
default: false,
description: 'Show the version number',
type: 'boolean',
short: 'V',
},
},
});
特征
- 命令和子命令 :
cmd, (中文(简体) ),cmd:sub - 设置值的选项( 长和短):
--foo value, (中文(简体) ),--foo=value, (中文(简体) ),-f value, (中文(简体) ),-f=value- 骆驼(首选)或kebab cased选项名.
- 无值的旗帜( 布尔选项) :
--bar, (中文(简体) ),-B- 暗含否定支持:
--no-bar
- 暗含否定支持:
- 独立值参数:
foo bar baz- 可根据需要进行标记.
- 剩余参数被传递到随后的脚本( 汇总于
--:foo -- bar - 支助
string, (中文(简体) ),number, (中文(简体) ),boolean,并添加:- 基于可能的选择列表的单值.
- 具有可选性计数要求的多值.
- 在单个参数下分组多个短选项:
-fBp- 每次在一组中找到一个短选项时都会增加一个计数器.
- 严格解析和验证检查,允许信息化接口.
- 自定义选项和参数验证以提高准确性 .
安装
yarn add @boost/args