@codingame/monaco-vscode-api 1.68.2 → 1.68.5

package/README.md

@@ -42,3 +42,26 @@ import * as vscode from 'vscode'
 const range = new new vscode.Range(...)
 vscode.languages.registerCompletionItemProvider(...)
 ```
+
+### History
+
+This project was mainly created to make the implementation of [monaco-languageclient](https://github.com/TypeFox/monaco-languageclient) more robust and maintainable.
+
+monaco-languageclient uses [vscode-languageclient](https://www.npmjs.com/package/vscode-languageclient) which was built to run inside a VSCode extension. VSCode extensions communicate with the editor via an [API](https://www.npmjs.com/package/@types/vscode) they can import into their code.
+
+[The VSCode api](https://code.visualstudio.com/api/references/vscode-api) exports:
+- Some functions to interact with the IDE ([language feature registrations](https://code.visualstudio.com/api/references/vscode-api#languages), [command execution](https://code.visualstudio.com/api/references/vscode-api#commands)...)
+- A lot of utility classes (Range, Position...)
+
+The first implementations of [monaco-languageclient](https://github.com/TypeFox/monaco-languageclient) were using a fake VSCode api implementation. The vscode-languageclient was hacked so the VSCode<->protocol object converters were mainly bypassed, so the fake VSCode api was receiving [Language Server Protocol](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/) objects. Then the objects were transformed using custom transformers into [Monaco](https://www.npmjs.com/package/monaco-editor) objects to communicate with the monaco api.
+
+This approach has some disadvantages:
+- There is a lot of code to transform LSP objects into Monaco objects
+- It's hard to follow the updates of VSCode and the language server protocol
+- It doesn't behave exactly the same as in VSCode
+
+With this library, it would be possible to plug vscode-languageclient directly on top of monaco, monaco-languageclient still helps to do so by:
+- Adding some tweaks to the VSCode LanguageClient (Removing unsupported features...)
+- Providing a default implementations of the required fallback services (`vscode/services`)
+- Providing some examples on how to build an app using it
+- Adding some tools (DisposableCollection)

package/dist/api.amd.js

@@ -8767,7 +8767,9 @@ define(['exports', 'monaco-editor/esm/vs/base/common/errors.js', 'monaco-editor/
         },
         registerCodeLensProvider(documentSelector, provider) {
             const adapter = new CodeLensAdapter(extHostDocuments, extHostCommands.converter, provider);
-            return monaco__namespace.languages.registerCodeLensProvider(documentSelector, {
+            const onDidChangeCodeLenses = provider.onDidChangeCodeLenses;
+            const monacoProvider = {
+                onDidChange: onDidChangeCodeLenses != null ? listener => onDidChangeCodeLenses(() => listener(monacoProvider)) : undefined,
                 provideCodeLenses: async (model, token) => {
                     const listDto = await adapter.provideCodeLenses(model.uri, token);
                     if (listDto == null) {
@@ -8781,7 +8783,8 @@ define(['exports', 'monaco-editor/esm/vs/base/common/errors.js', 'monaco-editor/
                 resolveCodeLens: (_model, codeLens, token) => {
                     return adapter.resolveCodeLens(codeLens, token);
                 }
-            });
+            };
+            return monaco__namespace.languages.registerCodeLensProvider(documentSelector, monacoProvider);
         },
         registerDefinitionProvider(documentSelector, provider) {
             const adapter = new DefinitionAdapter(extHostDocuments, provider);
@@ -8996,6 +8999,7 @@ define(['exports', 'monaco-editor/esm/vs/base/common/errors.js', 'monaco-editor/
             const adapter = new DocumentSemanticTokensAdapter(extHostDocuments, provider);
             return monaco__namespace.languages.registerDocumentSemanticTokensProvider(documentSelector, {
                 getLegend: () => legend,
+                onDidChange: provider.onDidChangeSemanticTokens,
                 provideDocumentSemanticTokens: async (model, lastResultId, token) => {
                     const nLastResultId = lastResultId != null ? parseInt(lastResultId, 10) : 0;
                     const encodedDto = await adapter.provideDocumentSemanticTokens(model.uri, nLastResultId, token);
@@ -9051,6 +9055,7 @@ define(['exports', 'monaco-editor/esm/vs/base/common/errors.js', 'monaco-editor/
             const adapter = new InlayHintsAdapter(extHostDocuments, extHostCommands.converter, provider, extHostLogService, extensionDescription);
             return monaco__namespace.languages.registerInlayHintsProvider(documentSelector, {
                 displayName: ExtHostLanguageFeatures._extLabel(extensionDescription),
+                onDidChangeInlayHints: provider.onDidChangeInlayHints,
                 provideInlayHints: async (model, range, token) => {
                     const result = await adapter.provideInlayHints(model.uri, range, token);
                     if (result == null) {

package/dist/api.cjs

@@ -8810,7 +8810,9 @@ const workspace$2 = {
     },
     registerCodeLensProvider(documentSelector, provider) {
         const adapter = new CodeLensAdapter(extHostDocuments, extHostCommands.converter, provider);
-        return monaco__namespace.languages.registerCodeLensProvider(documentSelector, {
+        const onDidChangeCodeLenses = provider.onDidChangeCodeLenses;
+        const monacoProvider = {
+            onDidChange: onDidChangeCodeLenses != null ? listener => onDidChangeCodeLenses(() => listener(monacoProvider)) : undefined,
             provideCodeLenses: async (model, token) => {
                 const listDto = await adapter.provideCodeLenses(model.uri, token);
                 if (listDto == null) {
@@ -8824,7 +8826,8 @@ const workspace$2 = {
             resolveCodeLens: (_model, codeLens, token) => {
                 return adapter.resolveCodeLens(codeLens, token);
             }
-        });
+        };
+        return monaco__namespace.languages.registerCodeLensProvider(documentSelector, monacoProvider);
     },
     registerDefinitionProvider(documentSelector, provider) {
         const adapter = new DefinitionAdapter(extHostDocuments, provider);
@@ -9039,6 +9042,7 @@ const workspace$2 = {
         const adapter = new DocumentSemanticTokensAdapter(extHostDocuments, provider);
         return monaco__namespace.languages.registerDocumentSemanticTokensProvider(documentSelector, {
             getLegend: () => legend,
+            onDidChange: provider.onDidChangeSemanticTokens,
             provideDocumentSemanticTokens: async (model, lastResultId, token) => {
                 const nLastResultId = lastResultId != null ? parseInt(lastResultId, 10) : 0;
                 const encodedDto = await adapter.provideDocumentSemanticTokens(model.uri, nLastResultId, token);
@@ -9094,6 +9098,7 @@ const workspace$2 = {
         const adapter = new InlayHintsAdapter(extHostDocuments, extHostCommands.converter, provider, extHostLogService, extensionDescription);
         return monaco__namespace.languages.registerInlayHintsProvider(documentSelector, {
             displayName: ExtHostLanguageFeatures._extLabel(extensionDescription),
+            onDidChangeInlayHints: provider.onDidChangeInlayHints,
             provideInlayHints: async (model, range, token) => {
                 const result = await adapter.provideInlayHints(model.uri, range, token);
                 if (result == null) {

package/dist/api.js

@@ -8788,7 +8788,9 @@ const workspace$2 = {
     },
     registerCodeLensProvider(documentSelector, provider) {
         const adapter = new CodeLensAdapter(extHostDocuments, extHostCommands.converter, provider);
-        return monaco.languages.registerCodeLensProvider(documentSelector, {
+        const onDidChangeCodeLenses = provider.onDidChangeCodeLenses;
+        const monacoProvider = {
+            onDidChange: onDidChangeCodeLenses != null ? listener => onDidChangeCodeLenses(() => listener(monacoProvider)) : undefined,
             provideCodeLenses: async (model, token) => {
                 const listDto = await adapter.provideCodeLenses(model.uri, token);
                 if (listDto == null) {
@@ -8802,7 +8804,8 @@ const workspace$2 = {
             resolveCodeLens: (_model, codeLens, token) => {
                 return adapter.resolveCodeLens(codeLens, token);
             }
-        });
+        };
+        return monaco.languages.registerCodeLensProvider(documentSelector, monacoProvider);
     },
     registerDefinitionProvider(documentSelector, provider) {
         const adapter = new DefinitionAdapter(extHostDocuments, provider);
@@ -9017,6 +9020,7 @@ const workspace$2 = {
         const adapter = new DocumentSemanticTokensAdapter(extHostDocuments, provider);
         return monaco.languages.registerDocumentSemanticTokensProvider(documentSelector, {
             getLegend: () => legend,
+            onDidChange: provider.onDidChangeSemanticTokens,
             provideDocumentSemanticTokens: async (model, lastResultId, token) => {
                 const nLastResultId = lastResultId != null ? parseInt(lastResultId, 10) : 0;
                 const encodedDto = await adapter.provideDocumentSemanticTokens(model.uri, nLastResultId, token);
@@ -9072,6 +9076,7 @@ const workspace$2 = {
         const adapter = new InlayHintsAdapter(extHostDocuments, extHostCommands.converter, provider, extHostLogService, extensionDescription);
         return monaco.languages.registerInlayHintsProvider(documentSelector, {
             displayName: ExtHostLanguageFeatures._extLabel(extensionDescription),
+            onDidChangeInlayHints: provider.onDidChangeInlayHints,
             provideInlayHints: async (model, range, token) => {
                 const result = await adapter.provideInlayHints(model.uri, range, token);
                 if (result == null) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codingame/monaco-vscode-api",
-  "version": "1.68.2",
+  "version": "1.68.5",
   "private": false,
   "description": "VSCode public API plugged on the monaco editor",
   "keywords": [],
@@ -53,9 +53,15 @@
   "scripts": {
     "build": "rm -rf dist/ && npm run lint && npm run compile && npm run generate-types",
     "compile": "rollup --config rollup/rollup.config.ts --configPlugin 'typescript={tsconfig: `tsconfig.rollup.json`}'",
-    "preprepare": "./scripts/install-vscode",
+    "preprepare": "./scripts/install-vscode ${npm_package_config_vscode_version}",
     "lint": "eslint --ext ts src",
-    "generate-types": "tsc --project tsconfig.types.json && rollup --config rollup/rollup.types.config.ts --configPlugin 'typescript={tsconfig: `tsconfig.rollup.json`}' && rm -rf ./dist/types"
+    "generate-types": "tsc --project tsconfig.types.json && rollup --config rollup/rollup.types.config.ts --configPlugin 'typescript={tsconfig: `tsconfig.rollup.json`}' && rm -rf ./dist/types",
+    "release": "node --loader ts-node/esm release.ts ${npm_package_config_vscode_version}"
+  },
+  "config": {
+    "vscode": {
+      "version": "1.68.0"
+    }
   },
   "devDependencies": {
     "@babel/core": "^7.18.2",
@@ -65,9 +71,11 @@
     "@babel/preset-typescript": "^7.17.12",
     "@codingame/eslint-config": "^1.1.2",
     "@codingame/tsconfig": "^1.0.5",
+    "@octokit/rest": "^18.12.0",
     "@rollup/plugin-node-resolve": "^13.3.0",
     "@rollup/plugin-typescript": "^8.3.2",
     "@types/babel__core": "^7.1.19",
+    "@types/semver": "^7.3.10",
     "@types/vscode": "^1.68.0",
     "@typescript-eslint/eslint-plugin": "^5.27.1",
     "@typescript-eslint/parser": "^5.27.1",
@@ -81,15 +89,14 @@
     "recast": "^0.21.1",
     "rollup": "^2.75.6",
     "rollup-plugin-dts": "^4.2.2",
-    "typescript": "^4.7.3"
+    "semver": "^7.3.7",
+    "ts-node": "^10.8.1",
+    "typescript": "^4.7.3",
+    "zx": "^7.0.0"
   },
   "dependencies": {
     "monaco-editor": "^0.33.0"
   },
-  "engines": {
-    "node": ">=16.0.0",
-    "npm": ">=7.10.0"
-  },
   "volta": {
     "node": "16.15.0",
     "npm": "8.11.0"