Melon Proto
melon 框架 .proto 文件的 VS Code 支持:语法高亮、跨文件智能补全、悬浮文档、跳转、大纲与折叠。
melon 的 proto 不是标准 protobuf,而是一套 DSL:clientdata / crossdata / proxymessage / root / message / enum,字段用 proxy / sync / db / center / required / optional / repeated 修饰。本扩展理解这套语法,并按生成器的语义给出提示。
⚠️ 本扩展会把 所有 .proto 文件 关联为 melon-proto 语言。若你在同一台机器上还有标准 protobuf 项目,可在那里用右下角语言模式切换回 Protocol Buffers,或在扩展面板禁用本扩展。
功能
| 能力 |
说明 |
| 语法高亮 |
模块声明、消息声明、字段修饰符、类型、[default=syncProxy(...)]、枚举 |
| 声明补全 |
顶层补 clientdata / crossdata / message / enum(带模块模板);模块内补 proxymessage / root / message |
| 修饰符补全 |
proxy / sync / db / center / required / optional / repeated,附带语义说明 |
| 类型补全 |
基础类型、常用数组(int[] 等)、字典模板 {[key:string]:...}、全工作区的 message / proxymessage / root 名 |
| 默认值补全 |
[default= 后按字段类型给 syncProxy(Type)、syncProxy(ProxyDataHash)、true / false / 0 / 1 / {} / [];syncProxy( 内补 ProxyDataHash |
| 枚举补全 |
enum 后补已有分组名;enum X KEY = 后补“当前最大编号 + 1”与按 10 对齐的编号 |
| 悬浮文档 |
消息字段表(修饰 / 类型 / 字段 / 注释)、枚举成员表、修饰符语义 |
| 跳转 |
F12 / Ctrl+Click 从类型名跳到声明 |
| 工作区符号 |
Ctrl+T 搜索全工作区的 message / enum |
| 大纲与折叠 |
模块 → 子消息 → 字段、枚举 → 成员;按 { } 折叠 |
使用示例
clientdata club Club {
proxymessage ClubData {
proxy double id; // 增量同步
proxy string name;
proxy {[key:string]:ClubLog} log = [default=syncProxy(ProxyDataHash)];
sync BattleRoom room; // sync 扩展通道
db {[key:string]:ClubMember} members = [default=syncProxy(ProxyDataHash)];
center string face; // 跨服通道
required int battle_count; // protobuf 必填
proxy StatInfo info = [default=syncProxy(StatInfo)];
}
}
enum ClubSocketConst LIST = 1200;
enum ClubSocketConst FIND = 1201;
输入 proxy 会列出基础类型与工作区内所有消息类型;输入 = [default= 会按字段类型给出建议值。
安装
Marketplace:在扩展面板搜索 Melon Proto(melonruntime.melon-proto)。
VSIX:扩展面板右上角 ... → Install from VSIX...,或命令行:
code --install-extension melon-proto-1.0.0.vsix
Remote-SSH / Dev Container / WSL:扩展声明了 extensionKind: workspace,在远程窗口的扩展面板里点 Install in SSH: <host> 即可装到远程侧(补全需要读取工作区内的 proto 文件,所以必须在工作区侧运行)。
配置
| 配置 |
默认 |
说明 |
melonProto.protoGlobs |
["**/*.proto"] |
参与索引(补全 / 跳转)的 proto 文件 |
melonProto.maxIndexedFiles |
4000 |
索引文件数量上限 |
命令
重建 proto 索引 (Melon Proto):手动刷新工作区索引。保存、新建、删除、重命名 proto 文件时会自动维护。
字段修饰符语义
语义来自 melon 的 ClassDefine.ts 与 ProtoBufParser.d.ts:
proxy:默认成员,写入记录 proData 增量,随 AMF3 members 下发
sync:进入 extendtion.sync
db:进入 extendtion.db,只落库
center:同时进 proData 与 centerData
required / optional / repeated:protobuf 规则
开发
npm test # 解析 / 补全 / 悬浮 / 跳转 / 激活冒烟测试
npm run package # 生成 melon-proto-<version>.vsix
src/parse.js、src/index.js、src/intel.js 不依赖 vscode,可直接用 Node 测试。
发布(维护者)
扩展 ID 为 melonruntime.melon-proto。
- 在 https://marketplace.visualstudio.com/manage 用
melonruntime 创建/确认 publisher。
- 在 Azure DevOps 生成 Personal Access Token(组织选
All accessible organizations,权限 Marketplace → Manage)。
- 发布:
$env:VSCE_PAT = "<your-pat>"
.\publish.ps1 # 先跑测试,再 vsce publish
也可以手动:npx @vscode/vsce publish --allow-missing-repository -p $env:VSCE_PAT。
License
MIT(完整文本见扩展包内 LICENSE 文件)。