codemirror-languageserver 1.14.0 → 1.16.0

package/README.md

@@ -6,52 +6,70 @@ This plugin enables code completion, hover tooltips, and linter functionality by
 
 [How It Works](https://hjr265.me/blog/codemirror-lsp/)
 
+## Features
+
+https://user-images.githubusercontent.com/348107/120141150-c6bb9180-c1fd-11eb-8ada-9b7b7a1e4ade.mp4
+
+- ⌨️ Code Completion
+- 📚 Hover Documentation
+- 🩺 Diagnostics
+- 🔍 Go to Definition, Declaration, and Type Definition
+
 ## Usage
 
 ```
 npm i codemirror-languageserver
 ```
 
-``` js
+```js
 import { languageServer } from 'codemirror-languageserver';
 
-const transport = new WebSocketTransport(serverUri)
+const transport = new WebSocketTransport(serverUri);
 
 var ls = languageServer({
-	// WebSocket server uri and other client options.
-	serverUri,
-	rootUri: 'file:///',
-
-	// Alternatively, to share the same client across multiple instances of this plugin.
-	client: new LanguageServerClient({
-		serverUri,
-		rootUri: 'file:///'
-	}),
-
-	documentUri: `file:///${filename}`,
-	languageId: 'cpp' // As defined at https://microsoft.github.io/language-server-protocol/specification#textDocumentItem.
+    // WebSocket server uri and other client options.
+    serverUri,
+    rootUri: 'file:///',
+
+    // Alternatively, to share the same client across multiple instances of this plugin.
+    client: new LanguageServerClient({
+        serverUri,
+        rootUri: 'file:///',
+    }),
+
+    documentUri: `file:///${filename}`,
+    languageId: 'cpp', // As defined at https://microsoft.github.io/language-server-protocol/specification#textDocumentItem.
 });
 
 var view = new EditorView({
-	state: EditorState.create({
-		extensions: [
-			// ...
-			ls,
-			// ...
-		]
-	})
+    state: EditorState.create({
+        extensions: [
+            // ...
+            ls,
+            // ...
+        ],
+    }),
 });
 ```
 
+### Using with Initialization Options
+
+The plugin includes built-in TypeScript definitions for popular language servers:
+
+-   `PyrightInitializationOptions` - Python (Pyright)
+-   `RustAnalyzerInitializationOptions` - Rust (rust-analyzer)
+-   `TypeScriptInitializationOptions` - TypeScript/JavaScript
+-   `ESLintInitializationOptions` - ESLint
+-   `ClangdInitializationOptions` - C/C++ (Clangd)
+-   `GoplsInitializationOptions` - Go (Gopls)
+
 ## Contributing
 
 Contributions are welcome.
 
 ## Real World Uses
 
-https://user-images.githubusercontent.com/348107/120141150-c6bb9180-c1fd-11eb-8ada-9b7b7a1e4ade.mp4
-
-- [Toph](https://toph.co): Competitive programming platform. Toph uses Language Server Plugin for CodeMirror 6 with its integrated code editor.
+-   [Toph](https://toph.co): Competitive programming platform. Toph uses Language Server Plugin for CodeMirror 6 with its integrated code editor.
 
 ## License
 

package/demo/demo.js

@@ -36,8 +36,33 @@ import { languageServer } from '../src';
 
 const tabSizeCompartment = new Compartment();
 
+const doc = `#include <iostream>
+
+using namespace std;
+
+class Animal {
+	public:
+		void say(string call) {
+			cout << call << endl;
+		}
+};
+
+class Cat : Animal {
+	public:
+		void meow() {
+			this->say("meow");
+		}
+};
+
+int main() {
+	Cat cat;
+	cat.meow();
+	return 0;
+}
+`
+
 const view = new EditorView({
-    doc: '#include <iostream>\n\nusing namespace std;\n\nint main() {\n\treturn 0;\n}\n',
+    doc,
     parent: document.getElementById('editor'),
     extensions: [
         lineNumbers(),

package/demo/dist/demo.js

@@ -4873,7 +4873,7 @@ let nav = typeof navigator != "undefined" ? navigator : {
   vendor: "",
   platform: ""
 };
-let doc = typeof document != "undefined" ? document : {
+let doc$1 = typeof document != "undefined" ? document : {
   documentElement: {
     style: {}
   }
@@ -4884,7 +4884,7 @@ const ie_11up = /*@__PURE__*//Trident\/(?:[7-9]|\d{2,})\..*rv:(\d+)/.exec(nav.us
 const ie$1 = !!(ie_upto10 || ie_11up || ie_edge);
 const gecko = !ie$1 && /*@__PURE__*//gecko\/(\d+)/i.test(nav.userAgent);
 const chrome = !ie$1 && /*@__PURE__*//Chrome\/(\d+)/.exec(nav.userAgent);
-const webkit = "webkitFontSmoothing" in doc.documentElement.style;
+const webkit = "webkitFontSmoothing" in doc$1.documentElement.style;
 const safari = !ie$1 && /*@__PURE__*//Apple Computer/.test(nav.vendor);
 const ios = safari && (/*@__PURE__*//Mobile\/\w+/.test(nav.userAgent) || nav.maxTouchPoints > 2);
 var browser$2 = {
@@ -4892,7 +4892,7 @@ var browser$2 = {
   windows: /*@__PURE__*//Win/.test(nav.platform),
   linux: /*@__PURE__*//Linux|X11/.test(nav.platform),
   ie: ie$1,
-  ie_version: ie_upto10 ? doc.documentMode || 6 : ie_11up ? +ie_11up[1] : ie_edge ? +ie_edge[1] : 0,
+  ie_version: ie_upto10 ? doc$1.documentMode || 6 : ie_11up ? +ie_11up[1] : ie_edge ? +ie_edge[1] : 0,
   gecko,
   gecko_version: gecko ? +(/*@__PURE__*//Firefox\/(\d+)/.exec(nav.userAgent) || [0, 0])[1] : 0,
   chrome: !!chrome,
@@ -4901,7 +4901,7 @@ var browser$2 = {
   android: /*@__PURE__*//Android\b/.test(nav.userAgent),
   safari,
   webkit_version: webkit ? +(/*@__PURE__*//\bAppleWebKit\/(\d+)/.exec(nav.userAgent) || [0, 0])[1] : 0,
-  tabSize: doc.documentElement.style.tabSize != null ? "tab-size" : "-moz-tab-size"
+  tabSize: doc$1.documentElement.style.tabSize != null ? "tab-size" : "-moz-tab-size"
 };
 const MaxJoinLen = 256;
 class TextView extends ContentView {
@@ -14325,7 +14325,7 @@ but also provides an `active` property holding a state field that
 can be used to read the currently active tooltips produced by this
 extension.
 */
-function hoverTooltip(source, options = {}) {
+function hoverTooltip$1(source, options = {}) {
   let setHover = StateEffect.define();
   let hoverState = StateField.define({
     create() {
@@ -24101,7 +24101,7 @@ function canStartStringAt(state, pos, prefixes) {
 /**
 Returns an extension that enables autocompletion.
 */
-function autocompletion(config = {}) {
+function autocompletion$1(config = {}) {
   return [commitCharacters, completionState, completionConfig.of(config), completionPlugin, completionKeymapExt, baseTheme$1];
 }
 /**
@@ -24784,7 +24784,7 @@ const lintExtensions = [lintState, /*@__PURE__*/EditorView.decorations.compute([
     panel
   } = state.field(lintState);
   return !selected || !panel || selected.from == selected.to ? Decoration.none : Decoration.set([activeMark.range(selected.from, selected.to)]);
-}), /*@__PURE__*/hoverTooltip(lintTooltip, {
+}), /*@__PURE__*/hoverTooltip$1(lintTooltip, {
   hideOn: hideTooltip
 }), baseTheme];
 
@@ -39824,17 +39824,36 @@ d.options;
   R.parse;
   b.lex;
 
+function posToOffset(doc, pos) {
+    if (pos.line >= doc.lines) {
+        return;
+    }
+    const offset = doc.line(pos.line + 1).from + pos.character;
+    if (offset > doc.length) {
+        return;
+    }
+    return offset;
+}
+function offsetToPos(doc, offset) {
+    const line = doc.lineAt(offset);
+    return {
+        character: offset - line.from,
+        line: line.number - 1,
+    };
+}
+
 const timeout = 10000;
 const changesDelay = 500;
 const CompletionItemKindMap = Object.fromEntries(Object.entries(mainExports.CompletionItemKind).map(([key, value]) => [value, key]));
 const useLast = (values) => values.reduce((_, v) => v, '');
-const client = Facet.define({
+Facet.define({
     combine: useLast,
 });
-const documentUri = Facet.define({ combine: useLast });
-const languageId = Facet.define({ combine: useLast });
+Facet.define({ combine: useLast });
+Facet.define({ combine: useLast });
 class LanguageServerClient {
     constructor(options) {
+        this.options = options;
         this.rootUri = options.rootUri;
         this.workspaceFolders = options.workspaceFolders;
         this.autoClose = options.autoClose;
@@ -39862,13 +39881,14 @@ class LanguageServerClient {
         }
         this.initializePromise = this.initialize();
     }
-    async initialize() {
-        const { capabilities } = await this.request('initialize', {
+    getInitializeParams() {
+        var _a;
+        return {
             capabilities: {
                 textDocument: {
                     hover: {
                         dynamicRegistration: true,
-                        contentFormat: ['plaintext', 'markdown'],
+                        contentFormat: ['markdown', 'plaintext'],
                     },
                     moniker: {},
                     synchronization: {
@@ -39882,16 +39902,16 @@ class LanguageServerClient {
                         completionItem: {
                             snippetSupport: false,
                             commitCharactersSupport: true,
-                            documentationFormat: ['plaintext', 'markdown'],
+                            documentationFormat: ['markdown', 'plaintext'],
                             deprecatedSupport: false,
                             preselectSupport: false,
                         },
-                        contextSupport: false,
+                        contextSupport: true,
                     },
                     signatureHelp: {
                         dynamicRegistration: true,
                         signatureInformation: {
-                            documentationFormat: ['plaintext', 'markdown'],
+                            documentationFormat: ['markdown', 'plaintext'],
                         },
                     },
                     declaration: {
@@ -39917,11 +39937,14 @@ class LanguageServerClient {
                     },
                 },
             },
-            initializationOptions: null,
+            initializationOptions: (_a = this.options.initializationOptions) !== null && _a !== void 0 ? _a : null,
             processId: null,
             rootUri: this.rootUri,
             workspaceFolders: this.workspaceFolders,
-        }, timeout * 3);
+        };
+    }
+    async initialize() {
+        const { capabilities } = await this.request('initialize', this.getInitializeParams(), timeout * 3);
         this.capabilities = capabilities;
         this.notify('initialized', {});
         this.ready = true;
@@ -39941,6 +39964,15 @@ class LanguageServerClient {
     async textDocumentCompletion(params) {
         return await this.request('textDocument/completion', params, timeout);
     }
+    async textDocumentDefinition(params) {
+        return await this.request('textDocument/definition', params, timeout);
+    }
+    async textDocumentDeclaration(params) {
+        return await this.request('textDocument/declaration', params, timeout);
+    }
+    async textDocumentTypeDefinition(params) {
+        return await this.request('textDocument/typeDefinition', params, timeout);
+    }
     attachPlugin(plugin) {
         this.plugins.push(plugin);
     }
@@ -39967,12 +39999,12 @@ class LanguageServerClient {
     }
 }
 class LanguageServerPlugin {
-    constructor(view, allowHTMLContent) {
+    constructor(view, { client, documentUri, languageId, allowHTMLContent, }) {
         this.view = view;
+        this.client = client;
+        this.documentUri = documentUri;
+        this.languageId = languageId;
         this.allowHTMLContent = allowHTMLContent;
-        this.client = this.view.state.facet(client);
-        this.documentUri = this.view.state.facet(documentUri);
-        this.languageId = this.view.state.facet(languageId);
         this.documentVersion = 0;
         this.changesTimeout = 0;
         this.client.attachPlugin(this);
@@ -40174,6 +40206,43 @@ class LanguageServerPlugin {
             filter: false,
         };
     }
+    async requestLocation(view, { line, character }, capability, method) {
+        if (!this.client.ready || !this.client.capabilities[capability]) {
+            return null;
+        }
+        const result = await this.client[method]({
+            textDocument: { uri: this.documentUri },
+            position: { line, character },
+        });
+        if (!result)
+            return;
+        const location = Array.isArray(result) ? result[0] : result;
+        const uri = location.uri ||
+            location.targetUri;
+        const range = location.range ||
+            location.targetRange;
+        if (uri === this.documentUri) {
+            view.dispatch(view.state.update({
+                selection: {
+                    anchor: posToOffset(view.state.doc, range.start),
+                    head: posToOffset(view.state.doc, range.end),
+                },
+            }));
+        }
+        return {
+            uri,
+            range,
+        };
+    }
+    async requestDefinition(view, { line, character }) {
+        return this.requestLocation(view, { line, character }, 'definitionProvider', 'textDocumentDefinition');
+    }
+    async requestDeclaration(view, { line, character }) {
+        return this.requestLocation(view, { line, character }, 'declarationProvider', 'textDocumentDeclaration');
+    }
+    async requestTypeDefinition(view, { line, character }) {
+        return this.requestLocation(view, { line, character }, 'typeDefinitionProvider', 'textDocumentTypeDefinition');
+    }
     processNotification(notification) {
         try {
             switch (notification.method) {
@@ -40217,72 +40286,7 @@ class LanguageServerPlugin {
         this.view.dispatch(setDiagnostics(this.view.state, diagnostics));
     }
 }
-function languageServer(options) {
-    const serverUri = options.serverUri;
-    delete options.serverUri;
-    return languageServerWithTransport({
-        ...options,
-        transport: new buildExports.WebSocketTransport(serverUri),
-    });
-}
-function languageServerWithTransport(options) {
-    let plugin = null;
-    return [
-        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))),
-        hoverTooltip((view, pos) => {
-            var _a;
-            return (_a = plugin === null || plugin === void 0 ? void 0 : plugin.requestHoverTooltip(view, offsetToPos(view.state.doc, pos))) !== null && _a !== void 0 ? _a : null;
-        }),
-        autocompletion({
-            override: [
-                async (context) => {
-                    var _a, _b, _c;
-                    if (plugin == null) {
-                        return null;
-                    }
-                    const { state, pos, explicit } = context;
-                    const line = state.doc.lineAt(pos);
-                    let trigKind = mainExports.CompletionTriggerKind.Invoked;
-                    let trigChar;
-                    if (!explicit &&
-                        ((_c = (_b = (_a = plugin.client.capabilities) === null || _a === void 0 ? void 0 : _a.completionProvider) === null || _b === void 0 ? void 0 : _b.triggerCharacters) === null || _c === void 0 ? void 0 : _c.includes(line.text[pos - line.from - 1]))) {
-                        trigKind = mainExports.CompletionTriggerKind.TriggerCharacter;
-                        trigChar = line.text[pos - line.from - 1];
-                    }
-                    if (trigKind === mainExports.CompletionTriggerKind.Invoked &&
-                        !context.matchBefore(/\w+$/)) {
-                        return null;
-                    }
-                    return await plugin.requestCompletion(context, offsetToPos(state.doc, pos), {
-                        triggerCharacter: trigChar,
-                        triggerKind: trigKind,
-                    });
-                },
-            ],
-        }),
-    ];
-}
-function posToOffset(doc, pos) {
-    if (pos.line >= doc.lines) {
-        return;
-    }
-    const offset = doc.line(pos.line + 1).from + pos.character;
-    if (offset > doc.length) {
-        return;
-    }
-    return offset;
-}
-function offsetToPos(doc, offset) {
-    const line = doc.lineAt(offset);
-    return {
-        character: offset - line.from,
-        line: line.number - 1,
-    };
-}
+const languageServerPlugin = ViewPlugin.fromClass(LanguageServerPlugin);
 async function formatContents(contents) {
     if (isLSPMarkupContent(contents)) {
         let value = contents.value;
@@ -40313,10 +40317,11 @@ function prefixMatch(items) {
     const first = new Set();
     const rest = new Set();
     for (const item of items) {
-        const [initial, ...restStr] = ((_a = item.textEdit) === null || _a === void 0 ? void 0 : _a.newText) || item.label;
+        const text = ((_a = item.textEdit) === null || _a === void 0 ? void 0 : _a.newText) || item.label;
+        const initial = text[0];
         first.add(initial);
-        for (const char of restStr) {
-            rest.add(char);
+        for (let i = 1; i < text.length; i++) {
+            rest.add(text[i]);
         }
     }
     const source = toSet(first) + toSet(rest) + '*$';
@@ -40329,9 +40334,110 @@ function isLSPMarkupContent(contents) {
     return contents.kind !== undefined;
 }
 
+function requestDefinition(view, pos) {
+    const plugin = view.plugin(languageServerPlugin);
+    if (!plugin)
+        return false;
+    plugin.requestDefinition(view, offsetToPos(view.state.doc, pos));
+    return true;
+}
+function requestTypeDefinition(view, pos) {
+    const plugin = view.plugin(languageServerPlugin);
+    if (!plugin)
+        return false;
+    plugin.requestTypeDefinition(view, offsetToPos(view.state.doc, pos));
+    return true;
+}
+const jumpToDefinition = (view) => requestDefinition(view, view.state.selection.main.head);
+const jumpToDefinitionPos = (pos) => (view) => requestDefinition(view, pos);
+const jumpToTypeDefinition = (view) => requestTypeDefinition(view, view.state.selection.main.head);
+const jumpToTypeDefinitionPos = (pos) => (view) => requestTypeDefinition(view, pos);
+const jumpToDefinitionKeymap = [
+    { key: 'F12', run: jumpToDefinition, preventDefault: true },
+    { key: 'Mod-F12', run: jumpToTypeDefinition, preventDefault: true },
+];
+
+const hoverTooltip = () => hoverTooltip$1((view, pos) => {
+    var _a;
+    const plugin = view.plugin(languageServerPlugin);
+    return ((_a = plugin === null || plugin === void 0 ? void 0 : plugin.requestHoverTooltip(view, offsetToPos(view.state.doc, pos))) !== null && _a !== void 0 ? _a : null);
+});
+
+const autocompletion = () => autocompletion$1({
+    override: [
+        async (context) => {
+            var _a, _b, _c;
+            const { state, pos, explicit, view } = context;
+            const plugin = view.plugin(languageServerPlugin);
+            if (plugin == null)
+                return null;
+            const line = state.doc.lineAt(pos);
+            let trigKind = mainExports.CompletionTriggerKind.Invoked;
+            let trigChar;
+            if (!explicit &&
+                ((_c = (_b = (_a = plugin.client.capabilities) === null || _a === void 0 ? void 0 : _a.completionProvider) === null || _b === void 0 ? void 0 : _b.triggerCharacters) === null || _c === void 0 ? void 0 : _c.includes(line.text[pos - line.from - 1]))) {
+                trigKind = mainExports.CompletionTriggerKind.TriggerCharacter;
+                trigChar = line.text[pos - line.from - 1];
+            }
+            if (trigKind === mainExports.CompletionTriggerKind.Invoked &&
+                !context.matchBefore(/\w+$/)) {
+                return null;
+            }
+            return await plugin.requestCompletion(context, offsetToPos(state.doc, pos), {
+                triggerCharacter: trigChar,
+                triggerKind: trigKind,
+            });
+        },
+    ],
+});
+
+const mouseHandler = () => EditorView.domEventHandlers({
+    mousedown: (event, view) => {
+        if (!event.ctrlKey && !event.metaKey)
+            return;
+        const pos = view.posAtCoords({
+            x: event.clientX,
+            y: event.clientY,
+        });
+        const ok = (event.shiftKey
+            ? jumpToTypeDefinitionPos(pos)
+            : jumpToDefinitionPos(pos))(view);
+        if (ok)
+            event.preventDefault();
+    },
+});
+
+function languageServer(options) {
+    const serverUri = options.serverUri;
+    const { serverUri: _, ...optionsWithoutServerUri } = options;
+    return languageServerWithTransport({
+        ...optionsWithoutServerUri,
+        transport: new buildExports.WebSocketTransport(serverUri),
+    });
+}
+function languageServerWithTransport(options) {
+    return [
+        languageServerPlugin.of({
+            client: options.client ||
+                new LanguageServerClient({
+                    ...options,
+                    autoClose: true,
+                }),
+            documentUri: options.documentUri,
+            languageId: options.languageId,
+            allowHTMLContent: options.allowHTMLContent,
+        }),
+        hoverTooltip(),
+        autocompletion(),
+        keymap.of([...jumpToDefinitionKeymap]),
+        mouseHandler(),
+    ];
+}
+
 var tabSizeCompartment = new Compartment();
+var doc = "#include <iostream>\n\nusing namespace std;\n\nclass Animal {\n\tpublic:\n\t\tvoid say(string call) {\n\t\t\tcout << call << endl;\n\t\t}\n};\n\nclass Cat : Animal {\n\tpublic:\n\t\tvoid meow() {\n\t\t\tthis->say(\"meow\");\n\t\t}\n};\n\nint main() {\n\tCat cat;\n\tcat.meow();\n\treturn 0;\n}\n";
 new EditorView({
-  doc: '#include <iostream>\n\nusing namespace std;\n\nint main() {\n\treturn 0;\n}\n',
+  doc: doc,
   parent: document.getElementById('editor'),
   extensions: [lineNumbers(), highlightSpecialChars(), history(), foldGutter(), drawSelection(), EditorState.allowMultipleSelections.of(true), indentOnInput(), indentUnit.of('\t'), syntaxHighlighting(defaultHighlightStyle, {
     fallback: true

package/dist/completion.d.ts

@@ -0,0 +1,2 @@
+import { Extension } from '@codemirror/state';
+export declare const autocompletion: () => Extension;

package/dist/definition.d.ts

@@ -0,0 +1,8 @@
+import { Command, KeyBinding } from '@codemirror/view';
+export declare const jumpToDefinition: Command;
+export declare const jumpToDefinitionPos: (pos: number) => Command;
+export declare const jumpToDeclaration: Command;
+export declare const jumpToDeclarationPos: (pos: number) => Command;
+export declare const jumpToTypeDefinition: Command;
+export declare const jumpToTypeDefinitionPos: (pos: number) => Command;
+export declare const jumpToDefinitionKeymap: readonly KeyBinding[];

package/dist/hover.d.ts

@@ -0,0 +1,2 @@
+import { Extension } from '@codemirror/state';
+export declare const hoverTooltip: () => Extension;