@forge-ts/enforcer
TSDoc enforcement build gate for the forge-ts toolchain.
When to use this package
Most users should install @forge-ts/cli instead and use npx forge-ts check. This package is for programmatic use in custom build pipelines.
npm install @forge-ts/enforcer
What it checks
| Code | Severity | Rule |
|---|
| E001 | error | Exported symbol missing TSDoc summary |
| E002 | error | Function parameter missing @param tag |
| E003 | error | Non-void function missing @returns tag |
| W001 | warning | TSDoc comment has parse errors |
| W002 | warning | Function throws but missing @throws tag |
| W003 | warning | @deprecated without explanation |
Example
import { loadConfig } from "@forge-ts/core";
import { enforce, formatResults } from "@forge-ts/enforcer";
const config = await loadConfig();
const result = await enforce(config);
console.log(formatResults(result, { colors: true, verbose: false }));
process.exit(result.success ? 0 : 1);
Part of forge-ts
See the main repo for full documentation.
License
MIT
关于 @forge-ts/enforcer 的常见问题
@forge-ts/enforcer 是什么？
TSDoc enforcement linter for forge-ts
如何安装 @forge-ts/enforcer？
在项目目录运行 npm install @forge-ts/enforcer，或使用 pnpm add / yarn add / bun add。
@forge-ts/enforcer 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@forge-ts/enforcer 支持 ESM 还是 CommonJS？
以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module，更早的版本需要改用动态 import()。
@forge-ts/enforcer 需要什么版本的 Node.js？
package.json 的 engines 字段要求 Node.js >=22.0.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。
@forge-ts/enforcer 可以商用吗？
@forge-ts/enforcer 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@forge-ts/enforcer 的下载量有多少？
根据 npm 官方下载统计，@forge-ts/enforcer 在 2026/10/16 – 2026/11/14 这 30 天内被下载 11,451 次，日均约 382 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@forge-ts/enforcer 还在维护吗？
最新版本 0.24.0 发布于 2026/04/14（7 个月前）；至今共发布 35 个版本，其中过去 12 个月发布了 35 个；首次发布于 2026/03/19。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。