Adapt to monaco-vscode-api-1.79.1 (#501)

* Added warning when required services are not configured. Update registerFeatures
* Remove unnecessary optimizeDeps

Author: kaisalmen

README.md

@@ -78,7 +78,7 @@ The following table describes which version of **monaco-languageclient** and **m
 
 | monaco-languageclient | monaco-vscode-api | monaco-editor | comment |
 | :----         | :----   | :---   | :--- |
-| 6.1.0         | 1.79.0  | 0.38.0 | Released 2023-06-0x |
+| 6.1.0         | 1.79.1  | 0.38.0 | Released 2023-06-0x |
 | 6.0.3         | 1.78.8  | 0.37.1 | Released 2023-05-31 |
 | 6.0.2         | 1.78.6  | 0.37.1 | Released 2023-05-24 |
 | 6.0.1         | 1.78.6  | 0.37.1 | Released 2023-05-12 |

package-lock.json

@@ -5,6 +5,7 @@ All notable changes to this npm module are documented in this file.
 ## [6.1.0] - 2023-06-0x
 
 - Updated to `monaco-vscode-api` version `1.79.0` and `monaco-editor` version `0.38.0` [#493](https://github.com/TypeFox/monaco-languageclient/issues/493)
+- Updated to `monaco-vscode-api` version `1.79.1` [#501](https://github.com/TypeFox/monaco-languageclient/pull/501)
 - `initService` creates `window.MonacoEnvironment` if not yet available
 
 ## [6.0.3] - 2023-05-31

packages/client/CHANGELOG.md

@@ -1,6 +1,6 @@
 {
   "name": "monaco-languageclient",
-  "version": "6.1.0-next.0",
+  "version": "6.1.0-next.1",
   "description": "Monaco Language client implementation",
   "author": {
     "name": "TypeFox GmbH",
@@ -49,13 +49,13 @@
   ],
   "dependencies": {
     "monaco-editor": "~0.38.0",
-    "vscode": "npm:@codingame/monaco-vscode-api@~1.79.0",
+    "vscode": "npm:@codingame/monaco-vscode-api@~1.79.1",
     "vscode-jsonrpc": "~8.1.0",
     "vscode-languageclient": "~8.1.0"
   },
   "peerDependencies": {
     "monaco-editor": "~0.38.0",
-    "vscode": "npm:@codingame/monaco-vscode-api@~1.79.0"
+    "vscode": "npm:@codingame/monaco-vscode-api@~1.79.1"
   },
   "peerDependenciesMeta": {
     "monaco-editor": {
@@ -67,7 +67,7 @@
   },
   "scripts": {
     "postinstall": "monaco-treemending",
-    "clean": "npx shx rm -fr lib *.tsbuildinfo",
+    "clean": "shx rm -fr lib *.tsbuildinfo",
     "compile": "tsc --build tsconfig.src.json",
     "build:msg": "echo Building monaco-languageclient:",
     "build": "npm run build:msg && npm run clean && npm run compile"

packages/client/package.json

@@ -124,14 +124,7 @@ export class MonacoLanguageClient extends BaseLanguageClient {
         this.registerFeature(new WillSaveFeature(this));
         this.registerFeature(new WillSaveWaitUntilFeature(this));
         this.registerFeature(new DidSaveTextDocumentFeature(this));
-    }
-
-    /**
-     * These are all contained in BaseLanguageClient#registerBuiltinFeatures but not registered
-     * in MonacoLanguageClient. This method is not called!
-     */
-    public registerNotUsedFeatures() {
-        // theses feature will become supported once https://github.com/CodinGame/monaco-vscode-api/pull/110 is ready
+        // enabled since monaco-vscode-api 1.79.0 (PR https://github.com/CodinGame/monaco-vscode-api/pull/110)
         this.registerFeature(new WorkspaceSymbolFeature(this));
         this.registerFeature(new DidCreateFilesFeature(this));
         this.registerFeature(new DidRenameFilesFeature(this));
@@ -142,7 +135,13 @@ export class MonacoLanguageClient extends BaseLanguageClient {
         this.registerFeature(new CallHierarchyFeature(this));
         this.registerFeature(new TypeHierarchyFeature(this));
         this.registerFeature(new InlineValueFeature(this));
+    }
 
+    /**
+     * These are all contained in BaseLanguageClient#registerBuiltinFeatures but not registered
+     * in MonacoLanguageClient. This method is not called!
+     */
+    public registerNotUsedFeatures() {
         // these will stay unsupported for now
         this.registerFeature(new ProgressFeature(this));
         this.registerFeature(new NotebookDocumentSyncFeature(this));

packages/client/src/monaco-language-client.ts

@@ -6,7 +6,7 @@
 import { editor, Environment, Uri } from 'monaco-editor/esm/vs/editor/editor.api.js';
 import { initialize as initializeMonacoService } from 'vscode/services';
 import { initialize as initializeVscodeExtensions } from 'vscode/extensions';
-import type { OpenEditor } from 'vscode/service-override/modelEditor';
+import type { OpenEditor } from 'vscode/service-override/editor';
 
 interface MonacoEnvironmentEnhanced extends Environment {
     vscodeApiInitialised: boolean;
@@ -15,13 +15,13 @@ interface MonacoEnvironmentEnhanced extends Environment {
 export type InitializeServiceConfig = {
     enableDialogService?: boolean;
     enableNotificationService?: boolean;
-    enableModelEditorService?: boolean;
-    modelEditorServiceConfig?: {
-        useDefaultFunction: boolean;
+    enableModelService?: boolean;
+    configureEditorOrViewsServiceConfig?: {
+        enableViewsService: boolean;
+        useDefaultOpenEditorFunction: boolean;
         openEditorFunc?: OpenEditor
     };
-    enableConfigurationService?: boolean
-    configurationServiceConfig?: {
+    configureConfigurationServiceConfig?: {
         defaultWorkspaceUri: string;
     };
     enableThemeService?: boolean;
@@ -32,7 +32,7 @@ export type InitializeServiceConfig = {
     enableDebugService?: boolean;
     enablePreferencesService?: boolean;
     enableSnippetsService?: boolean;
-    enableViewsService?: boolean;
+    enableQuickaccessService?: boolean;
     userServices?: editor.IEditorOverrideServices;
     debugLogging?: boolean;
 };
@@ -75,10 +75,24 @@ const importAllServices = async (config?: InitializeServiceConfig) => {
     // files service is required
     addService('files', import('vscode/service-override/files'));
 
-    if (lc.enableModelEditorService === true && lc.modelEditorServiceConfig !== undefined) {
-        addService('modelEditor', import('vscode/service-override/modelEditor'));
+    if (lc.enableModelService === true) {
+        addService('model', import('vscode/service-override/model'));
     }
-    if (lc.enableConfigurationService === true && lc.configurationServiceConfig !== undefined) {
+    if (lc.configureEditorOrViewsServiceConfig !== undefined) {
+        if (lc.configureEditorOrViewsServiceConfig.enableViewsService) {
+            addService('views', import('vscode/service-override/views'));
+        } else {
+            addService('editor', import('vscode/service-override/editor'));
+        }
+    }
+    if (lc.enableQuickaccessService === true) {
+        // quickaccess requires keybindings
+        if (lc.enableKeybindingsService === undefined || lc.enableKeybindingsService === false) {
+            throw new Error('"quickaccess" requires "keybindings" service. Please add it to the "initServices" config.');
+        }
+        addService('quickaccess', import('vscode/service-override/quickaccess'));
+    }
+    if (lc.configureConfigurationServiceConfig !== undefined) {
         addService('configuration', import('vscode/service-override/configuration'));
     }
     if (lc.enableDialogService === true) {
@@ -88,9 +102,11 @@ const importAllServices = async (config?: InitializeServiceConfig) => {
         addService('notifications', import('vscode/service-override/notifications'));
     }
     if (lc.enableThemeService === true) {
-        addService('theme', import('vscode/service-override/theme'));
         // theme requires textmate
-        lc.enableTextmateService = true;
+        if (lc.enableTextmateService === undefined || lc.enableTextmateService === false) {
+            throw new Error('"theme" requires "textmate" service. Please add it to the "initServices" config.');
+        }
+        addService('theme', import('vscode/service-override/theme'));
     }
     if (lc.enableTextmateService === true) {
         addService('textmate', import('vscode/service-override/textmate'));
@@ -113,9 +129,6 @@ const importAllServices = async (config?: InitializeServiceConfig) => {
     if (lc.enableSnippetsService === true) {
         addService('snippets', import('vscode/service-override/snippets'));
     }
-    if (lc.enableViewsService === true) {
-        addService('views', import('vscode/service-override/views'));
-    }
 
     const reportServiceLoading = (origin: string, services: editor.IEditorOverrideServices, debugLogging: boolean) => {
         for (const serviceName of Object.keys(services)) {
@@ -146,19 +159,18 @@ const importAllServices = async (config?: InitializeServiceConfig) => {
         }
 
         let services: editor.IEditorOverrideServices = {};
-        if (serviceName === 'modelEditor' && lc.enableModelEditorService) {
-            const defaultOpenEditorFunc: OpenEditor = async (model, options, sideBySide) => {
-                console.log('Trying to open a model', model, options, sideBySide);
-                return undefined;
-            };
-
-            if (lc.modelEditorServiceConfig?.useDefaultFunction) {
+        if (serviceName === 'editor' || serviceName === 'views') {
+            if (lc.configureEditorOrViewsServiceConfig!.useDefaultOpenEditorFunction) {
+                const defaultOpenEditorFunc: OpenEditor = async (model, options, sideBySide) => {
+                    console.log('Trying to open a model', model, options, sideBySide);
+                    return undefined;
+                };
                 services = loadedImport.default(defaultOpenEditorFunc);
-            } else if (lc.modelEditorServiceConfig?.openEditorFunc) {
-                services = loadedImport.default(lc.modelEditorServiceConfig.openEditorFunc);
+            } else if (lc.configureEditorOrViewsServiceConfig?.openEditorFunc) {
+                services = loadedImport.default(lc.configureEditorOrViewsServiceConfig.openEditorFunc);
             }
-        } else if (serviceName === 'configuration' && lc.enableConfigurationService) {
-            const uri = Uri.file(lc.configurationServiceConfig!.defaultWorkspaceUri);
+        } else if (serviceName === 'configuration') {
+            const uri = Uri.file(lc.configureConfigurationServiceConfig!.defaultWorkspaceUri);
             services = loadedImport.default(uri);
         } else {
             services = loadedImport.default();

packages/client/src/monaco-vscode-api-services.ts

@@ -23,7 +23,7 @@
     "langium": "~1.2.0",
     "langium-statemachine-dsl": "~1.2.0",
     "monaco-editor-workers": "0.38.0",
-    "monaco-languageclient": "6.1.0-next.0",
+    "monaco-languageclient": "6.1.0-next.1",
     "normalize-url": "~8.0.0",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
@@ -49,7 +49,7 @@
     "npm": "9.6.6"
   },
   "scripts": {
-    "clean": "npx shx rm -fr dist *.tsbuildinfo",
+    "clean": "shx rm -fr dist *.tsbuildinfo",
     "compile": "tsc --build tsconfig.src.json",
     "build:msg": "echo Building main examples:",
     "build:worker:vite": "vite --config  vite.langium-worker.ts build",

packages/examples/main/package.json

@@ -3,14 +3,12 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 import { languages, workspace, TextDocument as VsCodeTextDocument } from 'vscode';
-
-import { buildWorkerDefinition } from 'monaco-editor-workers';
-
 import { getLanguageService, TextDocument } from 'vscode-json-languageservice';
 import { createConverter as createCodeConverter } from 'vscode-languageclient/lib/common/codeConverter.js';
 import { createConverter as createProtocolConverter } from 'vscode-languageclient/lib/common/protocolConverter.js';
 import { createDefaultJsonContent, createJsonEditor } from '../common.js';
 
+import { buildWorkerDefinition } from 'monaco-editor-workers';
 buildWorkerDefinition('../../../node_modules/monaco-editor-workers/dist/workers/', new URL('', window.location.href).href, false);
 
 const codeConverter = createCodeConverter();

packages/examples/main/src/browser/main.ts

@@ -3,9 +3,8 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 
-import { buildWorkerDefinition } from 'monaco-editor-workers';
 import { createDefaultJsonContent, createJsonEditor, createUrl, createWebSocket } from '../common.js';
-
+import { buildWorkerDefinition } from 'monaco-editor-workers';
 buildWorkerDefinition('../../../node_modules/monaco-editor-workers/dist/workers/', new URL('', window.location.href).href, false);
 
 const start = async () => {

packages/examples/main/src/client/main.ts

@@ -3,15 +3,17 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 
-import 'monaco-editor/esm/vs/editor/edcore.main.js';
+import 'monaco-editor/esm/vs/editor/editor.all.js';
+import 'monaco-editor/esm/vs/editor/standalone/browser/accessibilityHelp/accessibilityHelp.js';
+import 'monaco-editor/esm/vs/editor/standalone/browser/iPadShowKeyboard/iPadShowKeyboard.js';
 import { editor, languages, Uri } from 'monaco-editor/esm/vs/editor/editor.api.js';
 import { createConfiguredEditor, createModelReference, IReference, ITextFileEditorModel } from 'vscode/monaco';
+import 'vscode/default-extensions/theme-defaults';
+import 'vscode/default-extensions/json';
 import { initServices, MonacoLanguageClient } from 'monaco-languageclient';
 import normalizeUrl from 'normalize-url';
 import { CloseAction, ErrorAction, MessageTransports } from 'vscode-languageclient';
 import { WebSocketMessageReader, WebSocketMessageWriter, toSocket } from 'vscode-ws-jsonrpc';
-import 'vscode/default-extensions/theme-defaults';
-import 'vscode/default-extensions/json';
 
 export const createLanguageClient = (transports: MessageTransports): MonacoLanguageClient => {
     return new MonacoLanguageClient({
@@ -79,11 +81,15 @@ export const createJsonEditor = async (config: {
     if (config.init === true) {
         await initServices({
             enableThemeService: true,
-            enableModelEditorService: true,
-            modelEditorServiceConfig: {
-                useDefaultFunction: true
+            enableTextmateService: true,
+            enableModelService: true,
+            configureEditorOrViewsServiceConfig: {
+                enableViewsService: false,
+                useDefaultOpenEditorFunction: true
             },
             enableLanguagesService: true,
+            enableKeybindingsService: true,
+            enableQuickaccessService: true,
             debugLogging: true
         });
     }