tsl-devkit/vscode/README.md

81 lines
2.3 KiB
Markdown

# TSL Tools for VSCode
<p align="left">
<strong>强大的 TSL 语言开发工具集</strong><br>
为 VSCode 提供完整的 TSL 语言支持
</p>
## ✨ 功能特性
- 🎨 **语法高亮** - 基于 TextMate 语法的智能代码着色
- 🔧 **语言服务器协议 (LSP)** - 提供智能代码补全、错误检查、跳转定义等功能
- 📝 **代码片段 (Snippets)** - 快速插入常用代码模板
## 📦 安装方式
### 方式一:通过 VSIX 文件安装(推荐)
直接使用预编译的扩展包:
```bash
# 命令行安装
code --install-extension tsl-tools-3.0.0.vsix
```
或者在 VSCode 中:
1. 打开命令面板 (`Ctrl+Shift+P` / `Cmd+Shift+P`)
2. 输入 `Install from VSIX`
3. 选择 `tsl-tools-3.0.0.vsix` 文件
### 方式二:从源码构建
```bash
# 克隆仓库
git clone https://git.mytsl.cn/csh/tsl-devkit.git
cd tsl-devkit
# 安装依赖
npm install
# 打包扩展
npx vsce package
# 安装生成的 VSIX 文件
code --install-extension tsl-tools-3.0.0.vsix
```
### 方式三:手动安装
将扩展文件夹复制到 VSCode 扩展目录:
| 操作系统 | 扩展目录路径 |
| -------- | ---------------------------------- |
| Windows | `%USERPROFILE%\.vscode\extensions` |
| macOS | `~/.vscode/extensions` |
| Linux | `~/.vscode/extensions` |
## ⚙️ 配置选项
在 VSCode 设置中配置 TSL 扩展:
### 语言服务器配置
| 配置项 | 类型 | 默认值 | 描述 |
| --- | --- | --- | --- |
| `tsl.server.executable` | `string` | `""` | TSL 语言服务器可执行文件路径<br>_留空自动检测_ |
| `tsl.server.arguments` | `string[]` | `["--log=trace", "--log-stderr"]` | 语言服务器启动参数<br>_使用 `./tsl-server --help` 查看所有选项_ |
| `tsl.interpreter.executable` | `string` | `""` | TSL 解释器路径<br>_用于识别 funcext 下的 .tsf 文件_ |
### 配置示例
```json
{
"tsl.server.executable": "/usr/local/bin/tsl-server",
"tsl.server.arguments": ["--log=info", "--log-stderr"],
"tsl.interpreter.executable": "/usr/local/bin/tsl"
}
```
> ⚠️ **注意**: `tsl.interpreter.executable` 与服务器参数 `--interpreter=PATH` 冲突,请只使用其中一个