refactor(editor-monaco-language-apidom): use idiomatic language impl (#3978)

Semantic Legend is now obtained via language service worker.

Author: char0n

src/plugins/editor-monaco-language-apidom/after-load.js

@@ -1,55 +1,11 @@
-import { ModesRegistry } from 'monaco-editor/esm/vs/editor/common/languages/modesRegistry.js';
-import * as monaco from 'monaco-editor';
-
-import { languageExtensionPoint, monarchLanguage, languageId } from './language/config.js';
-import { setupApiDOM } from './language/apidom-mode.js';
+import lazyMonacoContribution, { isLanguageRegistered } from './language/monaco.contribution.js';
 
 const makeAfterLoad =
   ({ createData = {} } = {}) =>
   () => {
-    /**
-     * Parts of this code use ModesRegistry API instead of monaco.languages API.
-     * The reason is that monaco.languages API is using ModesRegistory under the hood
-     * but doesn't return disposables produced by ModesRegistry. By using ModesRegistry
-     * directly we're able to obtain disposables.
-     */
-
-    // guard for multiple language registration
-    const languages = ModesRegistry.getLanguages().map(({ id }) => id);
-    if (languages.includes(languageId)) {
-      return;
-    }
-
-    // setup monaco environment
-    globalThis.MonacoEnvironment = {
-      // expect monaco plugin to have already executed
-      ...globalThis.MonacoEnvironment,
-      getWorkerUrl(moduleId, label) {
-        if (label === languageId) {
-          return new URL('./apidom.worker.js', this.baseUrl).toString();
-        }
-        return new URL('./editor.worker.js', this.baseUrl).toString();
-      },
-    };
-
-    // setting up ApiDOM language
-    const disposables = [];
-    disposables.push(ModesRegistry.registerLanguage(languageExtensionPoint));
-    disposables.push(
-      monaco.languages.onLanguage(languageId, () => {
-        disposables.push(monaco.languages.setMonarchTokensProvider(languageId, monarchLanguage)); // enable syntax highlighting
-        disposables.push(setupApiDOM({ languageId, options: createData }));
+    if (isLanguageRegistered()) return;
 
-        // disposing of all allocated disposables
-        disposables.push(
-          monaco.editor.onWillDisposeModel((model) => {
-            if (model.getLanguageId() === languageId) {
-              disposables.forEach((disposable) => disposable.dispose());
-            }
-          })
-        );
-      })
-    );
+    lazyMonacoContribution({ createData });
   };
 
 export default makeAfterLoad;

src/plugins/editor-monaco-language-apidom/language/WorkerManager.js

@@ -41,18 +41,13 @@ export default class WorkerManager {
     this.#lastUsedTime = Date.now();
 
     if (!this.#client) {
-      const {
-        languageId,
-        options: { customApiDOMWorkerPath, ...createData },
-      } = this.#defaults;
-
       this.#worker = monaco.editor.createWebWorker({
         moduleId: 'ApiDOMWorker',
-        label: languageId,
+        label: this.#defaults.getLanguageId(),
         createData: {
-          ...createData,
-          languageId,
-          customWorkerPath: customApiDOMWorkerPath,
+          ...this.#defaults.getWorkerOptions.data,
+          languageId: this.#defaults.getLanguageId(),
+          customWorkerPath: this.#defaults.getWorkerOptions.customWorkerPath,
         },
       });
       this.#client = this.#worker.getProxy();

src/plugins/editor-monaco-language-apidom/language/adapters/CodeActionsAdapter.js

@@ -1,6 +1,6 @@
 import Adapter from './Adapter.js';
 
-export default class CodeActionsAdapter extends Adapter {
+class CodeActionsAdapter extends Adapter {
   async #getCodeActionList(vscodeDocument, diagnosticList) {
     const worker = await this.worker(vscodeDocument.uri);
 
@@ -26,3 +26,5 @@ export default class CodeActionsAdapter extends Adapter {
     return this.#maybeConvert(codeActionList);
   }
 }
+
+export default CodeActionsAdapter;

src/plugins/editor-monaco-language-apidom/language/adapters/CompletionItemsAdapter.js

@@ -1,6 +1,6 @@
 import Adapter from './Adapter.js';
 
-export default class CompletionItemsAdapter extends Adapter {
+class CompletionItemsAdapter extends Adapter {
   #completionContext = {
     maxNumberOfItems: 100,
   };
@@ -25,3 +25,5 @@ export default class CompletionItemsAdapter extends Adapter {
     return this.protocolConverter.asCompletionResult(completionList);
   }
 }
+
+export default CompletionItemsAdapter;

src/plugins/editor-monaco-language-apidom/language/adapters/DefinitionAdapter.js

@@ -1,6 +1,6 @@
 import Adapter from './Adapter.js';
 
-export default class DefinitionAdapter extends Adapter {
+class DefinitionAdapter extends Adapter {
   async #getLocation(vscodeDocument, position) {
     const worker = await this.worker(vscodeDocument.uri);
 
@@ -20,3 +20,5 @@ export default class DefinitionAdapter extends Adapter {
     return this.protocolConverter.asDefinitionResult(location);
   }
 }
+
+export default DefinitionAdapter;

src/plugins/editor-monaco-language-apidom/language/adapters/DiagnosticsAdapter.js

@@ -2,9 +2,9 @@ import * as monaco from 'monaco-editor';
 import { languages } from 'vscode';
 
 import Adapter from './Adapter.js';
-import { languageId } from '../config.js';
+import * as apidom from '../apidom.js';
 
-export default class DiagnosticsAdapter extends Adapter {
+class DiagnosticsAdapter extends Adapter {
   #listener = [];
 
   #disposables = [];
@@ -14,10 +14,10 @@ export default class DiagnosticsAdapter extends Adapter {
   constructor(...args) {
     super(...args);
 
-    this.#diagnosticCollection = languages.createDiagnosticCollection(languageId);
+    this.#diagnosticCollection = languages.createDiagnosticCollection(apidom.languageId);
 
     const onModelAdd = (model) => {
-      if (model.getLanguageId() !== languageId) {
+      if (model.getLanguageId() !== apidom.languageId) {
         return;
       }
 
@@ -53,8 +53,6 @@ export default class DiagnosticsAdapter extends Adapter {
     this.#disposables.push(monaco.editor.onDidCreateModel(onModelAdd));
     this.#disposables.push(monaco.editor.onWillDisposeModel(onModelRemoved));
     this.#disposables.push(this.#diagnosticCollection);
-    // Monaco supports multiple models, though we only use a single model
-    monaco.editor.getModels().forEach(onModelAdd);
   }
 
   async #getDiagnostics(model) {
@@ -87,3 +85,5 @@ export default class DiagnosticsAdapter extends Adapter {
     this.#disposables = [];
   }
 }
+
+export default DiagnosticsAdapter;

…apidom/language/adapters/LinksAdapter.js …language/adapters/DocumentLinkAdapter.jssrc/plugins/editor-monaco-language-apidom/language/adapters/LinksAdapter.js renamed to src/plugins/editor-monaco-language-apidom/language/adapters/DocumentLinkAdapter.js src/plugins/editor-monaco-language-apidom/language/adapters/LinksAdapter.js renamed to src/plugins/editor-monaco-language-apidom/language/adapters/DocumentLinkAdapter.js

@@ -1,6 +1,6 @@
 import Adapter from './Adapter.js';
 
-export default class LinksAdapter extends Adapter {
+class DocumentLinkAdapter extends Adapter {
   async #getLinks(vscodeDocument) {
     const worker = await this.worker(vscodeDocument.uri);
 
@@ -22,3 +22,5 @@ export default class LinksAdapter extends Adapter {
     return link;
   }
 }
+
+export default DocumentLinkAdapter;

src/plugins/editor-monaco-language-apidom/language/adapters/DocumentSemanticTokensAdapter.js

@@ -0,0 +1,21 @@
+import Adapter from './Adapter.js';
+
+class DocumentSemanticTokensAdapter extends Adapter {
+  async #getSemanticTokens(vscodeDocument) {
+    const worker = await this.worker(vscodeDocument.uri);
+
+    try {
+      return await worker.findSemanticTokens(vscodeDocument.uri.toString());
+    } catch {
+      return undefined;
+    }
+  }
+
+  async provideDocumentSemanticTokens(vscodeDocument) {
+    const semanticTokens = await this.#getSemanticTokens(vscodeDocument);
+
+    return this.protocolConverter.asSemanticTokens(semanticTokens);
+  }
+}
+
+export default DocumentSemanticTokensAdapter;

src/plugins/editor-monaco-language-apidom/language/adapters/DocumentSymbolsAdapter.js

@@ -1,6 +1,6 @@
 import Adapter from './Adapter.js';
 
-export default class DocumentSymbolAdapter extends Adapter {
+class DocumentSymbolAdapter extends Adapter {
   async #getSymbolInformationList(vscodeDocument) {
     const worker = await this.worker(vscodeDocument.uri);
 
@@ -17,3 +17,5 @@ export default class DocumentSymbolAdapter extends Adapter {
     return this.protocolConverter.asDocumentSymbols(symbolInformationList);
   }
 }
+
+export default DocumentSymbolAdapter;

src/plugins/editor-monaco-language-apidom/language/adapters/HoverAdapter.js

@@ -1,6 +1,6 @@
 import Adater from './Adapter.js';
 
-export default class HoverAdapter extends Adater {
+class HoverAdapter extends Adater {
   async #getHover(vscodeDocument, position) {
     const worker = await this.worker(vscodeDocument.uri);
 
@@ -20,3 +20,5 @@ export default class HoverAdapter extends Adater {
     return this.protocolConverter.asHover(hover);
   }
 }
+
+export default HoverAdapter;