|
| 1 | +# TypeScriptParser |
| 2 | + |
| 3 | +基于Tree-sitter的TypeScript解析器.NET绑定库，提供高性能的TypeScript代码解析功能。 |
| 4 | + |
| 5 | +## 安装 |
| 6 | + |
| 7 | +```bash |
| 8 | +dotnet add package TypeScriptParser |
| 9 | +``` |
| 10 | + |
| 11 | +## 快速开始 |
| 12 | + |
| 13 | +```csharp |
| 14 | +using System; |
| 15 | +using TreeSitter.TypeScript; |
| 16 | +using GitHub.TreeSitter; |
| 17 | + |
| 18 | +// 创建解析器实例 |
| 19 | +using var parser = new TypeScriptParser(); |
| 20 | + |
| 21 | +// 解析TypeScript代码 |
| 22 | +string code = @" |
| 23 | +function greet(name: string): string { |
| 24 | + return `Hello, ${name}!`; |
| 25 | +} |
| 26 | +"; |
| 27 | + |
| 28 | +using var tree = parser.ParseString(code); |
| 29 | +var rootNode = tree.root_node(); |
| 30 | + |
| 31 | +// 遍历语法树 |
| 32 | +Console.WriteLine($"语法树类型: {rootNode.type()}"); |
| 33 | +Console.WriteLine($"子节点数量: {rootNode.child_count()}"); |
| 34 | + |
| 35 | +// 获取源码文本 |
| 36 | +Console.WriteLine($"源码内容: {rootNode.text(code)}"); |
| 37 | +``` |
| 38 | + |
| 39 | +## 主要功能 |
| 40 | + |
| 41 | +- ✅ 完整的TypeScript语法支持 |
| 42 | +- ✅ 高性能的增量解析 |
| 43 | +- ✅ 跨平台支持 (Windows, Linux, macOS) |
| 44 | +- ✅ 详细的语法错误信息 |
| 45 | +- ✅ 语法树遍历和查询 |
| 46 | + |
| 47 | +## API 参考 |
| 48 | + |
| 49 | +### TypeScriptParser 类 |
| 50 | + |
| 51 | +位于 `TreeSitter.TypeScript` 命名空间。 |
| 52 | + |
| 53 | +#### 构造函数 |
| 54 | +```csharp |
| 55 | +var parser = new TypeScriptParser(); |
| 56 | +``` |
| 57 | + |
| 58 | +#### 主要方法 |
| 59 | + |
| 60 | +**ParseString(string sourceCode)** |
| 61 | +- 解析TypeScript源代码字符串 |
| 62 | +- 返回: `TSTree` - 解析后的语法树 |
| 63 | + |
| 64 | +```csharp |
| 65 | +var tree = parser.ParseString("const x = 42;"); |
| 66 | +``` |
| 67 | + |
| 68 | +**CreateCursor(TSTree tree)** |
| 69 | +- 创建语法树游标用于高效遍历 |
| 70 | +- 返回: `TSCursor` - 语法树游标对象 |
| 71 | + |
| 72 | +```csharp |
| 73 | +using var cursor = parser.CreateCursor(tree); |
| 74 | +``` |
| 75 | + |
| 76 | +#### 属性 |
| 77 | + |
| 78 | +**Language** |
| 79 | +- 获取TypeScript语言对象 |
| 80 | +- 类型: `TSLanguage` |
| 81 | + |
| 82 | +**IsAvailable** |
| 83 | +- 检查解析器是否可用 |
| 84 | +- 类型: `bool` |
| 85 | + |
| 86 | +### TSTree 类 (来自 GitHub.TreeSitter) |
| 87 | + |
| 88 | +**主要方法:** |
| 89 | +- `root_node()` - 获取根节点 |
| 90 | +- `copy()` - 复制语法树 |
| 91 | +- `edit(TSInputEdit edit)` - 编辑语法树 |
| 92 | + |
| 93 | +### TSNode 结构 (来自 GitHub.TreeSitter) |
| 94 | + |
| 95 | +**主要方法:** |
| 96 | +- `type()` - 获取节点类型名称 |
| 97 | +- `child_count()` - 获取子节点数量 |
| 98 | +- `child(uint index)` - 获取指定索引的子节点 |
| 99 | +- `start_point()` / `end_point()` - 获取节点位置 |
| 100 | +- `text(string sourceCode)` - 获取节点对应的源码文本 |
| 101 | + |
| 102 | +## 语法树遍历示例 |
| 103 | + |
| 104 | +```csharp |
| 105 | +using var parser = new TypeScriptParser(); |
| 106 | +var tree = parser.ParseString(@" |
| 107 | +class Calculator { |
| 108 | + add(a: number, b: number): number { |
| 109 | + return a + b; |
| 110 | + } |
| 111 | +} |
| 112 | +"); |
| 113 | + |
| 114 | +var root = tree.root_node(); |
| 115 | + |
| 116 | +// 递归遍历所有节点 |
| 117 | +void TraverseNode(TSNode node, string source, int depth = 0) |
| 118 | +{ |
| 119 | + var indent = new string(' ', depth * 2); |
| 120 | + Console.WriteLine($"{indent}{node.type()}: {node.text(source)}"); |
| 121 | + |
| 122 | + for (uint i = 0; i < node.child_count(); i++) |
| 123 | + { |
| 124 | + TraverseNode(node.child(i), source, depth + 1); |
| 125 | + } |
| 126 | +} |
| 127 | + |
| 128 | +TraverseNode(root, code); |
| 129 | +``` |
| 130 | + |
| 131 | +## 错误处理 |
| 132 | + |
| 133 | +```csharp |
| 134 | +using var parser = new TypeScriptParser(); |
| 135 | +var tree = parser.ParseString("const x = ;"); // 语法错误 |
| 136 | +
|
| 137 | +var root = tree.root_node(); |
| 138 | +if (root.has_error()) |
| 139 | +{ |
| 140 | + Console.WriteLine("语法树包含错误"); |
| 141 | +} |
| 142 | +``` |
| 143 | + |
| 144 | +## 系统要求 |
| 145 | + |
| 146 | +- .NET 9.0 或更高版本 |
| 147 | +- 支持的平台：Windows (x64), Linux (x64), macOS (ARM64/x64) |
| 148 | + |
| 149 | +## 相关包 |
| 150 | + |
| 151 | +- `TypeScriptParser.Native` - 包含跨平台原生库的运行时包 |
| 152 | + |
| 153 | +## 许可证 |
| 154 | + |
| 155 | +本项目基于MIT许可证开源。 |
0 commit comments