Merge pull request #520 from TypeFox/monaco-0.41

Update to monaco-vscode-api 1.81.0 and monaco-editor 0.41.0

README.md

@@ -78,6 +78,7 @@ The following table describes which version of **monaco-languageclient** and **m
 
 | monaco-languageclient | monaco-vscode-api | monaco-editor | comment |
 | :----         | :----   | :---   | :--- |
+| 6.4.0         | 1.81.0  | 0.41.0 | Released 2023-08-1x |
 | 6.3.0         | 1.80.2  | 0.40.0 | Released 2023-08-04 |
 | 6.2.0         | 1.79.3  | 0.39.0 | Released 2023-06-16 |
 | 6.1.0         | 1.79.1  | 0.38.0 | Released 2023-06-12 |
@@ -251,7 +252,7 @@ loader.config({ monaco });
 If you use pnpm, you have to add `vscode` / `monaco-vscode-api` as direct dependency (see the [following table](#monaco-editor--monaco-vscode-api-compatibility-table)), otherwise the installation will fail.
 
 ```json
-"vscode": "npm:@codingame/monaco-vscode-api@~1.80.2"
+"vscode": "npm:@codingame/monaco-vscode-api@~1.81.0"
 ```
 
 ## Licenses

packages/client/CHANGELOG.md

@@ -2,7 +2,11 @@
 
 All notable changes to this npm module are documented in this file.
 
-## [6.3.0] - 2023-08-0x
+## [6.4.0] - 2023-08-1x
+
+- Update to `monaco-editor` `0.41.0` and `monaco-vscode-api` `1.81.0` [#51x](https://github.com/TypeFox/monaco-languageclient/pull/51x)
+
+## [6.3.0] - 2023-08-04
 
 - Update to `monaco-editor` `0.40.0` and `monaco-vscode-api` `1.80.2` [#513](https://github.com/TypeFox/monaco-languageclient/pull/513)
   - vscode api services have been cleaned-up and fully aligned with `monaco-vscode-api

packages/client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "monaco-languageclient",
-  "version": "6.3.0",
+  "version": "6.4.0",
   "description": "Monaco Language client implementation",
   "author": {
     "name": "TypeFox GmbH",
@@ -48,14 +48,14 @@
     "License.txt"
   ],
   "dependencies": {
-    "monaco-editor": "~0.40.0",
-    "vscode": "npm:@codingame/monaco-vscode-api@1.80.2",
+    "monaco-editor": "~0.41.0",
+    "vscode": "npm:@codingame/monaco-vscode-api@1.81.0",
     "vscode-jsonrpc": "~8.1.0",
     "vscode-languageclient": "~8.1.0"
   },
   "peerDependencies": {
-    "monaco-editor": "~0.40.0",
-    "vscode": "npm:@codingame/monaco-vscode-api@1.80.2"
+    "monaco-editor": "~0.41.0",
+    "vscode": "npm:@codingame/monaco-vscode-api@1.81.0"
   },
   "peerDependenciesMeta": {
     "monaco-editor": {

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

@@ -17,6 +17,9 @@ export type InitializeServiceConfig = {
     enableDialogService?: boolean;
     enableNotificationService?: boolean;
     enableModelService?: boolean;
+    /**
+     * editor service is the default. If you want to use the views service, set enableViewsService to true.
+     */
     configureEditorOrViewsServiceConfig?: {
         enableViewsService?: boolean;
         openEditorFunc?: OpenEditor
@@ -179,21 +182,25 @@ export const importAllServices = async (config?: InitializeServiceConfig) => {
         reportServiceLoading(userServices, lc.debugLogging === true, 'user');
     }
 
+    const haveThemeService = serviceNames.includes('theme') || Object.keys(overrideServices).includes('themeService');
+    const haveTextmateService = serviceNames.includes('textmate') || Object.keys(overrideServices).includes('textMateTokenizationFeature');
+    const haveQuickaccessService = serviceNames.includes('quickaccess') || Object.keys(overrideServices).includes('quickInputService');
+    const haveKeybindingsService = serviceNames.includes('keybindings') || Object.keys(overrideServices).includes('keybindingService');
+    const haveMarkersService = serviceNames.includes('markers');
+    const haveViewsService = serviceNames.includes('views') || Object.keys(overrideServices).includes('viewsService');
+
     // theme requires textmate
-    if ((serviceNames.includes('theme') || Object.keys(overrideServices).includes('themeService')) &&
-        !(serviceNames.includes('textmate') || Object.keys(overrideServices).includes('textMateTokenizationFeature'))) {
+    if (haveThemeService && !haveTextmateService) {
         throw new Error('"theme" requires "textmate" service. Please add it to the "initServices" config.');
     }
 
     // quickaccess requires keybindings
-    if ((serviceNames.includes('quickaccess') || Object.keys(overrideServices).includes('quickInputService')) &&
-        !(serviceNames.includes('keybindings') || Object.keys(overrideServices).includes('keybindingService'))) {
+    if (haveQuickaccessService && !haveKeybindingsService) {
         throw new Error('"quickaccess" requires "keybindings" service. Please add it to the "initServices" config.');
     }
 
     // markers service requires views service
-    if (serviceNames.includes('markers') &&
-        !(serviceNames.includes('views') || Object.keys(overrideServices).includes('viewsService'))) {
+    if (haveMarkersService && !haveViewsService) {
         throw new Error('"markers" requires "views" service. Please add it to the "initServices" config.');
     }
 

packages/examples/main/package.json

@@ -22,8 +22,8 @@
     "express": "~4.18.2",
     "langium": "~1.2.1",
     "langium-statemachine-dsl": "~1.2.0",
-    "monaco-editor-workers": "0.40.0",
-    "monaco-languageclient": "~6.3.0",
+    "monaco-editor-workers": "~0.41.0",
+    "monaco-languageclient": "~6.4.0",
     "normalize-url": "~8.0.0",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",

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

@@ -6,7 +6,7 @@ import { languages, workspace, TextDocument as VsCodeTextDocument } from 'vscode
 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 { createDefaultJsonContent, createJsonEditor, performInit } from '../common.js';
 
 import { buildWorkerDefinition } from 'monaco-editor-workers';
 buildWorkerDefinition('../../../node_modules/monaco-editor-workers/dist/workers/', new URL('', window.location.href).href, false);
@@ -17,10 +17,16 @@ const protocolConverter = createProtocolConverter(undefined, true, true);
 const createEditor = async () => {
     let mainVscodeDocument: VsCodeTextDocument | undefined;
     const languageId = 'json';
+
+    await performInit(true);
+
+    workspace.onDidOpenTextDocument((_event) => {
+        mainVscodeDocument = workspace.textDocuments[0];
+    });
+
     const jsonEditor = await createJsonEditor({
         htmlElement: document.getElementById('container')!,
-        content: createDefaultJsonContent(),
-        init: true
+        content: createDefaultJsonContent()
     });
 
     const createDocument = (vscodeDocument: VsCodeTextDocument) => {
@@ -120,11 +126,6 @@ const createEditor = async () => {
     jsonEditor.modelRef.object.textEditorModel!.onDidChangeContent(() => {
         validate();
     });
-
-    workspace.onDidOpenTextDocument((_event) => {
-        mainVscodeDocument = workspace.textDocuments[0];
-        validate();
-    });
 };
 
 createEditor();

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

@@ -3,16 +3,16 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 
-import { createDefaultJsonContent, createJsonEditor, createUrl, createWebSocket } from '../common.js';
+import { createDefaultJsonContent, createJsonEditor, createUrl, createWebSocket, performInit } 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 () => {
     // use the same common method to create a monaco editor for json
+    await performInit(true);
     await createJsonEditor({
         htmlElement: document.getElementById('container')!,
-        content: createDefaultJsonContent(),
-        init: true
+        content: createDefaultJsonContent()
     });
 
     // create the web socket

packages/examples/main/src/common.ts

@@ -70,14 +70,8 @@ export type ExampleJsonEditor = {
     modelRef: IReference<ITextFileEditorModel>;
 }
 
-export const createJsonEditor = async (config: {
-    htmlElement: HTMLElement,
-    content: string,
-    init: boolean
-}) => {
-    const languageId = 'json';
-
-    if (config.init === true) {
+export const performInit = async (vscodeApiInit: boolean) => {
+    if (vscodeApiInit === true) {
         await initServices({
             enableThemeService: true,
             enableTextmateService: true,
@@ -89,22 +83,27 @@ export const createJsonEditor = async (config: {
             enableQuickaccessService: true,
             enableOutputService: true,
             enableAccessibilityService: true,
-            debugLogging: true
+            debugLogging: false
         });
-    }
 
-    // register the JSON language with Monaco
-    languages.register({
-        id: languageId,
-        extensions: ['.json', '.jsonc'],
-        aliases: ['JSON', 'json'],
-        mimetypes: ['application/json']
-    });
+        // register the JSON language with Monaco
+        languages.register({
+            id: 'json',
+            extensions: ['.json', '.jsonc'],
+            aliases: ['JSON', 'json'],
+            mimetypes: ['application/json']
+        });
+    }
+};
 
+export const createJsonEditor = async (config: {
+    htmlElement: HTMLElement,
+    content: string
+}) => {
     // create the model
     const uri = Uri.parse('/tmp/model.json');
     const modelRef = await createModelReference(uri, config.content);
-    modelRef.object.setLanguageId(languageId);
+    modelRef.object.setLanguageId('json');
 
     // create monaco editor
     const editor = createConfiguredEditor(config.htmlElement, {
@@ -117,7 +116,6 @@ export const createJsonEditor = async (config: {
     });
 
     const result = {
-        languageId,
         editor,
         uri,
         modelRef

packages/examples/main/src/langium/statemachineClient.ts

@@ -15,7 +15,6 @@ import { ExtensionHostKind, registerExtension } from 'vscode/extensions';
 import { updateUserConfiguration } from 'vscode/service-override/configuration';
 import getAccessibilityServiceOverride from 'vscode/service-override/accessibility';
 import { LogLevel } from 'vscode/services';
-// import { renderPanelPart } from 'vscode/service-override/views';
 import 'vscode/default-extensions/theme-defaults';
 
 import { buildWorkerDefinition } from 'monaco-editor-workers';
@@ -146,7 +145,6 @@ try {
         debugLogging: true,
         logLevel: LogLevel.Info
     });
-    // renderPanelPart(document.querySelector<HTMLDivElement>('#panel')!);
     await setup();
     await run();
 } catch (e) {

packages/examples/main/src/react/app.tsx

@@ -2,7 +2,7 @@
  * Copyright (c) 2018-2022 TypeFox GmbH (http://www.typefox.io). All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
-import { createJsonEditor, createUrl, createWebSocket } from '../common.js';
+import { createJsonEditor, createUrl, createWebSocket, performInit } from '../common.js';
 import { editor } from 'monaco-editor/esm/vs/editor/editor.api.js';
 import React, { createRef, useEffect, useMemo, useRef } from 'react';
 
@@ -36,10 +36,10 @@ export const ReactMonacoEditor: React.FC<EditorProps> = ({
 
         if (ref.current != null) {
             const start = async () => {
+                await performInit(true);
                 await createJsonEditor({
                     htmlElement: ref.current!,
-                    content: defaultCode,
-                    init
+                    content: defaultCode
                 });
                 if (init) {
                     init = false;

packages/examples/main/statemachine_client.html

@@ -11,7 +11,6 @@
     <h2>Client & Statemachine DSL Web Worker Language Server Example</h2>
     <div id="container" style="width:800px;height:600px;border:1px solid grey"></div>
     <script type="module" src="./src/langium/statemachineClient.ts"></script>
-    <div id="panel"></div>
 </body>
 
 </html>

packages/verify/pnpm/package.json

@@ -3,9 +3,9 @@
   "version": "0.0.0",
   "private": "true",
   "dependencies": {
-    "monaco-languageclient": "~6.3.0",
-    "monaco-editor": "~0.40.0",
-    "vscode": "npm:@codingame/monaco-vscode-api@~1.80.2"
+    "monaco-languageclient": "~6.4.0",
+    "monaco-editor": "~0.41.0",
+    "vscode": "npm:@codingame/monaco-vscode-api@1.81.0"
   },
   "devDependencies": {
     "shx": "~0.3.4"
@@ -18,4 +18,4 @@
     "node": "18.17.0",
     "npm": "9.6.7"
   }
-}
+}

packages/verify/vite/package.json

@@ -4,8 +4,8 @@
   "private": true,
   "type": "module",
   "dependencies": {
-    "monaco-editor-workers": "0.40.0",
-    "monaco-languageclient": "~6.3.0",
+    "monaco-editor-workers": "~0.41.0",
+    "monaco-languageclient": "~6.4.0",
     "examples-main": "../../examples/main",
     "vscode-ws-jsonrpc": "3.0.0",
     "normalize-url": "~8.0.0"

packages/verify/vite/src/client/main.ts

@@ -3,16 +3,16 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 
-import { createDefaultJsonContent, createJsonEditor, createUrl, createWebSocket } from 'examples-main';
+import { createDefaultJsonContent, createJsonEditor, createUrl, createWebSocket, performInit } from 'examples-main';
 import { buildWorkerDefinition } from 'monaco-editor-workers';
 buildWorkerDefinition('./workers', new URL('', window.location.href).href, false);
 
 const start = async () => {
     // use the same common method to create a monaco editor for json
+    await performInit(true);
     await createJsonEditor({
         htmlElement: document.getElementById('container')!,
-        content: createDefaultJsonContent(),
-        init: true
+        content: createDefaultJsonContent()
     });
 
     // create the web socket

packages/verify/webpack/package.json

@@ -4,8 +4,8 @@
   "private": true,
   "type": "module",
   "dependencies": {
-    "monaco-editor-workers": "0.40.0",
-    "monaco-languageclient": "~6.3.0",
+    "monaco-editor-workers": "~0.41.0",
+    "monaco-languageclient": "~6.4.0",
     "examples-main": "../../examples/main",
     "vscode-ws-jsonrpc": "3.0.0",
     "normalize-url": "~8.0.0"

packages/verify/webpack/src/client/main.ts

@@ -3,16 +3,16 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 
-import { createDefaultJsonContent, createJsonEditor, createUrl, createWebSocket } from 'examples-main';
+import { createDefaultJsonContent, createJsonEditor, createUrl, createWebSocket, performInit } from 'examples-main';
 import { buildWorkerDefinition } from 'monaco-editor-workers';
 buildWorkerDefinition('dist/client/workers', new URL('', window.location.href).href, false);
 
 const start = async () => {
     // use the same common method to create a monaco editor for json
+    await performInit(true);
     await createJsonEditor({
         htmlElement: document.getElementById('container')!,
-        content: createDefaultJsonContent(),
-        init: true
+        content: createDefaultJsonContent()
     });
 
     // create the web socket

packages/verify/yarn/package.json

@@ -3,7 +3,7 @@
   "version": "0.0.0",
   "private": "true",
   "dependencies": {
-    "monaco-languageclient": "~6.3.0"
+    "monaco-languageclient": "~6.4.0"
   },
   "devDependencies": {
     "shx": "~0.3.4"