Move awaitExtensionReadiness to top-level in EditorAppBaseConfig

TypeFox · Sep 29, 2023 · 8785370 · 8785370
1 parent 629f52a
commit 8785370
Show file tree

Hide file tree

Showing 12 changed files with 49 additions and 46 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/examples/package.json b/packages/examples/package.json
@@ -4,15 +4,15 @@
   "version": "0.0.0",
   "type": "module",
   "dependencies": {
-    "@codingame/monaco-vscode-editor-service-override": "1.82.2",
-    "@codingame/monaco-vscode-javascript-default-extension": "1.82.2",
-    "@codingame/monaco-vscode-json-default-extension": "1.82.2",
-    "@codingame/monaco-vscode-keybindings-service-override": "1.82.2",
-    "@codingame/monaco-vscode-python-default-extension": "1.82.2",
-    "@codingame/monaco-vscode-textmate-service-override": "1.82.2",
-    "@codingame/monaco-vscode-theme-defaults-default-extension": "1.82.2",
-    "@codingame/monaco-vscode-theme-service-override": "1.82.2",
-    "@typefox/monaco-editor-react": "2.2.0-next.0",
+    "@codingame/monaco-vscode-editor-service-override": "~1.82.2",
+    "@codingame/monaco-vscode-javascript-default-extension": "~1.82.2",
+    "@codingame/monaco-vscode-json-default-extension": "~1.82.2",
+    "@codingame/monaco-vscode-keybindings-service-override": "~1.82.2",
+    "@codingame/monaco-vscode-python-default-extension": "~1.82.2",
+    "@codingame/monaco-vscode-textmate-service-override": "~1.82.2",
+    "@codingame/monaco-vscode-theme-defaults-default-extension": "~1.82.2",
+    "@codingame/monaco-vscode-theme-service-override": "~1.82.2",
+    "@typefox/monaco-editor-react": "2.2.0-next.1",
     "http-server": "~14.1.1",
     "langium": "~2.0.2",
     "langium-statemachine-dsl": "~2.0.0",

diff --git a/packages/examples/src/langium/config/wrapperLangiumVscode.ts b/packages/examples/src/langium/config/wrapperLangiumVscode.ts
@@ -4,7 +4,7 @@ import getEditorServiceOverride from '@codingame/monaco-vscode-editor-service-ov
 import getKeybindingsServiceOverride from '@codingame/monaco-vscode-keybindings-service-override';
 import getThemeServiceOverride from '@codingame/monaco-vscode-theme-service-override';
 import getTextmateServiceOverride from '@codingame/monaco-vscode-textmate-service-override';
-import { whenReady } from '@codingame/monaco-vscode-theme-defaults-default-extension';
+import { whenReady as whenReadyThemes } from '@codingame/monaco-vscode-theme-defaults-default-extension';
 import { useOpenEditorStub } from 'monaco-languageclient';
 import { UserConfig } from 'monaco-editor-wrapper';
 import { getTextContent } from '../../common.js';
@@ -39,6 +39,8 @@ export const setupLangiumClientVscodeApi = async (): Promise<UserConfig> => {
                 languageId: 'langium',
                 code: code,
                 useDiffEditor: false,
+                // Ensure all required extensions are loaded before setting up the language extension
+                awaitExtensionReadiness: [whenReadyThemes],
                 extensions: [{
                     config: {
                         name: 'langium-example',
@@ -68,8 +70,7 @@ export const setupLangiumClientVscodeApi = async (): Promise<UserConfig> => {
                         'workbench.colorTheme': 'Default Dark Modern',
                         'editor.guides.bracketPairsHorizontal': 'active',
                         'editor.lightbulb.enabled': true
-                    }),
-                    awaitReadiness: [whenReady]
+                    })
                 }
             }
         },

diff --git a/packages/examples/src/langium/config/wrapperStatemachineConfig.ts b/packages/examples/src/langium/config/wrapperStatemachineConfig.ts
@@ -3,7 +3,7 @@ import getEditorServiceOverride from '@codingame/monaco-vscode-editor-service-ov
 import getKeybindingsServiceOverride from '@codingame/monaco-vscode-keybindings-service-override';
 import getThemeServiceOverride from '@codingame/monaco-vscode-theme-service-override';
 import getTextmateServiceOverride from '@codingame/monaco-vscode-textmate-service-override';
-import { whenReady } from '@codingame/monaco-vscode-theme-defaults-default-extension';
+import { whenReady as whenReadyThemes } from '@codingame/monaco-vscode-theme-defaults-default-extension';
 import { Uri } from 'vscode';
 import { useOpenEditorStub } from 'monaco-languageclient';
 import { UserConfig } from 'monaco-editor-wrapper';
@@ -39,6 +39,8 @@ export const createLangiumGlobalConfig = async (htmlElement: HTMLElement): Promi
                 languageId: 'statemachine',
                 code: code,
                 useDiffEditor: false,
+                // Ensure all required extensions are loaded before setting up the language extension
+                awaitExtensionReadiness: [whenReadyThemes],
                 extensions: [{
                     config: {
                         name: 'statemachine-example',
@@ -68,8 +70,7 @@ export const createLangiumGlobalConfig = async (htmlElement: HTMLElement): Promi
                         'workbench.colorTheme': 'Default Dark Modern',
                         'editor.guides.bracketPairsHorizontal': 'active',
                         'editor.lightbulb.enabled': true
-                    }),
-                    awaitReadiness: [whenReady]
+                    })
                 }
             }
         },

diff --git a/packages/examples/src/reactPython.tsx b/packages/examples/src/reactPython.tsx
@@ -2,7 +2,7 @@ import getConfigurationServiceOverride from '@codingame/monaco-vscode-configurat
 import getKeybindingsServiceOverride from '@codingame/monaco-vscode-keybindings-service-override';
 import getThemeServiceOverride from '@codingame/monaco-vscode-theme-service-override';
 import getTextmateServiceOverride from '@codingame/monaco-vscode-textmate-service-override';
-import { whenReady as whenReadyTheme } from '@codingame/monaco-vscode-theme-defaults-default-extension';
+import { whenReady as whenReadyThemes } from '@codingame/monaco-vscode-theme-defaults-default-extension';
 import { whenReady as whenReadyPython } from '@codingame/monaco-vscode-python-default-extension';
 import React from 'react';
 import ReactDOM from 'react-dom/client';
@@ -66,6 +66,9 @@ const userConfig: UserConfig = {
         },
         editorAppConfig: {
             $type: 'vscodeApi',
+            languageId: 'python',
+            codeUri: '/workspace/python.py',
+            awaitExtensionReadiness: [whenReadyThemes, whenReadyPython],
             extensions: [{
                 config: {
                     name: 'python-client',
@@ -99,11 +102,8 @@ const userConfig: UserConfig = {
                     }
                 }
             }],
-            languageId: 'python',
-            codeUri: '/workspace/python.py',
             userConfiguration: {
-                json: JSON.stringify({'workbench.colorTheme': 'Default Dark Modern'}),
-                awaitReadiness: [whenReadyTheme, whenReadyPython]
+                json: JSON.stringify({'workbench.colorTheme': 'Default Dark Modern'})
             },
             useDiffEditor: false,
             code: code,

diff --git a/packages/examples/src/wrapperWs.ts b/packages/examples/src/wrapperWs.ts
@@ -49,14 +49,13 @@ const userConfig: UserConfig = {
             editorOptions: monacoEditorConfig,
             diffEditorOptions: monacoEditorConfig,
             theme: 'vs-dark',
+            // Ensure all required extensions are loaded before setting up the language extension
+            awaitExtensionReadiness: [whenReadyTheme, whenReadyJson],
             languageExtensionConfig: {
                 id: 'json',
                 extensions: ['.json', '.jsonc'],
                 aliases: ['JSON', 'json'],
                 mimetypes: ['application/json']
-            },
-            userConfiguration: {
-                awaitReadiness: [whenReadyTheme, whenReadyJson]
             }
         }
     },

diff --git a/packages/monaco-editor-react/package.json b/packages/monaco-editor-react/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@typefox/monaco-editor-react",
-  "version": "2.2.0-next.0",
+  "version": "2.2.0-next.1",
   "license": "MIT",
   "description": "React component for Monaco-Editor and Monaco Languageclient",
   "keywords": [
@@ -50,7 +50,7 @@
     "npm": "9.8.1"
   },
   "peerDependencies": {
-    "monaco-editor-wrapper": "3.2.0-next.0",
+    "monaco-editor-wrapper": "3.2.0-next.1",
     "react": "~18.2.0",
     "react-dom": "~18.2.0"
   },

diff --git a/packages/monaco-editor-wrapper/package.json b/packages/monaco-editor-wrapper/package.json
@@ -1,6 +1,6 @@
 {
   "name": "monaco-editor-wrapper",
-  "version": "3.2.0-next.0",
+  "version": "3.2.0-next.1",
   "license": "MIT",
   "description": "Monaco-Editor and Monaco Languageclient Wrapper",
   "keywords": [
@@ -58,7 +58,7 @@
     "npm": "9.8.1"
   },
   "dependencies": {
-    "@codingame/monaco-vscode-configuration-service-override": "1.82.2",
+    "@codingame/monaco-vscode-configuration-service-override": "~1.82.2",
     "monaco-languageclient": "6.5.0-next.2"
   },
   "peerDependencies": {

diff --git a/packages/monaco-editor-wrapper/src/editorAppBase.ts b/packages/monaco-editor-wrapper/src/editorAppBase.ts
@@ -18,14 +18,14 @@ export type EditorAppBaseConfig = ModelUpdate & {
     useDiffEditor: boolean;
     domReadOnly?: boolean;
     readOnly?: boolean;
+    awaitExtensionReadiness?: Array<() => Promise<void>>
     userConfiguration?: UserConfiguration;
 }
 
 export type EditorAppType = 'vscodeApi' | 'classic';
 
 export type UserConfiguration = {
     json?: string;
-    awaitReadiness?: Array<() => Promise<void>>
 }
 
 /**
@@ -209,10 +209,10 @@ export abstract class EditorAppBase {
         }
     }
 
-    async awaitReadiness(config?: UserConfiguration) {
-        if (config?.awaitReadiness) {
+    async awaitReadiness(awaitExtensionReadiness?: Array<() => Promise<void>>) {
+        if (awaitExtensionReadiness) {
             const allPromises: Array<Promise<void>> = [];
-            for (const awaitReadiness of config.awaitReadiness) {
+            for (const awaitReadiness of awaitExtensionReadiness) {
                 allPromises.push(awaitReadiness());
             }
             return Promise.all(allPromises);

diff --git a/packages/monaco-editor-wrapper/src/editorAppClassic.ts b/packages/monaco-editor-wrapper/src/editorAppClassic.ts
@@ -83,7 +83,7 @@ export class EditorAppClassic extends EditorAppBase {
 
     async init() {
         // await all extenson that should be ready beforehand
-        await this.awaitReadiness(this.config.userConfiguration);
+        await this.awaitReadiness(this.config.awaitExtensionReadiness);
 
         // register own language first
         const extLang = this.config.languageExtensionConfig;

diff --git a/packages/monaco-editor-wrapper/src/editorAppVscodeApi.ts b/packages/monaco-editor-wrapper/src/editorAppVscodeApi.ts
@@ -71,7 +71,7 @@ export class EditorAppVscodeApi extends EditorAppBase {
 
     async init() {
         // await all extenson that should be ready beforehand
-        await this.awaitReadiness(this.config.userConfiguration);
+        await this.awaitReadiness(this.config.awaitExtensionReadiness);
 
         if (this.config.extensions) {
             const allPromises: Array<Promise<void>> = [];

diff --git a/packages/monaco-editor-wrapper/src/index.ts b/packages/monaco-editor-wrapper/src/index.ts
@@ -23,6 +23,7 @@ import {
 } from './editorAppClassic.js';
 
 import type {
+    ExtensionConfig,
     EditorAppConfigVscodeApi,
     RegisterExtensionResult,
     RegisterLocalProcessExtensionResult,
@@ -69,6 +70,7 @@ export type {
     EditorAppBaseConfig,
     EditorAppType,
     EditorAppConfigClassic,
+    ExtensionConfig,
     EditorAppConfigVscodeApi,
     RegisterExtensionResult,
     RegisterLocalProcessExtensionResult,