This commit is contained in:
@@ -1,47 +1,47 @@
|
||||
# tsl-devkit 项目简介
|
||||
|
||||
<!--
|
||||
填写指南:
|
||||
- 【必填】:项目启动前必须填写
|
||||
- 【可选】:按需填写,可随项目发展补充
|
||||
- 未填写的占位符保持原样或删除整行
|
||||
-->
|
||||
|
||||
## 项目定位
|
||||
|
||||
<!-- 【必填】 -->
|
||||
**核心目标**:为 TSL (TinySoft Language) 提供完整的 IDE 开发体验
|
||||
|
||||
**核心目标**:{{PROJECT_GOAL}}
|
||||
|
||||
**一句话描述**:{{PROJECT_DESCRIPTION}}
|
||||
**一句话描述**:基于 LSP 标准的 TSL 语言服务器及编辑器扩展套件
|
||||
|
||||
## 项目边界
|
||||
|
||||
<!-- 【必填】至少填写"做什么" -->
|
||||
|
||||
### 做什么
|
||||
|
||||
- {{DO_1}}
|
||||
- 实现 LSP (Language Server Protocol) 服务器,提供标准语言服务
|
||||
- 提供 VSCode 扩展,集成语法高亮、代码补全、诊断等功能
|
||||
- 提供 Vim 语法支持
|
||||
- 支持跨平台运行 (Linux / Windows)
|
||||
|
||||
### 不做什么
|
||||
|
||||
<!-- 【可选】 -->
|
||||
|
||||
- {{DONT_1}}
|
||||
- 不实现 TSL 语言的编译器/解释器
|
||||
- 不实现 TSL 语言的运行时环境
|
||||
- 不提供 TSL 语言的调试功能 (Debugger)
|
||||
|
||||
### 约束条件
|
||||
|
||||
<!-- 【可选】 -->
|
||||
|
||||
- {{CONSTRAINT_1}}
|
||||
- 必须遵循 LSP 3.17+ 协议标准
|
||||
- LSP 服务器必须支持增量解析以保证响应性能
|
||||
- 必须同时支持 Linux 和 Windows 平台
|
||||
|
||||
## 核心概念
|
||||
|
||||
<!-- 【可选】项目特有的术语或概念 -->
|
||||
| 术语 | 说明 |
|
||||
| --------------- | ------------------------------------------------ |
|
||||
| **TSL** | TinySoft Language,天软公司的领域特定脚本语言 |
|
||||
| **LSP** | Language Server Protocol,微软定义的语言服务协议 |
|
||||
| **Tree-sitter** | 增量解析框架,用于构建语法树 |
|
||||
| **Provider** | LSP 功能提供者,处理特定类型的请求 |
|
||||
| **Manager** | 管理器,负责文档、符号、解析等核心状态管理 |
|
||||
|
||||
## 参考资料
|
||||
|
||||
<!-- 【可选】 -->
|
||||
- [LSP 规范](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/)
|
||||
- [Tree-sitter 文档](https://tree-sitter.github.io/tree-sitter/)
|
||||
- [VSCode 扩展 API](https://code.visualstudio.com/api)
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user