@ demlik/ 代码图
扫描 TypeScript 以找到重构目标,跟踪呼叫,并检查架构规则. 默认扫描测量功能并报告可能的维护问题. 可选 报告涵盖可达到性、存储访问、重复逻辑、评论和git热点.
召集
要求节点.js 20或更晚. 在您想要分析的工程中安装 :
pnpm add -D @demlik/code-graph
pnpm exec code-graph src
pnpm exec code-graph src --plan
路径必须是目录 。 路径相对于您运行命令的位置 .
选择您需要的报告; 这些示例使用 code-graph 简称为
pnpm exec code-graph数字 :
| 目标 | 命令 |
|---|---|
| 等级调整目标 | code-graph src --plan |
| 浏览文件和函数 | code-graph src --tree |
| 检查一个功能的 Ports & 适配器 | code-graph src/orders --hexagon |
| 看看谁拥有一张桌子,谁伸入这张桌子 | code-graph . --owners --boundary-rules boundary-rules.json |
| 检查一个函数的呼叫者 | code-graph src --blast example.ts:calculate |
| 找一个名字:它在哪里申报,是否出口,谁使用 | code-graph src --find Order |
| 保存调用图表 | code-graph src --graph --edges --out graph.json |
| 浏览 HTML 报表 | code-graph src --html --out report.html |
| 查找无法到达的函数 | code-graph src --unreachable |
| 检查架构边界 | code-graph . --boundaries |
| 寻找复杂多变的热点 | code-graph src --hotspots |
默认扫描使用oxc并不需要 tsconfig. 书法报告使用tsgo并需要
无障碍 tsconfig.json。扫描文件的路径控制; --deep
更改 tsconfig 的位置,而不在扫描中添加文件.
使用 --json 可读报告 --out <file> 拯救他们.
这个 CLI 参考 列出每个旗帜、范围规则和退出代码.
文档
开始于 文档索引,或直接转到:
- 如何进行 : 强制建筑界限。 。 。 .
- 参考: 国 际, (中文(简体) ), 分析, (中文(简体) ), 层, (中文(简体) ), 边框, (中文(简体) ), 财务报告和审定财务报表 库 API。 。 。 .
- 解释: 如何分析,包括: 报告能够和不能证明什么.
参加这次结账
从单列波根:
pnpm --filter @demlik/code-graph build
node packages/code-graph/dist/index.js packages/code-graph/src --plan
node packages/code-graph/dist/index.js packages/code-graph --graph --edges --out graph.json
node packages/code-graph/dist/index.js packages/code-graph --html --out report.html
此寄存器有 tsconfigs 包而无 root tsconfig 。 运行 : 软件包目录。 见 范围规则 用于其他寄存器布局.
要直接运行源, 不构建:
pnpm --filter @demlik/code-graph exec node --import tsx src/index.ts src --plan
这个命令运行在软件包内部,所以其路径是软件包相对的.
运行软件包检查 :
pnpm --filter @demlik/code-graph typecheck
pnpm --filter @demlik/code-graph lint
pnpm --filter @demlik/code-graph test
pnpm --filter @demlik/code-graph build
pnpm --filter @demlik/code-graph verify:exports
基准调查结果 记录引擎测量和复制命令.