# codemap

**Repository Path**: jerryzu/codemap

## Basic Information

- **Project Name**: codemap
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-06
- **Last Updated**: 2026-05-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Codemap - 通用代码知识图谱 CLI

通用代码知识图谱 CLI，用于索引 TypeScript/JavaScript 项目并查询符号和调用链。

## 特性

- **跨文件符号解析**: 两阶段解析 + 分层消解算法，支持跨文件调用关系解析
- **调用链追踪**: 支持深度优先的调用链追踪
- **树形/JSON 输出**: 适合人类阅读或 AI 处理

## 安装

```bash
npm install
npm run build
```

## 快速开始

```bash
# 索引项目（生成 .codemap/codemap.db）
node dist/cli.js analyze /path/to/project

# 追踪符号 + 调用链
node dist/cli.js trace "submitExam" --database "/path/to/project/.codemap/codemap.db"

# 输出示例：
# └─ Function: submitExam(D:\app\server\controllers\examController.js)
#    ├─ Function: saveDatabase(D:\app\server\config\database.js)
#    │  └─ Function: isMySQL(D:\app\server\db\dialect.js)
#    ├─ Function: getDb(D:\app\server\config\database.js)
#    └─ Symbol: json
```

## 支持的语言

| 语言      | 状态 | 说明                         |
|-----------|------|------------------------------|
| TypeScript | ✅   | 通过 tree-sitter-typescript WASM 完全支持 |
| JavaScript | ✅   | 用 TypeScript 语法解析（TS 是 JS 的超集） |
| Python    | ❌   | 未实现（未安装语法分析器）     |
| Vue       | ⚠️   | 部分支持 - `<script>` 块提取已实现 |

## 架构

- **解析器**: tree-sitter 0.21.x + tree-sitter-typescript 0.23.2 (WASM)
- **数据库**: sql.js (SQLite WASM)
- **CLI**: Commander.js

### 跨文件符号解析

两阶段解析实现跨文件调用关系解析：

**Phase 1**: 解析所有文件，收集符号定义和 import 语句
**Phase 2**: 构建 DefinitionIndex，通过分层消解算法解析调用关系

分层算法：
| Tier | 查找范围 | 优先级 |
|------|---------|--------|
| 1 | 同文件查找 | 最高 |
| 2 | Import 链追踪 | 中 |
| 3 | 全局模糊匹配 | 最低 |

## 命令

### analyze
索引代码库并构建知识图谱。

```bash
node dist/cli.js analyze [path] [options]
```

选项：
- `--database <path>` - 数据库输出路径（默认：.codemap/codemap.db）
- `-v, --verbose` - 详细输出

### query
按名称搜索符号。

```bash
node dist/cli.js query <search> [options]
```

选项：
- `-l, --limit <n>` - 最大结果数（默认：10）
- `--database <path>` - 数据库路径（默认：.codemap/codemap.db）
- `--json` - JSON 格式输出

### trace
一次性显示符号信息 + 调用链（树形缩进或 JSON）。

```bash
node dist/cli.js trace <symbol> [options]
```

选项：
- `-d, --depth <n>` - 最大深度（默认：3）
- `--database <path>` - 数据库路径（默认：.codemap/codemap.db）
- `-j, --json` - JSON 格式输出

### trace-all
显示所有匹配符号及其调用链。

```bash
node dist/cli.js trace-all <search> [options]
```

选项：
- `-d, --depth <n>` - 最大深度（默认：2）
- `--database <path>` - 数据库路径（默认：.codemap/codemap.db）
- `-j, --json` - JSON 格式输出