Merge pull request #43 from CodinGame/update-to-monaco-vscode-api

Use monaco-vscode-api

Author: CGNonofr

browserMock.js

@@ -49,4 +49,11 @@ Object.defineProperty(window, 'ResizeObserver', {
     constructor(stringUrl) {}
     observe() {}
   }
+})
+
+Object.defineProperty(window, 'TextEncoder', {
+  value: class TextObserver {
+    constructor(stringUrl) {}
+    encode(src) { return src }
+  }
 })

package-lock.json

@@ -25,6 +25,7 @@
     "@codingame/monaco-editor-wrapper": "^1.14.5",
     "@codingame/monaco-jsonrpc": "^0.4.0",
     "sweetalert": "^2.1.2",
+    "vscode": "npm:@codingame/monaco-vscode-api@^1.68.2",
     "vscode-languageserver-protocol": "^3.17.1"
   },
   "devDependencies": {
@@ -46,7 +47,7 @@
     "@types/jest": "^28.1.1",
     "@types/once": "^1.4.0",
     "@types/rollup-plugin-node-builtins": "^2.1.2",
-    "@types/vscode": "^1.67.0",
+    "@types/vscode": "^1.68.0",
     "@typescript-eslint/eslint-plugin": "5.27.1",
     "@typescript-eslint/parser": "5.27.1",
     "canvas": "^2.9.1",
@@ -62,7 +63,7 @@
     "eslint-plugin-unused-imports": "2.0.0",
     "jest": "^28.1.1",
     "jest-environment-jsdom": "^28.1.1",
-    "monaco-languageclient": "^1.1.0",
+    "monaco-languageclient": "^2.0.0-dev.0",
     "proxy-polyfill": "^0.3.2",
     "rollup": "2.75.6",
     "rollup-plugin-dts": "^4.2.2",
@@ -108,7 +109,6 @@
       ]
     },
     "moduleNameMapper": {
-      "^vscode$": "monaco-languageclient/vscode-compatibility",
       "^monaco-editor$": "monaco-editor/esm/vs/editor/editor.api",
       "^monaco-editor-core$": "monaco-editor/esm/vs/editor/editor.api"
     }

package.json

@@ -75,9 +75,6 @@ export default rollup.defineConfig({
       }, {
         find: /^(monaco-editor|monaco-editor-core)$/,
         replacement: 'monaco-editor/esm/vs/editor/editor.api'
-      }, {
-        find: 'vscode',
-        replacement: require.resolve('monaco-languageclient/vscode-compatibility')
       }]
     }),
     {

rollup.config.ts

@@ -1,8 +1,9 @@
 import { MessageReader, MessageWriter, Message, Event, DataCallback, Disposable, PartialMessageInfo } from 'vscode-jsonrpc'
 import { Uri } from 'monaco-editor'
 import {
-  MonacoLanguageClient, Middleware, ErrorHandler, IConnectionProvider, InitializeParams, RegistrationRequest, RegistrationParams, UnregistrationRequest, UnregistrationParams, LanguageClientOptions, MessageTransports, InitializeRequest
+  MonacoLanguageClient, Middleware, ErrorHandler, IConnectionProvider, LanguageClientOptions, MessageTransports
 } from 'monaco-languageclient'
+import { InitializeParams, InitializeRequest, RegistrationParams, RegistrationRequest, UnregistrationParams, UnregistrationRequest } from 'vscode-languageserver-protocol'
 import { registerExtensionFeatures } from './extensions'
 import { LanguageClientId } from './languageClientOptions'
 import { Infrastructure } from './infrastructure'

src/createLanguageClient.ts

@@ -1,10 +1,10 @@
 import { monaco, registerTextModelContentProvider } from '@codingame/monaco-editor-wrapper'
 import {
-  Disposable,
-  ServerCapabilities, DocumentSelector, MonacoLanguageClient, Services,
-  TextDocumentSyncOptions, TextDocument, DidSaveTextDocumentNotification, Emitter, DisposableCollection
+  Disposable, MonacoLanguageClient, DisposableCollection
 } from 'monaco-languageclient'
 import { StaticFeature, FeatureState, ProtocolRequestType } from 'vscode-languageclient/lib/common/api'
+import { DidSaveTextDocumentNotification, DocumentSelector, Emitter, ServerCapabilities, TextDocumentSyncOptions } from 'vscode-languageserver-protocol'
+import * as vscode from 'vscode'
 import { updateFile, willShutdownNotificationType, WillShutdownParams } from './customRequests'
 import { Infrastructure } from './infrastructure'
 import { LanguageClient, LanguageClientManager } from './languageClient'
@@ -28,22 +28,22 @@ export class InitializeTextDocumentFeature implements StaticFeature {
     }
 
     const languageClient = this.languageClient
-    async function saveFile (textDocument: TextDocument) {
-      if (Services.get().languages.match(documentSelector!, textDocument)) {
-        await updateFile(textDocument.uri, textDocument.getText(), languageClient)
+    async function saveFile (textDocument: vscode.TextDocument) {
+      if (documentSelector != null && vscode.languages.match(documentSelector, textDocument) > 0) {
+        await updateFile(textDocument.uri.toString(), textDocument.getText(), languageClient)
 
         // Always send notification even if the server doesn't support it (because csharp register the didSave feature too late)
-        languageClient.sendNotification(DidSaveTextDocumentNotification.type, {
+        await languageClient.sendNotification(DidSaveTextDocumentNotification.type, {
           textDocument: {
-            uri: textDocument.uri
+            uri: textDocument.uri.toString()
           },
           text: textDocument.getText()
         })
       }
     }
 
-    this.didOpenTextDocumentDisposable = Services.get().workspace.onDidOpenTextDocument(saveFile)
-    Services.get().workspace.textDocuments.forEach(saveFile)
+    this.didOpenTextDocumentDisposable = vscode.workspace.onDidOpenTextDocument(saveFile)
+    vscode.workspace.textDocuments.forEach(saveFile)
   }
 
   getState (): FeatureState {
@@ -66,18 +66,18 @@ class CobolResolveSubroutineFeature implements StaticFeature {
   fillClientCapabilities (): void {}
 
   initialize (capabilities: ServerCapabilities, documentSelector: DocumentSelector): void {
-    this.onRequestDisposable = this.languageClient.onRequest(ResolveCobolSubroutineRequestType, (routineName: string) => {
+    this.onRequestDisposable = this.languageClient.onRequest(ResolveCobolSubroutineRequestType, (routineName: string): string => {
       const constantRoutinePaths: Partial<Record<string, string>> = {
-        'assert-equals': `${Services.get().workspace.rootUri ?? 'file:/tmp/project'}/deps/assert-equals.cbl`
+        'assert-equals': `file:${vscode.workspace.rootPath ?? '/tmp/project'}/deps/assert-equals.cbl`
       }
       const contantRoutinePath = constantRoutinePaths[routineName.toLowerCase()]
       if (contantRoutinePath != null) {
         return contantRoutinePath
       }
-      return Services.get().workspace.textDocuments
-        .filter(textDocument => Services.get().languages.match(documentSelector, textDocument))
+      return vscode.workspace.textDocuments
+        .filter(textDocument => vscode.languages.match(documentSelector, textDocument))
         .filter(document => document.getText().match(new RegExp(`PROGRAM-ID\\.\\W+${routineName}\\.`, 'gi')))
-        .sort((a, b) => a.uri.localeCompare(b.uri))[0]?.uri
+        .sort((a, b) => a.uri.toString().localeCompare(b.uri.toString()))[0]?.uri.toString()
     })
   }
 
@@ -131,9 +131,9 @@ export class FileSystemFeature implements StaticFeature {
       }
     }))
     disposableCollection.push(getServices().workspace.registerSaveDocumentHandler({
-      async saveTextContent (textDocument, reason) {
-        if (languageClientManager.isModelManaged(textDocument)) {
-          await infrastructure.saveFileContent?.(textDocument, reason, languageClientManager)
+      async saveTextContent (document, reason) {
+        if (languageClientManager.isModelManaged(document)) {
+          await infrastructure.saveFileContent?.(document, reason, languageClientManager)
         }
       }
     }))

src/extensions.ts

@@ -1,4 +1,4 @@
-import { MessageTransports, TextDocument, TextDocumentSaveReason } from 'monaco-languageclient'
+import { MessageTransports } from 'monaco-languageclient'
 import 'proxy-polyfill'
 import type { WorkspaceFolder } from 'vscode'
 import { CodinGameInfrastructure, Infrastructure } from './infrastructure'
@@ -24,8 +24,6 @@ export type {
   WillShutdownParams,
   Infrastructure,
   WorkspaceFolder,
-  TextDocument,
-  TextDocumentSaveReason,
   LanguageClientOptions,
   LanguageClientManagerOptions,
   MessageTransports

src/index.ts

@@ -1,7 +1,9 @@
 import { IWebSocket, WebSocketMessageReader, WebSocketMessageWriter, toSocket } from '@codingame/monaco-jsonrpc'
-import { MessageTransports, TextDocument, TextDocumentSaveReason } from 'monaco-languageclient'
+import { MessageTransports } from 'monaco-languageclient'
 import * as monaco from 'monaco-editor'
 import type * as vscode from 'vscode'
+import { TextDocument } from 'vscode-languageserver-textdocument'
+import { TextDocumentSaveReason } from 'vscode-languageserver-protocol'
 import { getFile, updateFile } from './customRequests'
 import { LanguageClientManager } from './languageClient'
 import { LanguageClientId, LanguageClientOptions } from './languageClientOptions'
@@ -33,7 +35,7 @@ export interface Infrastructure {
    * @param reason The reason of the save
    * @param languageClient The languageclient we're trying to save the file to
    */
-  saveFileContent? (document: TextDocument, reason: TextDocumentSaveReason, languageClient: LanguageClientManager): Promise<void>
+  saveFileContent? (document: vscode.TextDocument, reason: vscode.TextDocumentSaveReason, languageClient: LanguageClientManager): Promise<void>
   /**
    * Get a text file content as a model
    * @param resource the Uri of the file
@@ -96,7 +98,7 @@ export abstract class CodinGameInfrastructure implements Infrastructure {
     name: 'main'
   }]
 
-  public async saveFileContent (document: TextDocument, reason: TextDocumentSaveReason, languageClient: LanguageClientManager): Promise<void> {
+  public async saveFileContent (document: vscode.TextDocument, reason: TextDocumentSaveReason, languageClient: LanguageClientManager): Promise<void> {
     if (languageClient.isConnected()) {
       await updateFile(document.uri.toString(), document.getText(), languageClient)
     }

src/infrastructure.ts

@@ -1,8 +1,10 @@
 import * as monaco from 'monaco-editor'
 import {
-  CloseAction, ErrorAction, MonacoLanguageClient, Emitter, Event, TextDocument, Services, State, DisposableCollection, CancellationToken, RequestType, NotificationType, LogMessageNotification
+  CloseAction, ErrorAction, MonacoLanguageClient, State, DisposableCollection
 } from 'monaco-languageclient'
 import delay from 'delay'
+import { CancellationToken, Emitter, NotificationType, RequestType, Event, LogMessageNotification } from 'vscode-languageserver-protocol'
+import * as vscode from 'vscode'
 import { updateServices } from './services'
 import createLanguageClient from './createLanguageClient'
 import { WillShutdownParams } from './customRequests'
@@ -12,7 +14,7 @@ import { getLanguageClientOptions, LanguageClientId, LanguageClientOptions } fro
 import { Infrastructure } from './infrastructure'
 
 export interface LanguageClient {
-  sendNotification<P>(type: NotificationType<P>, params?: P): void
+  sendNotification<P>(type: NotificationType<P>, params?: P): Promise<void>
   sendRequest<P, R, E> (request: RequestType<P, R, E>, params: P, token?: CancellationToken): Promise<R>
 }
 
@@ -94,11 +96,11 @@ export class LanguageClientManager implements LanguageClient {
     return this.onErrorEmitter.event
   }
 
-  isModelManaged (document: TextDocument): boolean {
+  isModelManaged (document: vscode.TextDocument): boolean {
     if (this.clientOptions.documentSelector == null) {
       return false
     }
-    return Services.get().languages.match(this.clientOptions.documentSelector, document)
+    return vscode.languages.match(this.clientOptions.documentSelector, document) > 0
   }
 
   isDisposed (): boolean {