@ entient/ cli- utils

由百度命令行工具共享的无依赖性CLI原始:

• 终端能力检测 —— 说 NO_COLOR 编号 : FORCE_COLOR 编号 : TERM 优先使用可注射嵌入记录,因此检测为单位可测试.
• ANSI 颜色助手 ——色后降解为身份(空字符串)代码 不支持.
• 闪光灯 —— 说 parse 编号 : compare 编号 : satisfies 页:1 major.minor.patch[-prerelease]无外部 semver 依赖性.

零运行时间依赖关系. 仅限无害环境管理.

安装

npm install @centient/cli-utils

或作为单体中的工作空间依赖:

pnpm add @centient/cli-utils --workspace

终端能力与颜色

检测被拆分为 a 纯核 (注射器) env 记录和a 流描述符 — read no globals)和薄 活程序包装器 页:1 人类基因组CLI呼叫网站.

颜色优先排序

resolveColorSupport(env, isTTY) 按此精确度确定颜色支持 优先( 最高胜 ) :

1. FORCE_COLOR 当前 (任何价值,包括 "") 颜色 打开
2. NO_COLOR 当前 (任何价值,包括 "") 颜色 关闭
3. TERM === "dumb" • 颜色 关闭, (中文(简体) ), isDumb = true
4. 流为 TTY • 颜色 打开
5. 否则 • 颜色 关闭

存在通过关键存在测试 NO COLOR 公约: 变量的单纯存在是信号,无论价值如何. 一个钥匙 值为 undefined 计数为 缺席。 。 。 .

import {
  detectCapabilities,
  makeAnsiColors,
  colorize,
} from "@centient/cli-utils";

// Pure / testable: pass an env record and a stream descriptor.
const caps = detectCapabilities(process.env, process.stdout);
// caps -> { isTTY, hasColor, isDumb, width }

const colors = makeAnsiColors(caps.hasColor);
console.log(colorize(colors, "green", "ok"));
// "ok" is wrapped in ANSI green when color is enabled, returned unchanged when not.

现场处理便利包装器

import { detectTerminalCapabilities, createAnsiColors } from "@centient/cli-utils";

const caps = detectTerminalCapabilities("stdout"); // reads process.env + process.stdout
const colors = createAnsiColors();                 // colors for the live stdout

结构错误

import { writeError } from "@centient/cli-utils";

writeError("config not found", "a path to engram.json", "pass --config <path>");
// [ERROR] config not found
//   Expected: a path to engram.json
//   Recovery: pass --config <path>

水槽可以注射(writeError(what, expected, recovery, write?), (中文(简体) ), 默认为 process.stderr返回无效;退出代码处理是 电话员的责任.

闪光灯

参数 major.minor.patch 带有可选预释标识符并构建 元数据。 构建元数据解析并忽略命令( SemVer 2. 0) §10. 按SemVer 2.0 §11订出预放行——一种预放行种类 下级 它的释放.

import {
  parseSemver,
  tryParseSemver,
  formatSemver,
  compareSemver,
  compareVersions,
  satisfies,
} from "@centient/cli-utils";

parseSemver("1.2.3-rc.1");
// { major: 1, minor: 2, patch: 3, prerelease: ["rc", 1] }

tryParseSemver("v1.2.3"); // parsed tuple
tryParseSemver("not-a-version"); // null (diagnostic/fail-open paths)

const actual = tryParseSemver("v1.5.0");
const minimum = tryParseSemver("1.2.0");
const meetsMinimum =
  actual === null || minimum === null
    ? null // caller chooses whether to warn, skip, or fail open
    : compareSemver(actual, minimum) >= 0;

formatSemver(parseSemver("1.2.3-rc.1")); // "1.2.3-rc.1" (round-trips)

compareVersions("1.0.0-rc.1", "1.0.0"); // -1 (pre-release < release)

satisfies("1.5.3", "^1.2.0"); // true

支持范围表单

没有复合范围,没有 ||,没有连字符范围.

parseSemver, (中文(简体) ), compareVersions,以及 satisfies 保持严格:缺陷 版本或区域抛出 SemverError (载运) expected 财务报告和审定财务报表 input 字段) 而不是无声地羞辱. tryParseSemver 是明显的非抛掷 外部报告版本的边界; 它返回 null 无效输入 并接受一个常规小写 v 就在数字核心之前.

API 密码

许可证

麻省理工学院