codemirror-languageserver 1.13.0 → 1.14.0

package/demo/index.html

@@ -0,0 +1,17 @@
+<!doctype html>
+<html>
+    <head>
+        <title>CodeMirror Language Server Demo</title>
+        <link
+            type="text/css"
+            rel="stylesheet"
+            href="https://cdn.jsdelivr.net/gh/FurqanSoftware/sleek@v1.52.4/dist/sleek.css"
+        />
+    </head>
+    <body class="p-1">
+        <div class="form__field br-1-4">
+            <div id="editor"></div>
+        </div>
+        <script type="module" src="./dist/demo.js"></script>
+    </body>
+</html>

package/dist/index.d.ts

@@ -1,16 +1,16 @@
-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";
+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];

package/dist/index.js

@@ -4,13 +4,15 @@ 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';
+import { marked } from 'marked';
 
 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 client = Facet.define({ combine: useLast });
+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 });
 class LanguageServerClient {
@@ -29,11 +31,11 @@ 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,
                     }));
@@ -43,12 +45,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: {
@@ -62,7 +64,7 @@ class LanguageServerClient {
                         completionItem: {
                             snippetSupport: false,
                             commitCharactersSupport: true,
-                            documentationFormat: ["plaintext", "markdown"],
+                            documentationFormat: ['plaintext', 'markdown'],
                             deprecatedSupport: false,
                             preselectSupport: false,
                         },
@@ -71,7 +73,7 @@ class LanguageServerClient {
                     signatureHelp: {
                         dynamicRegistration: true,
                         signatureInformation: {
-                            documentationFormat: ["plaintext", "markdown"],
+                            documentationFormat: ['plaintext', 'markdown'],
                         },
                     },
                     declaration: {
@@ -103,23 +105,23 @@ 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);
@@ -231,13 +233,13 @@ class LanguageServerPlugin {
         if (pos === null) {
             return null;
         }
-        const dom = document.createElement("div");
-        dom.classList.add("documentation");
+        const dom = document.createElement('div');
+        dom.classList.add('documentation');
         if (this.allowHTMLContent) {
-            dom.innerHTML = formatContents(contents);
+            dom.innerHTML = await formatContents(contents);
         }
         else {
-            dom.textContent = formatContents(contents);
+            dom.textContent = await formatContents(contents);
         }
         return {
             pos,
@@ -247,7 +249,8 @@ class LanguageServerPlugin {
         };
     }
     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({
@@ -264,7 +267,7 @@ class LanguageServerPlugin {
         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;
@@ -309,10 +312,12 @@ class LanguageServerPlugin {
                     }
                     additionalTextEdits
                         .sort(({ range: { end: a } }, { range: { end: b } }) => {
-                        if (posToOffset(view.state.doc, a) < posToOffset(view.state.doc, b)) {
+                        if (posToOffset(view.state.doc, a) <
+                            posToOffset(view.state.doc, b)) {
                             return 1;
                         }
-                        else if (posToOffset(view.state.doc, a) > posToOffset(view.state.doc, b)) {
+                        else if (posToOffset(view.state.doc, a) >
+                            posToOffset(view.state.doc, b)) {
                             return -1;
                         }
                         return 0;
@@ -330,7 +335,18 @@ class LanguageServerPlugin {
                 type: kind && CompletionItemKindMap[kind].toLowerCase(),
             };
             if (documentation) {
-                completion.info = formatContents(documentation);
+                completion.info = async () => {
+                    const dom = document.createElement('div');
+                    dom.classList.add('documentation');
+                    if (this.allowHTMLContent) {
+                        dom.innerHTML = await formatContents(documentation);
+                    }
+                    else {
+                        dom.textContent =
+                            await formatContents(documentation);
+                    }
+                    return dom;
+                };
             }
             return completion;
         });
@@ -343,7 +359,7 @@ class LanguageServerPlugin {
     processNotification(notification) {
         try {
             switch (notification.method) {
-                case "textDocument/publishDiagnostics":
+                case 'textDocument/publishDiagnostics':
                     this.processDiagnostics(notification.params);
             }
         }
@@ -360,14 +376,17 @@ class LanguageServerPlugin {
             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,
         }))
-            .filter(({ from, to }) => from !== null && to !== null && from !== undefined && to !== undefined)
+            .filter(({ from, to }) => from !== null &&
+            to !== null &&
+            from !== undefined &&
+            to !== undefined)
             .sort((a, b) => {
             switch (true) {
                 case a.from < b.from:
@@ -391,7 +410,8 @@ function languageServer(options) {
 function languageServerWithTransport(options) {
     let plugin = null;
     return [
-        client.of(options.client || new LanguageServerClient({ ...options, autoClose: true })),
+        client.of(options.client ||
+            new LanguageServerClient({ ...options, autoClose: true })),
         documentUri.of(options.documentUri),
         languageId.of(options.languageId),
         ViewPlugin.define((view) => (plugin = new LanguageServerPlugin(view, options.allowHTMLContent))),
@@ -445,30 +465,30 @@ function offsetToPos(doc, offset) {
         line: line.number - 1,
     };
 }
-function formatContents(contents) {
+async function formatContents(contents) {
     if (isLSPMarkupContent(contents)) {
         let value = contents.value;
-        if (contents.kind === "markdown") {
-            value = marked.parse(value);
+        if (contents.kind === 'markdown') {
+            value = await marked.parse(value);
         }
         return value;
     }
     else if (Array.isArray(contents)) {
-        return contents.map((c) => formatContents(c) + "\n\n").join("");
+        return contents.map((c) => formatContents(c) + '\n\n').join('');
     }
-    else if (typeof contents === "string") {
+    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;
@@ -481,8 +501,8 @@ 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;

package/package.json

@@ -1,48 +1,55 @@
 {
-  "name": "codemirror-languageserver",
-  "version": "1.13.0",
-  "description": "Language Server Plugin for CodeMirror 6",
-  "main": "dist/index.js",
-  "type": "module",
-  "scripts": {
-    "prepare": "rollup -c rollup.config.js"
-  },
-  "author": {
-    "name": "Mahmud Ridwan",
-    "email": "m@hjr265.me",
-    "url": "https://hjr265.me"
-  },
-  "homepage": "https://github.com/FurqanSoftware/codemirror-languageserver",
-  "bugs": {
-    "url": "https://github.com/FurqanSoftware/codemirror-languageserver/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/FurqanSoftware/codemirror-languageserver.git"
-  },
-  "license": "BSD-3-Clause",
-  "devDependencies": {
-    "@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.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": {
-    "tabWidth": 4,
-    "singleQuote": true
-  }
+    "name": "codemirror-languageserver",
+    "version": "1.14.0",
+    "description": "Language Server Plugin for CodeMirror 6",
+    "main": "dist/index.js",
+    "type": "module",
+    "scripts": {
+        "prepare": "rollup -c rollup.config.js"
+    },
+    "author": {
+        "name": "Mahmud Ridwan",
+        "email": "m@hjr265.me",
+        "url": "https://hjr265.me"
+    },
+    "homepage": "https://github.com/FurqanSoftware/codemirror-languageserver",
+    "bugs": {
+        "url": "https://github.com/FurqanSoftware/codemirror-languageserver/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/FurqanSoftware/codemirror-languageserver.git"
+    },
+    "license": "BSD-3-Clause",
+    "devDependencies": {
+        "@babel/core": "^7.28.0",
+        "@babel/preset-env": "^7.28.0",
+        "@codemirror/commands": "^6.8.1",
+        "@codemirror/lang-cpp": "^6.0.3",
+        "@codemirror/search": "^6.5.11",
+        "@rollup/plugin-babel": "^6.0.4",
+        "@rollup/plugin-commonjs": "^28.0.6",
+        "@rollup/plugin-node-resolve": "^16.0.1",
+        "@rollup/plugin-typescript": "^12.1.4",
+        "prettier": "^3.6.2",
+        "rollup": "^4.46.2",
+        "rollup-plugin-node-polyfills": "^0.2.1",
+        "rollup-plugin-serve": "^3.0.0",
+        "tslib": "^2.8.1",
+        "tslint": "^6.1.3",
+        "typescript": "^5.9.2"
+    },
+    "dependencies": {
+        "@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": {
+        "tabWidth": 4,
+        "singleQuote": true
+    }
 }

package/rollup.config.demo.js

@@ -0,0 +1,30 @@
+import babel from '@rollup/plugin-babel';
+import typescript from '@rollup/plugin-typescript';
+import serve from 'rollup-plugin-serve';
+import { nodeResolve } from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+import nodePolyfills from 'rollup-plugin-node-polyfills';
+
+export default {
+    input: 'demo/demo.js',
+    output: {
+        dir: 'demo/dist',
+        format: 'es',
+        intro: 'const global = window;',
+    },
+    plugins: [
+        typescript({
+            declaration: false,
+        }),
+        babel({
+            babelHelpers: 'bundled',
+        }),
+        nodeResolve({
+            browser: true,
+            preferBuiltins: true,
+        }),
+        commonjs(),
+        nodePolyfills(),
+        serve('./demo'),
+    ],
+};