@boost/args

中文文档
5.0.0发布于 2024/03/01MITTypeScriptES Module近 30 天下载 1.7万

一个基于公约的论证解析和格式化库,并有严格的验证检查.

中文使用文档
文档目录3 节
  1. 特征
  2. 安装
  3. 文档

参数 - 提示

build status npm version

一个基于公约的论证解析和格式化库,并有严格的验证检查. 这个 实值 没有 命令行接口.

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

文档

版本与发布记录

@boost/args 共发布 30 个版本,首次发布于 2019/11/25;过去 12 个月发布了 0 个版本。

版本发布日期距今
5.0.0latest2024/03/012 年前
5.0.0-alpha.2next2024/02/272 年前
5.0.0-alpha.12024/02/122 年前
4.0.12023/05/023 年前
4.0.02022/08/194 年前
4.0.0-alpha.12022/05/034 年前

关于 @boost/args 的常见问题

@boost/args 是什么?

一个基于公约的论证解析和格式化库,并有严格的验证检查.

如何安装 @boost/args?

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

@boost/args 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@boost/args 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@boost/args 需要什么版本的 Node.js?

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

@boost/args 可以商用吗?

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

@boost/args 的下载量有多少?

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

@boost/args 还在维护吗?

最新版本 5.0.0 发布于 2024/03/01(2 年前);至今共发布 30 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/11/25。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。