msteditor — MST 工程文件插件使用手册
为 .mst 工程文件(MST 语法规范 v2.6)提供编辑支持:高亮、跳转、补全、大纲、折叠、格式化与三通道语法检查。
- 工程结构:根文件
index.mst + 模块 .mst + windows/ 子目录 + language/ 语言字典
- 打开含
index.mst 的文件夹即可生效(工程根以 index.mst 所在目录为准)
1. 功能一览
| 功能 |
入口 |
说明 |
| 语法高亮 |
自动 |
关键字 / 类型 / section / 变量 / 字符串 / 注释 |
| 代码片段 |
自动输入 |
常用结构(模块骨架、事件、children 等) |
| 大纲 Outline |
自动 |
模块 → section → 条目层级;@VModule 标记可见 |
| 代码折叠 |
自动 |
section 块 / children 节点 / 事件方法行(折叠头=方法行)/ TOption 内嵌节点与 map |
| 格式化 |
Ctrl+Alt+F |
结构行 4 空格/层重排;脚本块保留内部相对缩进 |
| 跳转定义 |
Ctrl+点击 / F12 |
import 文件跳转;@path 节点路径跳转(含 TOption 内嵌节点与 map 成员) |
| 引用/重命名 |
Shift+F12 / F2 |
工程级符号查找与改名 |
| 悬停提示 |
悬停 |
gsid 路径 + 类型说明 |
| 补全 |
自动 |
类型/构件/属性/事件/section/成员路径;脚本块内 Runtime.* 等工具类补全 |
| 诊断与快速修复 |
自动 |
三通道检查 + 部分问题 CodeAction 自动修复 |
2. 参数配置
.vscode/settings.json(或用户设置):
2.1 检查开关
| 配置项 |
默认 |
说明 |
msteditor.check.structure |
true |
通道 A:CST 结构解析错误(section/条目/括号/类型标注) |
msteditor.check.semantic |
true |
通道 B:构件类型/属性/事件签名(类型字典校验)、@path 解析 |
msteditor.check.script |
true |
通道 C:事件方法体与 script {} 的 MScript 规则检查 |
msteditor.check.scriptBlocks |
true |
script {} 值块是否纳入通道 C |
// 示例:关闭脚本检查
{ "msteditor.check.script": false }
2.2 自定义类型字典
内置 DEFAULT_UTILS(Runtime 工具类)+ DEFAULT_NODES(构件类型)。工程可增加或覆盖(同名整体覆盖):
{
"msteditor.Utils": {
"MyUtil": {
"detail": "自定义工具类",
"fnGet": { "kind": "Function", "params": ["id: TString"], "return": "TAny" }
}
},
"msteditor.Nodes": {
"MyWidget": {
"detail": "自定义构件",
"mText": { "kind": "Property", "type": "TString" }
}
}
}
3. 基本用法
3.1 工程结构
project/
├── index.mst ← 工程根(唯一入口,跨文件跟踪以此为基准)
├── variants.mst ← 模块
├── vloader.mst
├── windows/ ← 窗口子目录
│ ├── wmain.mst
│ └── wsetting.mst
└── language/ ← 语言字典
├── chinese.mst
└── english.mst
3.2 @path 节点路径
脚本内以 @ 前缀引用工程节点,支持跳转/补全/类型检查:
@./wTitle/mText = "标题" ← 相对当前节点
@../wMain/wList = data ← 相对父节点
@/windows/wmain/wTitle ← 工程绝对路径
@./xTpl/TLabel/mText ← TOption map 成员可寻址
编辑器中显示 mName 路径徽标;悬停可见 gsid 路径 + 类型说明。
3.3 TOption 写法(v2.6.1)
exvariants:
xLink: TOption = wLayout: WidgetGrid { ← 单对象(gsid 位可选,来自 mGsid)
properties:
mWidth = 1060
}
xTpl: TOption = { ← map:值无 mType、成员均为节点定义
TLabel = WidgetLabel {
properties:
mText = "标签"
}
TBoolean = WidgetSwitch { ... }
}
properties:
mTpl: TOption = wGrid: WidgetGrid { ... } ← 属性型:类型由类型字典表标注
折叠 / 跳转 / 补全 / 大纲均支持上述形态。
3.4 @ignore 诊断抑制(v2.6.2)
写在报错行的前一行(独立成行):
| 指令 |
作用 |
// @ignore |
抑制下一行的全部诊断 |
// @ignore-block |
抑制下一行开启的整个 {...} 块(含嵌套) |
// @ignore-next-line |
同 @ignore(旧名兼容) |
exvariants:
// @ignore
xData: TStruct = Runtime.helper.load() ← 本行诊断被抑制
// @ignore-block
xLegacy: TStruct = { ← 整个对象被抑制
readonly: false
store: false
}
注意:行尾尾缀写法已废除块级语义(仅保留本行抑制兼容旧文件);独立行写法与格式化完全兼容。
4. 脚本语法规则(通道 C,MScript 22 条)
事件方法体与 script {} 值块按 MScript 规则检查,与运行时行为一致:
4.1 声明与作用域
| 规则 |
说明 |
变量声明必须 let |
var x = 1 报错(快速修复:var→let) |
| 禁止重复声明 |
同作用域内 let x 两次 |
| 先声明后使用 |
未声明变量使用报错(事件参数表注入的除外) |
| 嵌套深度 ≤ 3 |
function/if/for 嵌套超过 3 层告警 |
4.2 语法限制(沙箱环境不可用)
| 禁止 |
替代 |
console.log |
Runtime.Log.print() |
箭头函数 => / map(x => ...) |
for 循环 |
await / async |
Runtime.Async.* |
window / document / globalThis |
Runtime.* 工具类 |
模板字符串 `x${y}` |
字符串拼接 "x" + y |
!! 双重否定 |
显式 Runtime.Format.TBoolean(x) |
单引号字符串 'x' |
双引号 "x"(快速修复可用) |
4.3 内置环境
| 类别 |
名称 |
说明 |
| 工具类 |
Runtime.* |
Log/Format/Object/Storage/Async/Core 等子类(悬停查看成员) |
| 上下文 |
Runtime.ctx |
事件上下文(widget/request/response/option 等) |
| 事件参数 |
签名注入 |
evResponseEvent(request: Request, response: Response) 体内可直接用 |
| 构件类型 |
Widget* / VModule 等 |
类型字典校验属性/方法调用 |
完整规则:docs/LINT-SPEC.md。
5. 常见问题
- 诊断不刷新:保存或继续输入触发重析;工程级诊断(import 缺失)在根文件保存时全量刷新。
- 自定义构件报未知类(MST_UNKNOWN_CLASS):
msteditor.Nodes 补定义(§2.2)。
- @path 无法解析(运行时动态节点):静态分析原理上不可达,用
// @ignore 显式忽略。
- 对象字面量旧写法告警(MST_OBJ_KV_SEPARATOR):CLI 历史产物存量基线;整对象静默用
// @ignore-block。
- 事件签名未知(MST_EVENT_SIGNATURE):onevents 内置事件签名来自类型字典;自定义 exevents 无签名检查。