lsp-implementation
Use when implementing Language Server Protocol features - covers completions, hover, diagnostics, and navigation
When & Why to Use This Skill
This Claude skill streamlines the implementation of the Language Server Protocol (LSP), enabling developers to build robust IDE features such as intelligent code completion, hover information, real-time diagnostics, and seamless code navigation. It provides standardized patterns and boilerplate for TypeScript-based language servers, ensuring high-performance integration with modern editors like VS Code.
Use Cases
- Case 1: Building a custom language server for a new or proprietary programming language to provide full IDE support.
- Case 2: Implementing 'Go to Definition' and 'Find All References' functionality for Domain-Specific Languages (DSLs).
- Case 3: Integrating real-time syntax checking and error diagnostics into web-based or desktop code editors.
- Case 4: Enhancing developer productivity by adding rich hover documentation and symbol search to existing development environments.
| name | lsp-implementation |
|---|---|
| description | Use when implementing Language Server Protocol features - covers completions, hover, diagnostics, and navigation |
Language Server Protocol Implementation
Quick Start
import {
createConnection,
TextDocuments,
ProposedFeatures,
} from "vscode-languageserver/node";
import { TextDocument } from "vscode-languageserver-textdocument";
const connection = createConnection(ProposedFeatures.all);
const documents = new TextDocuments(TextDocument);
connection.onInitialize(() => ({
capabilities: {
textDocumentSync: TextDocumentSyncKind.Incremental,
completionProvider: { triggerCharacters: [".", "/"] },
hoverProvider: true,
definitionProvider: true,
}
}));
documents.listen(connection);
connection.listen();
Core Features
Completions
connection.onCompletion((params): CompletionItem[] => {
const document = documents.get(params.textDocument.uri);
const position = params.position;
// Get context at cursor
const line = document?.getText({
start: { line: position.line, character: 0 },
end: position
});
// Return builtins
return [
{ label: "map", kind: CompletionItemKind.Function, detail: "(fn) -> List" },
{ label: "filter", kind: CompletionItemKind.Function, detail: "(fn) -> List" },
{ label: "reduce", kind: CompletionItemKind.Function, detail: "(init, fn) -> Value" },
];
});
Hover Information
connection.onHover((params): Hover | null => {
const document = documents.get(params.textDocument.uri);
const word = getWordAtPosition(document, params.position);
const builtin = BUILTINS[word];
if (builtin) {
return {
contents: {
kind: "markdown",
value: `**${word}**\n\n${builtin.description}\n\n\`\`\`lea\n${builtin.signature}\n\`\`\``
}
};
}
return null;
});
Diagnostics
documents.onDidChangeContent((change) => {
const document = change.document;
const diagnostics: Diagnostic[] = [];
try {
parse(document.getText());
} catch (error) {
if (error instanceof ParseError) {
diagnostics.push({
severity: DiagnosticSeverity.Error,
range: error.range,
message: error.message,
source: "lea"
});
}
}
connection.sendDiagnostics({ uri: document.uri, diagnostics });
});
Go to Definition
connection.onDefinition((params): Definition | null => {
const document = documents.get(params.textDocument.uri);
const word = getWordAtPosition(document, params.position);
// Find definition in AST
const definition = findDefinition(document.getText(), word);
if (definition) {
return {
uri: params.textDocument.uri,
range: definition.range
};
}
return null;
});
Protocol Messages
textDocument/completion- Code completionstextDocument/hover- Hover informationtextDocument/definition- Go to definitiontextDocument/references- Find all referencestextDocument/documentSymbol- Document outlinetextDocument/formatting- Code formatting
Reference Files
- references/capabilities.md - Server capabilities
- references/diagnostics.md - Error reporting