codemirror-languageserver 1.12.0 → 1.13.0

package/dist/index.d.ts

@@ -1,30 +1,32 @@
-import { EditorView, Tooltip, ViewUpdate, PluginValue } from '@codemirror/view';
-import * as LSP from 'vscode-languageserver-protocol';
-import { CompletionTriggerKind, PublishDiagnosticsParams } from "vscode-languageserver-protocol";
-import { CompletionContext, CompletionResult } from '@codemirror/autocomplete';
-import { Transport } from '@open-rpc/client-js/build/transports/Transport';
+import { EditorView, Tooltip } from "@codemirror/view";
+import { CompletionTriggerKind } from "vscode-languageserver-protocol";
+import type { CompletionContext, CompletionResult } from "@codemirror/autocomplete";
+import type { PluginValue, ViewUpdate } from "@codemirror/view";
+import { Transport } from "@open-rpc/client-js/build/transports/Transport";
+import type { PublishDiagnosticsParams } from "vscode-languageserver-protocol";
+import type * as LSP from "vscode-languageserver-protocol";
 interface LSPEventMap {
-    'textDocument/publishDiagnostics': LSP.PublishDiagnosticsParams;
+    "textDocument/publishDiagnostics": LSP.PublishDiagnosticsParams;
 }
 type Notification = {
     [key in keyof LSPEventMap]: {
-        jsonrpc: '2.0';
+        jsonrpc: "2.0";
         id?: null | undefined;
         method: key;
         params: LSPEventMap[key];
     };
 }[keyof LSPEventMap];
-declare class LanguageServerClient {
+export declare class LanguageServerClient {
+    ready: boolean;
+    capabilities: LSP.ServerCapabilities<any>;
+    initializePromise: Promise<void>;
     private rootUri;
     private workspaceFolders;
     private autoClose?;
     private transport;
     private requestManager;
     private client;
-    ready: boolean;
-    capabilities: LSP.ServerCapabilities<any>;
     private plugins;
-    initializePromise: Promise<void>;
     constructor(options: LanguageServerClientOptions);
     initialize(): Promise<void>;
     close(): void;
@@ -87,10 +89,10 @@ interface LanguageServerOptions extends LanguageServerClientOptions {
 interface LanguageServerWebsocketOptions extends LanguageServerBaseOptions {
     serverUri: `ws://${string}` | `wss://${string}`;
 }
-declare function languageServer(options: LanguageServerWebsocketOptions): ({
+export declare function languageServer(options: LanguageServerWebsocketOptions): ({
     extension: import("@codemirror/state").Extension;
 } | readonly import("@codemirror/state").Extension[])[];
-declare function languageServerWithTransport(options: LanguageServerOptions): ({
+export declare function languageServerWithTransport(options: LanguageServerOptions): ({
     extension: import("@codemirror/state").Extension;
 } | readonly import("@codemirror/state").Extension[])[];
-export { LanguageServerClient, languageServer, languageServerWithTransport };
+export {};

package/dist/index.js

@@ -4,11 +4,12 @@ import { Facet } from '@codemirror/state';
 import { ViewPlugin, hoverTooltip } from '@codemirror/view';
 import { RequestManager, Client, WebSocketTransport } from '@open-rpc/client-js';
 import { CompletionItemKind, CompletionTriggerKind, DiagnosticSeverity } from 'vscode-languageserver-protocol';
+import { marked } from 'marked/lib/marked.esm.js';
 
 const timeout = 10000;
 const changesDelay = 500;
 const CompletionItemKindMap = Object.fromEntries(Object.entries(CompletionItemKind).map(([key, value]) => [value, key]));
-const useLast = (values) => values.reduce((_, v) => v, '');
+const useLast = (values) => values.reduce((_, v) => v, "");
 const client = Facet.define({ combine: useLast });
 const documentUri = Facet.define({ combine: useLast });
 const languageId = Facet.define({ combine: useLast });
@@ -28,13 +29,13 @@ class LanguageServerClient {
         if (webSocketTransport && webSocketTransport.connection) {
             // XXX(hjr265): Need a better way to do this. Relevant issue:
             // https://github.com/FurqanSoftware/codemirror-languageserver/issues/9
-            webSocketTransport.connection.addEventListener('message', (message) => {
+            webSocketTransport.connection.addEventListener("message", (message) => {
                 const data = JSON.parse(message.data);
                 if (data.method && data.id) {
                     webSocketTransport.connection.send(JSON.stringify({
-                        jsonrpc: '2.0',
+                        jsonrpc: "2.0",
                         id: data.id,
-                        result: null
+                        result: null,
                     }));
                 }
             });
@@ -42,12 +43,12 @@ class LanguageServerClient {
         this.initializePromise = this.initialize();
     }
     async initialize() {
-        const { capabilities } = await this.request('initialize', {
+        const { capabilities } = await this.request("initialize", {
             capabilities: {
                 textDocument: {
                     hover: {
                         dynamicRegistration: true,
-                        contentFormat: ['plaintext', 'markdown'],
+                        contentFormat: ["plaintext", "markdown"],
                     },
                     moniker: {},
                     synchronization: {
@@ -61,7 +62,7 @@ class LanguageServerClient {
                         completionItem: {
                             snippetSupport: false,
                             commitCharactersSupport: true,
-                            documentationFormat: ['plaintext', 'markdown'],
+                            documentationFormat: ["plaintext", "markdown"],
                             deprecatedSupport: false,
                             preselectSupport: false,
                         },
@@ -70,7 +71,7 @@ class LanguageServerClient {
                     signatureHelp: {
                         dynamicRegistration: true,
                         signatureInformation: {
-                            documentationFormat: ['plaintext', 'markdown'],
+                            documentationFormat: ["plaintext", "markdown"],
                         },
                     },
                     declaration: {
@@ -102,34 +103,36 @@ class LanguageServerClient {
             workspaceFolders: this.workspaceFolders,
         }, timeout * 3);
         this.capabilities = capabilities;
-        this.notify('initialized', {});
+        this.notify("initialized", {});
         this.ready = true;
     }
     close() {
         this.client.close();
     }
     textDocumentDidOpen(params) {
-        return this.notify('textDocument/didOpen', params);
+        return this.notify("textDocument/didOpen", params);
     }
     textDocumentDidChange(params) {
-        return this.notify('textDocument/didChange', params);
+        return this.notify("textDocument/didChange", params);
     }
     async textDocumentHover(params) {
-        return await this.request('textDocument/hover', params, timeout);
+        return await this.request("textDocument/hover", params, timeout);
     }
     async textDocumentCompletion(params) {
-        return await this.request('textDocument/completion', params, timeout);
+        return await this.request("textDocument/completion", params, timeout);
     }
     attachPlugin(plugin) {
         this.plugins.push(plugin);
     }
     detachPlugin(plugin) {
         const i = this.plugins.indexOf(plugin);
-        if (i === -1)
+        if (i === -1) {
             return;
+        }
         this.plugins.splice(i, 1);
-        if (this.autoClose)
+        if (this.autoClose) {
             this.close();
+        }
     }
     request(method, params, timeout) {
         return this.client.request({ method, params }, timeout);
@@ -138,8 +141,9 @@ class LanguageServerClient {
         return this.client.notify({ method, params });
     }
     processNotification(notification) {
-        for (const plugin of this.plugins)
+        for (const plugin of this.plugins) {
             plugin.processNotification(notification);
+        }
     }
 }
 class LanguageServerPlugin {
@@ -157,10 +161,12 @@ class LanguageServerPlugin {
         });
     }
     update({ docChanged }) {
-        if (!docChanged)
+        if (!docChanged) {
             return;
-        if (this.changesTimeout)
+        }
+        if (this.changesTimeout) {
             clearTimeout(this.changesTimeout);
+        }
         this.changesTimeout = self.setTimeout(() => {
             this.sendChange({
                 documentText: this.view.state.doc.toString(),
@@ -180,12 +186,13 @@ class LanguageServerPlugin {
                 languageId: this.languageId,
                 text: documentText,
                 version: this.documentVersion,
-            }
+            },
         });
     }
     async sendChange({ documentText }) {
-        if (!this.client.ready)
+        if (!this.client.ready) {
             return;
+        }
         try {
             await this.client.textDocumentDidChange({
                 textDocument: {
@@ -203,15 +210,17 @@ class LanguageServerPlugin {
         this.sendChange({ documentText: view.state.doc.toString() });
     }
     async requestHoverTooltip(view, { line, character }) {
-        if (!this.client.ready || !this.client.capabilities.hoverProvider)
+        if (!this.client.ready || !this.client.capabilities.hoverProvider) {
             return null;
+        }
         this.sendChange({ documentText: view.state.doc.toString() });
         const result = await this.client.textDocumentHover({
             textDocument: { uri: this.documentUri },
             position: { line, character },
         });
-        if (!result)
+        if (!result) {
             return null;
+        }
         const { contents, range } = result;
         let pos = posToOffset(view.state.doc, { line, character });
         let end;
@@ -219,19 +228,28 @@ class LanguageServerPlugin {
             pos = posToOffset(view.state.doc, range.start);
             end = posToOffset(view.state.doc, range.end);
         }
-        if (pos === null)
+        if (pos === null) {
             return null;
-        const dom = document.createElement('div');
-        dom.classList.add('documentation');
-        if (this.allowHTMLContent)
+        }
+        const dom = document.createElement("div");
+        dom.classList.add("documentation");
+        if (this.allowHTMLContent) {
             dom.innerHTML = formatContents(contents);
-        else
+        }
+        else {
             dom.textContent = formatContents(contents);
-        return { pos, end, create: (view) => ({ dom }), above: true };
+        }
+        return {
+            pos,
+            end,
+            create: (view) => ({ dom }),
+            above: true,
+        };
     }
     async requestCompletion(context, { line, character }, { triggerKind, triggerCharacter, }) {
-        if (!this.client.ready || !this.client.capabilities.completionProvider)
+        if (!this.client.ready || !this.client.capabilities.completionProvider) {
             return null;
+        }
         this.sendChange({
             documentText: context.state.doc.toString(),
         });
@@ -241,11 +259,12 @@ class LanguageServerPlugin {
             context: {
                 triggerKind,
                 triggerCharacter,
-            }
+            },
         });
-        if (!result)
+        if (!result) {
             return null;
-        let items = 'items' in result ? result.items : result;
+        }
+        let items = "items" in result ? result.items : result;
         const [span, match] = prefixMatch(items);
         const token = context.matchBefore(match);
         let { pos } = context;
@@ -278,10 +297,13 @@ class LanguageServerPlugin {
             const completion = {
                 label,
                 detail,
-                apply: function (view, completion, from, to) {
-                    var _a;
-                    const text = (_a = textEdit === null || textEdit === void 0 ? void 0 : textEdit.newText) !== null && _a !== void 0 ? _a : label;
-                    view.dispatch(insertCompletionText(view.state, text, from, to));
+                apply(view, completion, from, to) {
+                    if (isLSPTextEdit(textEdit)) {
+                        view.dispatch(insertCompletionText(view.state, textEdit.newText, posToOffset(view.state.doc, textEdit.range.start), posToOffset(view.state.doc, textEdit.range.end)));
+                    }
+                    else {
+                        view.dispatch(insertCompletionText(view.state, label, from, to));
+                    }
                     if (!additionalTextEdits) {
                         return;
                     }
@@ -300,12 +322,12 @@ class LanguageServerPlugin {
                             changes: {
                                 from: posToOffset(view.state.doc, textEdit.range.start),
                                 to: posToOffset(view.state.doc, textEdit.range.end),
-                                insert: textEdit.newText
-                            }
+                                insert: textEdit.newText,
+                            },
                         }));
                     });
                 },
-                type: kind && CompletionItemKindMap[kind].toLowerCase()
+                type: kind && CompletionItemKindMap[kind].toLowerCase(),
             };
             if (documentation) {
                 completion.info = formatContents(documentation);
@@ -315,32 +337,33 @@ class LanguageServerPlugin {
         return {
             from: pos,
             options,
-            filter: false
+            filter: false,
         };
     }
     processNotification(notification) {
         try {
             switch (notification.method) {
-                case 'textDocument/publishDiagnostics':
+                case "textDocument/publishDiagnostics":
                     this.processDiagnostics(notification.params);
             }
         }
         catch (error) {
-            console.error(error);
+            console.log(error);
         }
     }
     processDiagnostics(params) {
-        if (params.uri !== this.documentUri)
+        if (params.uri !== this.documentUri) {
             return;
+        }
         const diagnostics = params.diagnostics
             .map(({ range, message, severity }) => ({
             from: posToOffset(this.view.state.doc, range.start),
             to: posToOffset(this.view.state.doc, range.end),
             severity: {
-                [DiagnosticSeverity.Error]: 'error',
-                [DiagnosticSeverity.Warning]: 'warning',
-                [DiagnosticSeverity.Information]: 'info',
-                [DiagnosticSeverity.Hint]: 'info',
+                [DiagnosticSeverity.Error]: "error",
+                [DiagnosticSeverity.Warning]: "warning",
+                [DiagnosticSeverity.Information]: "info",
+                [DiagnosticSeverity.Hint]: "info",
             }[severity],
             message,
         }))
@@ -362,7 +385,7 @@ function languageServer(options) {
     delete options.serverUri;
     return languageServerWithTransport({
         ...options,
-        transport: new WebSocketTransport(serverUri)
+        transport: new WebSocketTransport(serverUri),
     });
 }
 function languageServerWithTransport(options) {
@@ -380,8 +403,9 @@ function languageServerWithTransport(options) {
             override: [
                 async (context) => {
                     var _a, _b, _c;
-                    if (plugin == null)
+                    if (plugin == null) {
                         return null;
+                    }
                     const { state, pos, explicit } = context;
                     const line = state.doc.lineAt(pos);
                     let trigKind = CompletionTriggerKind.Invoked;
@@ -396,8 +420,8 @@ function languageServerWithTransport(options) {
                         return null;
                     }
                     return await plugin.requestCompletion(context, offsetToPos(state.doc, pos), {
-                        triggerKind: trigKind,
                         triggerCharacter: trigChar,
+                        triggerKind: trigKind,
                     });
                 },
             ],
@@ -405,40 +429,46 @@ function languageServerWithTransport(options) {
     ];
 }
 function posToOffset(doc, pos) {
-    if (pos.line >= doc.lines)
+    if (pos.line >= doc.lines) {
         return;
+    }
     const offset = doc.line(pos.line + 1).from + pos.character;
-    if (offset > doc.length)
+    if (offset > doc.length) {
         return;
+    }
     return offset;
 }
 function offsetToPos(doc, offset) {
     const line = doc.lineAt(offset);
     return {
-        line: line.number - 1,
         character: offset - line.from,
+        line: line.number - 1,
     };
 }
 function formatContents(contents) {
-    if (Array.isArray(contents)) {
-        return contents.map((c) => formatContents(c) + '\n\n').join('');
+    if (isLSPMarkupContent(contents)) {
+        let value = contents.value;
+        if (contents.kind === "markdown") {
+            value = marked.parse(value);
+        }
+        return value;
     }
-    else if (typeof contents === 'string') {
-        return contents;
+    else if (Array.isArray(contents)) {
+        return contents.map((c) => formatContents(c) + "\n\n").join("");
     }
-    else {
-        return contents.value;
+    else if (typeof contents === "string") {
+        return contents;
     }
 }
 function toSet(chars) {
-    let preamble = '';
-    let flat = Array.from(chars).join('');
+    let preamble = "";
+    let flat = Array.from(chars).join("");
     const words = /\w/.test(flat);
     if (words) {
-        preamble += '\\w';
-        flat = flat.replace(/\w/g, '');
+        preamble += "\\w";
+        flat = flat.replace(/\w/g, "");
     }
-    return `[${preamble}${flat.replace(/[^\w\s]/g, '\\$&')}]`;
+    return `[${preamble}${flat.replace(/[^\w\s]/g, "\\$&")}]`;
 }
 function prefixMatch(items) {
     var _a;
@@ -451,8 +481,14 @@ function prefixMatch(items) {
             rest.add(char);
         }
     }
-    const source = toSet(first) + toSet(rest) + '*$';
-    return [new RegExp('^' + source), new RegExp(source)];
+    const source = toSet(first) + toSet(rest) + "*$";
+    return [new RegExp("^" + source), new RegExp(source)];
+}
+function isLSPTextEdit(textEdit) {
+    return (textEdit === null || textEdit === void 0 ? void 0 : textEdit.range) !== undefined;
+}
+function isLSPMarkupContent(contents) {
+    return contents.kind !== undefined;
 }
 
 export { LanguageServerClient, languageServer, languageServerWithTransport };

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "codemirror-languageserver",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "Language Server Plugin for CodeMirror 6",
   "main": "dist/index.js",
+  "type": "module",
   "scripts": {
     "prepare": "rollup -c rollup.config.js"
   },
@@ -21,20 +22,23 @@
   },
   "license": "BSD-3-Clause",
   "devDependencies": {
-    "@babel/core": "^7.18.6",
-    "@babel/preset-env": "^7.18.6",
-    "@rollup/plugin-babel": "^5.3.1",
-    "prettier": "^2.2.1",
-    "rollup": "^2.75.7",
-    "rollup-plugin-ts": "^3.0.2",
-    "typescript": "^4.7.4"
+    "@babel/core": "^7.28.0",
+    "@babel/preset-env": "^7.28.0",
+    "@rollup/plugin-babel": "^6.0.4",
+    "@rollup/plugin-typescript": "^12.1.4",
+    "prettier": "^3.6.2",
+    "rollup": "^4.46.2",
+    "tslib": "^2.8.1",
+    "tslint": "^6.1.3",
+    "typescript": "^5.9.2"
   },
   "dependencies": {
-    "@codemirror/autocomplete": "^6.18.4",
-    "@codemirror/lint": "^6.8.4",
-    "@codemirror/state": "^6.5.1",
-    "@codemirror/view": "^6.36.2",
+    "@codemirror/autocomplete": "^6.18.6",
+    "@codemirror/lint": "^6.8.5",
+    "@codemirror/state": "^6.5.2",
+    "@codemirror/view": "^6.38.1",
     "@open-rpc/client-js": "^1.8.1",
+    "marked": "^16.1.2",
     "vscode-languageserver-protocol": "^3.17.5"
   },
   "prettier": {

package/tslint.json

@@ -0,0 +1,9 @@
+{
+    "defaultSeverity": "error",
+    "extends": [
+        "tslint:recommended"
+    ],
+    "jsRules": {},
+    "rules": {},
+    "rulesDirectory": []
+}