# 精益 TypeScript 模式用于构建轻量级、零依赖 TypeScript/Bun 工具的模式。从研究示例性存储库中提炼出来：unjs/cityty (CLI)、unjs/consola (日志记录)、unjs/ofetch (HTTP)、unjs/defu (合并)、unjs/scule (字符串)、unjs/pathe (路径)、antfu/taze (包更新)。 ## 七项原则 ### 1\.零依赖设计内联小型实用程序。使用 `node:` 内置函数。如果需要，供应商在构建时提供。 * CLI 解析：`node:util.parseArgs`（不是 Commander/yargs） * 颜色：22 行 ANSI 代码（不是粉笔/picocolors） * Path utils：7 行标准化器（不是 `path` 填充） * HTTP：`globalThis.fetch` 包装器（不是 axios） * 对象合并：40行递归合并（不是lodash.merge） ### 2\.身份函数作为类型助手 `defineCommand`、`defineConfig` 返回它们的参数不变。他们唯一的工作是类型推断：函数defineCommand(def: CommandDef): CommandDef { 返回定义； } `const` 修饰符保留文字类型。如果没有它，`{ type: "boolean" }` 就会扩展为 `{ type: string }`。 ### 3\.一个核心原语，组合一切每个图书馆都有一个核心功能。其他一切都是薄包装纸： * scule: `splitByCase()` -> 驼峰命名法、kebabCase 命名法、pascalCase 命名法、snakeCase 命名法、trainCase 命名法 * pathe: `normalizeWindowsPath()` -> 连接、解析、规范化、相对等。 * defu: `_defu()` -> defu, defuFn, defuArrayFn * 控制台： `_logFn()` -> .info()、.error()、.warn()、.debug() 等。 ### 4\.类之上的工厂模式捕获配置并返回可组合实例的闭包：函数createFetch(globalOpts = {}) { const $fetch = async (url, opts) => { /* ... */ }; $fetch.create = (默认值) => createFetch({ ...globalOpts, 默认值 }); 返回 $fetch; } 使用者：ofetch (`createFetch`)、consola (`createConsola`)、defu (`createDefu`)、citty (`createMain`)。 ### 5\.可解析惰性/异步值一种可以在任何地方启用延迟加载的类型：类型 Resolvable = T |承诺 | (() => T) | (() => Promise); 函数resolveValue（输入：Resolvable）：T |承诺 { 返回输入类型===“函数”？（输入任意）() ：输入； } 用于子命令、配置、元数据——任何可能需要昂贵的预先计算成本的东西。 ### 6\.智能默认设置、逃生舱口 * ofetch：POST/PUT/DELETE 重试次数默认为 0，GET 重试次数默认为 1 * city: 位置参数默认为必需，命名参数为可选 * consola：TTY 中的花式报告器、CI 中的基本报告器、devtools 中的浏览器报告器 * defu: `null`/`undefined` = "未设置"，让默认值填写 ### 7\.类型镜像运行时如果运行时在判别式上分派，则类型系统也应该： // 运行时：打开类型 if (arg.type === "boolean") { /* ... */ } // 类型：以相同判别式为条件类型 ParsedArg = T[“类型”] 扩展“布尔值”？布尔值： T[“类型”] 扩展“字符串”？字符串： T[“类型”] 扩展“枚举”？ T["选项"][数字] : 从来没有； ## 复制粘贴模式 ### ANSI 颜色（22 行，零深度）常量无颜色 = (() => { const env = globalThis.process?.env ?? {}；返回 env.NO_COLOR === "1" || env.TERM ===“愚蠢”||环境 CI; })(); 类型 ColorFn = (t: string) => string; const _c = (c: 数字, r = 39): ColorFn => (t) => 没有颜色？ t : `\u001b[${c}m${t}\u001b[${r}m`; 导出 const 粗体 = _c(1, 22); 导出 const 暗淡 = _c(2, 22); 导出常量红色 = _c(31); 导出常量绿色 = _c(32); 导出常量黄色 = _c(33); 导出常量蓝色= _c(34); 导出常量青色 = _c(36); 导出常量灰色 = _c(90); ### isPlainObject（10 行）函数 isPlainObject(值: 未知): 值为 Record<字符串, 未知> { if (value === null || typeof value !== "object") return false; const proto = Object.getPrototypeOf(value); if (原型 !== null && 原型 !== Object.prototype && Object.getPrototypeOf(proto) !== null) 返回 false; if (Symbol.iterator in value) 返回 false; if（值中的Symbol.toStringTag） return Object.prototype.toString.call(value) === "[object Module]"; 返回真； } ### MaybeArray + callHooks (10 行) 类型 MaybeArray = T | T[]；类型 MaybePromise = T |承诺；异步函数 callHooks( 上下文：C，钩子： MaybeArray<(ctx: C) => MaybePromise> |未定义， ): 承诺 { if (!hooks) 返回； for (Array.isArray(hooks) 的 const hook ? hooks : [hooks]) { 等待钩子（上下文）； } } ###规范化WindowsPath（7行） const DRIVE_RE = /^[A-Za-z]:\//; 函数标准化WindowsPath（输入=“”）{ if (!input) 返回输入；返回输入 .replace(/\\/g, "/") .replace(DRIVE_RE, (r) => r.toUpperCase()); } ## 快速参考需要|图案|参考 ---|---|--- CLI 参数解析 | `node:util.parseArgs` \+ 类型化层 | [cli-patterns.md]() 彩色终端输出|上面的 ANSI 助手 |上面内联具有重试功能的 HTTP 客户端 |获取工厂+拦截器| [fetch-patterns.md]() 带级别/记者的记录器 |单一方法报告者界面| [logging-patterns.md]() 深度对象合并 |默认优先递归合并 | [data-utils.md]() 字符串大小写转换| `splitByCase` \+ 连接变体 | [data-utils.md]() 类型安全定义 | `const` 泛型 + 条件类型 | [typescript-tricks.md]() 延迟加载 | `Resolvable` \+ 动态导入 |上面内联跨平台路径|每个条目处的“normalizeWindowsPath” | [data-utils.md]() ## 要避免的反模式 * **不要**使用 chalk/picocolors 作为颜色——22 行 ANSI 代码就足够了 * **不要**使用 Commander/yargs -- `node:util.parseArgs` 满足 95% 的 CLI 需求 * **不要**使用 axios -- 原生获取 + 薄包装器处理重试、拦截器、自动解析 * **不要**将 lodash 用于一个函数——内联您需要的 10-40 行 * **不要**使用类层次结构进行配置——带有闭包的工厂函数更简单 * **不要**添加未请求的“灵活性”或“可配置性” * **不要**对一次性代码进行抽象 * **不要**从桶文件中导出应该是内部的东西 - 使用 `_` 前缀约定

精益 T 模式

包含技能