# @demlik/code-graph 中文文档

规范地址：https://npmcn.com/package/%40demlik/code-graph/

版本：0\.17\.0
npm 元数据更新时间：2026-11-11T17:22:14.922Z
中文译文更新时间：2026-11-11T22:07:30.126Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40demlik/code-graph
原文对照：https://npmcn.com/package/%40demlik/code-graph/?lang=original
项目主页：https://github.com/kamp-us/demlik/tree/main/packages/code-graph
源码仓库：https://github.com/kamp-us/demlik

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：2 MB，33 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：10 个
- 首次发布：2026-09-24T06:32:53.997Z
- 最新版本发布：2026-11-11T17:22:14.493Z
- 近 30 天下载量：38839（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 20 个）

## 中文简介

代理本土 TypeScript 代码图 + smell CLI : 剖析一个有oxc的文件夹,用tsgo解析它,测量每个函数,旗帜气味,并将重构目标排为决定性的JSON.

## 安装

```sh
npm install @demlik/code-graph
```

也可以使用：`pnpm add @demlik/code-graph`、`yarn add @demlik/code-graph`、`bun add @demlik/code-graph`

## README

# @ demlik/ 代码图

扫描 TypeScript 以找到重构目标,跟踪呼叫,并检查架构规则. 默认扫描测量功能并报告可能的维护问题. 可选 报告涵盖可达到性、存储访问、重复逻辑、评论和git热点.

## 召集

要求节点.js 20或更晚. 在您想要分析的工程中安装 :

```sh
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 参考](https://npmcn.com/package/%40demlik/code-graph/docs/reference/cli.md) 列出每个旗帜、范围规则和退出代码.

## 文档

开始于 [文档索引](https://npmcn.com/package/%40demlik/code-graph/docs/README.md),或直接转到:

-   **如何进行 :** [强制建筑界限](https://npmcn.com/package/%40demlik/code-graph/docs/how-to/enforce-boundaries.md)。 。 。 .
-   **参考:** [国 际](https://npmcn.com/package/%40demlik/code-graph/docs/reference/cli.md), (中文(简体) ), [分析](https://npmcn.com/package/%40demlik/code-graph/docs/reference/analyses.md), (中文(简体) ), [层](https://npmcn.com/package/%40demlik/code-graph/docs/reference/layers.md), (中文(简体) ), [边框](https://npmcn.com/package/%40demlik/code-graph/docs/reference/boundaries.md), (中文(简体) ), 财务报告和审定财务报表 [库 API](https://npmcn.com/package/%40demlik/code-graph/docs/reference/library.md)。 。 。 .
-   **解释:** [如何分析](https://npmcn.com/package/%40demlik/code-graph/docs/explanation/how-analysis-works.md),包括: 报告能够和不能证明什么.

## 参加这次结账

从单列波根:

```sh
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 。 运行 : 软件包目录。 见 [范围规则](https://npmcn.com/package/%40demlik/code-graph/docs/reference/cli.md#pass-selection-and-scope) 用于其他寄存器布局.

要直接运行源, 不构建:

```sh
pnpm --filter @demlik/code-graph exec node --import tsx src/index.ts src --plan
```

这个命令运行在软件包内部,所以其路径是软件包相对的.

运行软件包检查 :

```sh
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
```

[基准调查结果](https://npmcn.com/package/%40demlik/code-graph/bench/FINDINGS.md) 记录引擎测量和复制命令.

## 常见问题

### @demlik/code-graph 是什么？

代理本土 TypeScript 代码图 \+ smell CLI : 剖析一个有oxc的文件夹,用tsgo解析它,测量每个函数,旗帜气味,并将重构目标排为决定性的JSON\.

### 如何安装 @demlik/code-graph？

在项目目录运行 npm install @demlik/code-graph，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 code-graph，可以用 npx code-graph 直接运行。

### @demlik/code-graph 支持 TypeScript 吗？

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

### @demlik/code-graph 支持 ESM 还是 CommonJS？

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

### @demlik/code-graph 需要什么版本的 Node\.js？

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

### @demlik/code-graph 可以商用吗？

@demlik/code-graph 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @demlik/code-graph 的下载量有多少？

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

### @demlik/code-graph 还在维护吗？

最新版本 0\.17\.0 发布于 2026/11/12（今天）；至今共发布 20 个版本，其中过去 12 个月发布了 20 个；首次发布于 2026/09/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。