@easbot/codebase 0.1.11

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 houjallen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.en.md

@@ -0,0 +1,187 @@
+# @easbot/codebase
+
+Code Knowledge Graph SDK - A code indexing and querying system based on the Property Graph model
+
+## Features
+
+- **Property Graph Model**: Store code entities and their relationships using nodes and edges
+- **Multi-language Support**: TypeScript, JavaScript, Python, Rust, Go, C/C++, C#, Java, Scala, Ruby, PHP, Zig
+- **Hybrid Search**: FTS full-text search + structured queries
+- **Incremental Updates**: Smart incremental indexing based on file content hashes
+- **Tree-sitter Parsing**: High-performance AST parsing
+
+## Installation
+
+```bash
+pnpm add @easbot/codebase
+```
+
+## Quick Start
+
+```typescript
+import { createCodebase } from '@easbot/codebase';
+
+// Create graph instance
+const graph = await createCodebase({
+  workspaceDir: '/path/to/your/project',
+});
+
+// Index project
+const result = await graph.indexDirectory();
+console.log(`Indexed: ${result.filesProcessed} files, ${result.nodesCreated} nodes`);
+
+// Search code
+const results = await graph.search('UserService');
+for (const r of results) {
+  console.log(`${r.name} (${r.astType}) - ${r.filePath}:${r.startLine}`);
+}
+
+// Query nodes
+const classes = await graph.queryNodes({ astType: 'class_declaration' });
+
+// Query call graph
+const callGraph = await graph.queryCallGraph('ts:src/service.ts:function_declaration:UserService');
+
+// Close graph
+await graph.close();
+```
+
+## API Documentation
+
+### CodeKnowledgeGraph
+
+Main class providing complete code knowledge graph functionality.
+
+#### Constructor Options
+
+```typescript
+interface CodeKnowledgeGraphConfig {
+  workspaceDir: string;           // Workspace directory
+  database?: {
+    path: string;                 // Database path
+    walMode?: boolean;            // WAL mode
+  };
+  parser?: {
+    languages?: Language[];       // Supported languages
+    lazyLoad?: boolean;           // Lazy loading
+  };
+  indexer?: {
+    batchSize: number;            // Batch size
+    ignorePatterns: string[];     // Ignore patterns
+    incremental: boolean;         // Incremental updates
+  };
+}
+```
+
+#### Main Methods
+
+| Method | Description |
+|--------|-------------|
+| `initialize()` | Initialize graph |
+| `indexFile(path)` | Index single file |
+| `indexDirectory(dir?)` | Index directory |
+| `sync()` | Incremental sync |
+| `search(query, options?)` | Hybrid search |
+| `queryNodes(filter)` | Query nodes |
+| `queryEdges(filter)` | Query edges |
+| `queryNeighbors(nodeId, options?)` | Query neighbors |
+| `queryCallGraph(nodeId, depth?)` | Query call graph |
+| `queryInheritance(nodeId)` | Query inheritance |
+| `getStatus()` | Get status |
+| `healthCheck()` | Health check |
+| `close()` | Close graph |
+
+### Search Options
+
+```typescript
+interface SearchOptions {
+  maxResults?: number;            // Max results
+  minScore?: number;              // Min score
+  language?: Language;            // Language filter
+  filePath?: string;              // File path filter
+  astType?: string;               // AST type filter
+  enableFts?: boolean;            // Enable FTS
+  ftsWeight?: number;             // FTS weight
+}
+```
+
+## Data Model
+
+### Node
+
+| Field | Type | Description |
+|-------|------|-------------|
+| id | string | Unique identifier |
+| name | string | Name |
+| ast_type | string | AST type |
+| language | string | Language |
+| file_path | string | File path |
+| start_line | number | Start line |
+| start_col | number | Start column |
+| end_line | number | End line |
+| end_col | number | End column |
+| text | string | Code text |
+
+### Edge
+
+| Field | Type | Description |
+|-------|------|-------------|
+| id | string | Unique identifier |
+| source | string | Source node ID |
+| target | string | Target node ID |
+| relation | string | Relation type |
+
+### Relation Types
+
+| Relation | Description |
+|----------|-------------|
+| CONTAINS | Parent-child AST relationship |
+| CALLS | Function call relationship |
+| INHERITS_FROM | Class inheritance |
+| IMPLEMENTS | Interface implementation |
+| IMPORTS | Module import |
+| REFERENCES | Variable/identifier reference |
+
+## Architecture
+
+```
+src/
+├── types.ts              # Type definitions
+├── errors.ts             # Error classes
+├── index.ts              # Entry file
+├── code-knowledge-graph.ts  # Main class
+├── database/
+│   └── database-manager.ts  # Database management
+├── parser/
+│   └── parser-manager.ts    # Parser management
+├── extractor/
+│   ├── node-extractor.ts    # Node extraction
+│   └── edge-extractor.ts    # Edge extraction
+├── indexer/
+│   └── indexer.ts           # Indexer
+└── query/
+    └── query-interface.ts   # Query interface
+```
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build
+pnpm build
+
+# Test
+pnpm test
+
+# Type check
+pnpm type-check
+
+# Lint
+pnpm lint
+```
+
+## License
+
+MIT

package/README.md

@@ -0,0 +1,187 @@
+# @easbot/codebase
+
+代码知识图谱 SDK - 基于 Property Graph 模型的代码索引与查询系统
+
+## 特性
+
+- **Property Graph 模型**: 使用节点和边存储代码实体及其关系
+- **多语言支持**: TypeScript、JavaScript、Python、Rust、Go、C/C++、C#、Java、Scala、Ruby、PHP、Zig
+- **混合搜索**: FTS 全文搜索 + 结构化查询
+- **增量更新**: 基于文件内容哈希的智能增量索引
+- **Tree-sitter 解析**: 高性能 AST 解析
+
+## 安装
+
+```bash
+pnpm add @easbot/codebase
+```
+
+## 快速开始
+
+```typescript
+import { createCodebase } from '@easbot/codebase';
+
+// 创建图谱实例
+const graph = await createCodebase({
+  workspaceDir: '/path/to/your/project',
+});
+
+// 索引项目
+const result = await graph.indexDirectory();
+console.log(`索引完成: ${result.filesProcessed} 文件, ${result.nodesCreated} 节点`);
+
+// 搜索代码
+const results = await graph.search('UserService');
+for (const r of results) {
+  console.log(`${r.name} (${r.astType}) - ${r.filePath}:${r.startLine}`);
+}
+
+// 查询节点
+const classes = await graph.queryNodes({ astType: 'class_declaration' });
+
+// 查询调用图
+const callGraph = await graph.queryCallGraph('ts:src/service.ts:function_declaration:UserService');
+
+// 关闭图谱
+await graph.close();
+```
+
+## API 文档
+
+### CodeKnowledgeGraph
+
+主类，提供完整的代码知识图谱功能。
+
+#### 构造选项
+
+```typescript
+interface CodeKnowledgeGraphConfig {
+  workspaceDir: string;           // 工作区目录
+  database?: {
+    path: string;                 // 数据库路径
+    walMode?: boolean;            // WAL 模式
+  };
+  parser?: {
+    languages?: Language[];       // 支持的语言
+    lazyLoad?: boolean;           // 延迟加载
+  };
+  indexer?: {
+    batchSize: number;            // 批处理大小
+    ignorePatterns: string[];     // 忽略模式
+    incremental: boolean;         // 增量更新
+  };
+}
+```
+
+#### 主要方法
+
+| 方法 | 说明 |
+|------|------|
+| `initialize()` | 初始化图谱 |
+| `indexFile(path)` | 索引单个文件 |
+| `indexDirectory(dir?)` | 索引目录 |
+| `sync()` | 增量同步 |
+| `search(query, options?)` | 混合搜索 |
+| `queryNodes(filter)` | 查询节点 |
+| `queryEdges(filter)` | 查询边 |
+| `queryNeighbors(nodeId, options?)` | 查询邻居 |
+| `queryCallGraph(nodeId, depth?)` | 查询调用图 |
+| `queryInheritance(nodeId)` | 查询继承关系 |
+| `getStatus()` | 获取状态 |
+| `healthCheck()` | 健康检查 |
+| `close()` | 关闭图谱 |
+
+### 搜索选项
+
+```typescript
+interface SearchOptions {
+  maxResults?: number;            // 最大结果数
+  minScore?: number;              // 最小分数
+  language?: Language;            // 语言过滤
+  filePath?: string;              // 文件路径过滤
+  astType?: string;               // AST 类型过滤
+  enableFts?: boolean;            // 启用 FTS
+  ftsWeight?: number;             // FTS 权重
+}
+```
+
+## 数据模型
+
+### 节点 (Node)
+
+| 字段 | 类型 | 说明 |
+|------|------|------|
+| id | string | 唯一标识 |
+| name | string | 名称 |
+| ast_type | string | AST 类型 |
+| language | string | 语言 |
+| file_path | string | 文件路径 |
+| start_line | number | 起始行 |
+| start_col | number | 起始列 |
+| end_line | number | 结束行 |
+| end_col | number | 结束列 |
+| text | string | 代码文本 |
+
+### 边 (Edge)
+
+| 字段 | 类型 | 说明 |
+|------|------|------|
+| id | string | 唯一标识 |
+| source | string | 源节点 ID |
+| target | string | 目标节点 ID |
+| relation | string | 关系类型 |
+
+### 关系类型
+
+| 关系 | 说明 |
+|------|------|
+| CONTAINS | 包含关系（类包含方法） |
+| CALLS | 调用关系（函数调用） |
+| INHERITS_FROM | 继承关系 |
+| IMPLEMENTS | 实现接口 |
+| IMPORTS | 导入模块 |
+| REFERENCES | 引用关系 |
+
+## 架构
+
+```
+src/
+├── types.ts              # 类型定义
+├── errors.ts             # 错误类
+├── index.ts              # 入口文件
+├── code-knowledge-graph.ts  # 主类
+├── database/
+│   └── database-manager.ts  # 数据库管理
+├── parser/
+│   └── parser-manager.ts    # 解析器管理
+├── extractor/
+│   ├── node-extractor.ts    # 节点提取
+│   └── edge-extractor.ts    # 边提取
+├── indexer/
+│   └── indexer.ts           # 索引器
+└── query/
+    └── query-interface.ts   # 查询接口
+```
+
+## 开发
+
+```bash
+# 安装依赖
+pnpm install
+
+# 构建
+pnpm build
+
+# 测试
+pnpm test
+
+# 类型检查
+pnpm type-check
+
+# 代码检查
+pnpm lint
+```
+
+## 许可证
+
+MIT