codemirror-languageserver 1.13.0 → 1.15.0

package/README.md

@@ -12,37 +12,48 @@ This plugin enables code completion, hover tooltips, and linter functionality by
 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.
@@ -51,7 +62,7 @@ Contributions are welcome.
 
 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

@@ -0,0 +1,100 @@
+import {
+    EditorView,
+    highlightSpecialChars,
+    drawSelection,
+    highlightActiveLine,
+    keymap,
+    lineNumbers,
+    panels,
+    rectangularSelection,
+} from '@codemirror/view';
+import { EditorState, Compartment } from '@codemirror/state';
+import {
+    indentOnInput,
+    indentUnit,
+    bracketMatching,
+    foldGutter,
+    foldKeymap,
+    defaultHighlightStyle,
+    syntaxHighlighting,
+} from '@codemirror/language';
+import {
+    defaultKeymap,
+    indentWithTab,
+    history,
+    historyKeymap,
+} from '@codemirror/commands';
+import { highlightSelectionMatches, searchKeymap } from '@codemirror/search';
+import {
+    completionKeymap,
+    closeBrackets,
+    closeBracketsKeymap,
+} from '@codemirror/autocomplete';
+import { lintKeymap } from '@codemirror/lint';
+import { cpp } from '@codemirror/lang-cpp';
+import {
+    languageServer,
+    jumpToDefinitionKeymap,
+    jumpToDefinitionPos,
+} from '../src';
+
+const tabSizeCompartment = new Compartment();
+
+const view = new EditorView({
+    doc: '#include <iostream>\n\nusing namespace std;\n\nint main() {\n\treturn 0;\n}\n',
+    parent: document.getElementById('editor'),
+    extensions: [
+        lineNumbers(),
+        highlightSpecialChars(),
+        history(),
+        foldGutter(),
+        drawSelection(),
+        EditorState.allowMultipleSelections.of(true),
+        indentOnInput(),
+        indentUnit.of('\t'),
+        syntaxHighlighting(defaultHighlightStyle, { fallback: true }),
+        bracketMatching(),
+        closeBrackets(),
+        rectangularSelection(),
+        highlightActiveLine(),
+        highlightSelectionMatches(),
+        panels(),
+        keymap.of([
+            ...closeBracketsKeymap,
+            ...defaultKeymap,
+            indentWithTab,
+            ...searchKeymap,
+            ...historyKeymap,
+            ...foldKeymap,
+            ...completionKeymap,
+            ...lintKeymap,
+        ]),
+        tabSizeCompartment.of(EditorState.tabSize.of(4)),
+        cpp(),
+        languageServer({
+            serverUri: 'ws://localhost:3000/?stack=clangd11',
+            allowHTMLContent: true,
+            rootUri: 'file:///demo',
+            workspaceFolders: [
+                {
+                    name: 'root',
+                    uri: 'file:///demo',
+                },
+            ],
+            documentUri: `file:///demo/main.cpp`,
+            languageId: 'cpp',
+        }),
+        keymap.of([...jumpToDefinitionKeymap]),
+        EditorView.domEventHandlers({
+            click: (event, view) => {
+                if (!event.ctrlKey && !event.metaKey) return;
+                const pos = view.posAtCoords({
+                    x: event.clientX,
+                    y: event.clientY,
+                });
+                const ok = jumpToDefinitionPos(pos)(view);
+                if (ok) event.preventDefault();
+            },
+        }),
+    ],
+});