Thrift Support for VSCode
English | 中文
一个为 VSCode 提供 Apache Thrift 文件完整支持的扩展，包含语法高亮、代码格式化和导航功能。
开发者请阅读开发指南：见仓库根目录的 DEVELOPMENT.md。
🚀 功能特性
语法高亮
- 完整的 Thrift 语法支持，包括关键字、数据类型、字符串、注释和数字字面量
- 支持所有 Thrift 原生类型（包含 uuid）和容器类型
- 智能的语法着色，提升代码可读性
代码格式化
- 文档格式化：一键格式化整个 Thrift 文件
- 选择格式化：格式化选中的代码块
- 智能对齐：自动对齐字段类型、字段名和注释
- 可配置选项：支持自定义缩进、行长度等格式化规则
代码导航
- 跳转到定义：快速导航到类型定义
- 包含文件解析：支持跟踪
include 语句
- 工作区搜索：在整个工作区中查找定义
代码重构
- 标识符重命名（F2）：跨文件更新引用，内置冲突检测
- 抽取类型（typedef）：从选区或当前字段推断类型并生成
typedef
- 移动类型到文件：将
struct/enum/service/typedef 等移动到新的 .thrift 文件并自动插入 include
📦 安装
- 打开 VSCode
- 进入扩展市场 (
Ctrl+Shift+X)
- 搜索 "Thrift Support"
- 点击安装
🔧 使用方法
格式化代码
- 格式化文档：
Ctrl+Shift+I (Windows/Linux) 或 Cmd+Shift+I (Mac)
- 格式化选择：选中代码后使用
Ctrl+K Ctrl+F (Windows/Linux) 或 Cmd+K Cmd+F (Mac)
- 命令面板：
Thrift: Format DocumentThrift: Format Selection
发布命名空间：tanzz（VS Marketplace 与 Open VSX 均使用此命名空间）
代码导航
- 跳转到定义：
F12 或 Ctrl+点击 类型名
- 查看定义：
Alt+F12
代码诊断
- 语法括号配对与未闭合检查（syntax.unmatchedCloser / syntax.unclosed）
- 类型校验：未知类型与 typedef 基类（type.unknown / typedef.unknownBase）
- 容器内部类型校验：校验 list/map/set 的内层类型是否已定义
- 枚举取值约束：必须为非负整数（enum.negativeValue / enum.valueNotInteger）
- 默认值类型校验：包括基础类型与 uuid 字符串格式校验（value.typeMismatch）
- 服务约束：
- oneway 必须返回 void，且不能声明 throws（service.oneway.returnNotVoid / service.oneway.hasThrows）
- throws 的类型必须为已知异常类型（service.throws.unknown / service.throws.notException）
- extends 的父类型必须为 service（service.extends.unknown / service.extends.notService）
- 默认值解析健壮性改进：
- 忽略字段注解中的 '='，避免被误识别为默认值起始
- set 默认值同时接受
[] 或 {} 包裹，并依据顶层括号进行元素分隔校验
说明：诊断在编辑与保存时即时更新，可在 VSCode “问题”面板查看并定位。
代码重构
- 标识符重命名（F2）：跨文件更新引用，内置冲突检测
- 抽取类型（typedef）：从选区或当前字段推断类型并生成
typedef
- 移动类型到文件：将
struct/enum/service/typedef 等移动到新的 .thrift 文件并自动插入 include
重命名与重构
- 重命名符号：选中标识符按
F2，或右键菜单选择 Rename Symbol
- 命令面板：
Thrift: Extract type (typedef)Thrift: Move type to file...
- 灯泡菜单（Quick Fix/Refactor）：在合适位置会出现与重构相关的 Code Action
配置选项
在 VSCode 设置中可以配置以下选项：
{
"thrift.format.trailingComma": "preserve", // "preserve" | "add" | "remove"
"thrift.format.alignTypes": true,
"thrift.format.alignNames": true,
"thrift.format.alignAssignments": true,
"thrift.format.alignAnnotations": true,
"thrift.format.alignComments": true,
"thrift.format.indentSize": 4,
"thrift.format.maxLineLength": 100,
"thrift.format.collectionStyle": "preserve" // "preserve" | "multiline" | "auto"
}
- 对齐总开关（alignAssignments）：开启后统一控制结构体字段等号和枚举等号/枚举值的对齐；未显式设置时，各类对齐遵循各自默认（结构体等号对齐默认关闭，枚举等号/枚举值默认开启）。
- 结构体默认值对齐（alignStructDefaults）：仅控制字段默认值的等号对齐，独立于 alignAssignments，不随总开关联动。
规范对齐
- 与 Apache Thrift IDL 0.23 对齐：将 uuid 视为内建基础类型，并在语法高亮、诊断与定义跳转中生效。
- 参考文档：Apache Thrift — IDL（Interface Definition Language）：https://thrift.apache.org/docs/idl
📝 格式化示例
格式化前：
struct User{
1:required string name
2:optional i32 age,
3: string email // user email
}
格式化后：
struct User {
1: required string name,
2: optional i32 age,
3: string email // user email
}
🐛 问题反馈
如果您遇到任何问题或有功能建议，请通过以下方式反馈：
- GitHub Issues：在 项目仓库 中创建 Issue
- 描述问题：请详细描述遇到的问题，包括：
- VSCode 版本
- 扩展版本
- 重现步骤
- 期望行为
- 实际行为
- 提供示例：如果可能，请提供相关的 Thrift 代码示例
🤝 贡献指南
我们欢迎社区贡献！如果您想为项目做出贡献：
贡献方式
- 报告 Bug：发现问题请及时报告
- 功能建议：提出新功能的想法和建议
- 代码贡献：提交 Pull Request
- 文档改进：帮助完善文档
开发环境
开发相关内容已迁移至 DEVELOPMENT.md，请前往查看最新要求与步骤（包括 Node.js 版本、构建、测试与发布流程）。
提交 Pull Request
- 创建功能分支：
git checkout -b feature/your-feature
- 提交更改：
git commit -m "Add your feature"
- 推送分支：
git push origin feature/your-feature
- 创建 Pull Request
📄 许可证
本扩展基于 MIT 许可证开源。
🔄 更新日志
完整的更新记录请查看 CHANGELOG：
- 本地：CHANGELOG.md
- GitHub：https://github.com/tzzs/vsce-thrift-support/blob/master/CHANGELOG.md
🔗 相关链接
享受使用 Thrift Support 扩展！ 如果觉得有用，请在 GitHub 给我们一个 ⭐️
