跳到正文

Monaco 的首次语言激活会影响类型服务的延迟加载

直接打开类型工作区,编辑器能显示 TypeScript 的诊断和悬停类型。先打开一个演示 ESLint 规则的编辑器,再在同一文档打开类型工作区,页面却报 TypeScript not registered!。两个编辑器都用 Monaco 0.57.0。Lint 编辑器只需要 TypeScript 语法高亮,诊断由 ESLint 提供。类型工作区要加载声明文件,让 TypeScript 检查代码。

这个故障用一份普通 HTML 就能复现。两个 Code Lab 挂在同一文档里,共用 Monaco 实例。先挂载 Lint 编辑器,等它的模型创建后,再加载类型工作区。把这两步放在用客户端导航切换的两篇文章里,只要导航保留文档和 Monaco 实例,初始化顺序也一样。站点生成器只负责输出页面和资源地址。

首次语言激活只通知当时的订阅者

Monaco 的模型保存文本和语言 ID。第一个 TypeScript 模型会触发对该语言高级功能的请求,语言服务把 typescript 记到已请求的集合里,再发出通知。后续创建同语言的模型时,服务发现已经请求过,就跳过这个分支。下面节选语言服务的首次请求实现,省略基础功能和分词器的准备步骤。

// vscode/src/vs/editor/common/services/languageService.ts
if (!this._requestedRichLanguages.has(languageId)) {
  this._requestedRichLanguages.add(languageId);
  // 省略基础语言功能和分词器的准备步骤。
  this._onDidRequestRichLanguageFeatures.fire(languageId);
}

TypeScript 功能模块加载时,用 languages.onLanguage('typescript', …) 订阅通知。收到通知后,才调用 setupTypeScript() 注册 Worker 工厂,也就是负责取得语言服务的函数。

如果第一个模型来自 Lint 编辑器,订阅还没建立,setupTypeScript() 就没有执行。稍后调用 getTypeScriptWorker() 虽然能加载 tsMode 模块,但读取 Worker 工厂的分支只会发现工厂为空,并以 TypeScript not registered! 拒绝这次请求。

两种挂载顺序下,TypeScript 功能模块是否能收到首次激活通知

因此,看到编辑器有语法高亮、看到 import() 已经完成、拿到能处理请求的 TypeScript Worker,是三个独立的检查点。同一实例内重开工作区只会再次请求已经激活的语言,先前的通知仍然不会重发。

工作区显式创建和释放 Worker

Code Lab 的类型工作区各有一组声明文件,打开时才需要类型服务。工作区自己创建 TypeScript Worker,把额外的声明文件交给 Worker,再用 monaco.editor.createWebWorker() 建立客户端。诊断和悬停前,先用 withSyncedResources([model.uri]) 同步当前模型。工作区卸载时释放客户端和 Worker。这条路径每次打开工作区时独立运行。

如果多个编辑器需要共享 Monaco 默认的 TypeScript 服务,可以在创建任何 TypeScript 模型之前加载功能模块,保证订阅先建立。读取类型服务的代码还要等初始化完成,单独等待 import() 完成只保证模块已经求值。

回归测试覆盖两种挂载顺序

单独打开类型工作区可以检查首次加载。浏览器回归再用普通 HTML 挂载真实的 Code Lab 构建产物,先打开 Lint 编辑器,然后在同一文档加载类型示例 function find(item) { return item; }。旧实现会报告 TypeScript not registered!。修复后,悬停在 item 上能看到 TS7006,说明 Worker 已经收到模型并执行了类型检查。测试随后卸载工作区,等待 Worker 关闭。单次导入表达式的静态检查无法观察到这些运行时状态。