Files
WRNexusJSDoc/app/pages/packages/language-server.wrn
T

164 lines
9.7 KiB
Plaintext

page wrnexuslanguageserver {
seo {
title = "@wrnexus/language-server"
description = "Editor-neutral language intelligence for WRN files."
}
view {
<div class="docs-shell">
<a href="#main" class="skip-link">Skip to content</a>
<header class="topbar">
<a class="brand" href="/"><span>W</span> WRNexusJS</a>
<nav aria-label="Primary"><a href="/getting-started">Get started</a><a href="/packages">Packages</a><a href="https://component.wrnexusjs.dev/">Components</a><a href="/language">Language</a><a href="/architecture">Architecture</a></nav>
<div class="topbar-actions"><a class="preview-pill" href="/access">Private preview · v0.8.4</a><button data-wire-theme-toggle class="theme-button" aria-label="Toggle color theme" title="Toggle color theme">◐</button></div>
</header>
<div class="mobile-doc-nav"><details><summary>Browse documentation</summary><nav><a href="/getting-started">Get started</a><a href="/packages">Packages</a><a href="https://component.wrnexusjs.dev/">Components</a><a href="/language">Language</a><a href="/architecture">Architecture</a><a href="/tutorial">Tutorial</a><a href="/guides/project-structure">Guides</a><a href="/examples">Examples</a><a href="/search">Search</a></nav></details></div>
<main class="portal-main docs-layout">
<article id="main" class="documentation prose standalone package-document"><nav class="breadcrumbs" aria-label="Breadcrumb"><a href="/">Home</a><span>/</span><a href="/packages">Packages</a><span>/</span><span aria-current="page">@wrnexus/language-server</span></nav><section class="doc-intro"><span class="eyebrow">Tooling · Package reference</span><h1>@wrnexus/language-server</h1><p>Editor-neutral language intelligence for WRN files.</p><div class="doc-meta"><span>v0.8.4</span><span>Private registry</span><span>Tooling</span></div><section id="access" class="access-callout"><h2>Install the package</h2><p>After WorkRoot approves private registry access, install the release-aligned package:</p><pre><code>bun add @wrnexus/language-server@0.8.4</code><button type="button" class="copy-button" aria-label="Copy installation command">Copy</button></pre><p><a href="/access">Request preview access</a>. Never put registry tokens in source control.</p></section></section><section id="guide"><p>Editor-neutral Language Server Protocol support for <code>.wrn</code> files. It uses the canonical <code>@wrnexus/syntax</code> parser, diagnostics, accessibility rules, and formatter.</p>
<pre data-language="bash"><code>bunx wrnexus-language-server --stdio</code></pre>
<p>Capabilities include syntax, accessibility and TypeScript expression diagnostics, formatting, completion, hover, document symbols, go-to-definition, references, rename, and quick fixes. The custom <code>wrnexus/virtualDocument</code> request returns the mapped TypeScript representation of an open <code>.wrn</code> document for editor TypeScript plugins and safe refactoring tools. Any LSP 3.x client can launch the stdio command. Example Neovim configuration:</p>
<pre data-language="lua"><code>vim.lsp.start(&#123;
name = &quot;wrnexus&quot;,
cmd = &#123; &quot;bunx&quot;, &quot;wrnexus-language-server&quot;, &quot;--stdio&quot; &#125;,
root_dir = vim.fs.root(0, &#123; &quot;wrnexus.config.ts&quot;, &quot;package.json&quot;, &quot;.git&quot; &#125;),
&#125;)</code></pre>
<p>JetBrains users can register the same command through an LSP client/plugin. The server does not require VS Code and never reads environment secrets or sends source over a network.</p></section><section id="api" class="api"><h2>Complete TypeScript API</h2><p>Generated from the exact installed package declarations.</p><pre data-language="typescript"><code>interface WorkspaceCompletionItem &#123;
label: string;
kind: number;
detail: string;
insertText?: string;
data?: Record&lt;string, unknown&gt;;
&#125;
declare function workspaceCompletionItems(root: string): WorkspaceCompletionItem[];
declare function clearWorkspaceIndexCache(root?: string): void;
declare function extractComponentRefactor(document: TextDocument, range: Range, name: string): &#123;
documentChanges: (&#123;
kind: string;
uri: string;
textDocument?: undefined;
edits?: undefined;
&#125; | &#123;
textDocument: &#123;
uri: string;
version: number | null;
&#125;;
edits: &#123;
range: Range;
newText: string;
&#125;[];
kind?: undefined;
uri?: undefined;
&#125;)[];
&#125;;
declare function htmlToWrn(html: string, name?: string): string;
interface Position &#123;
line: number;
character: number;
&#125;
interface Range &#123;
start: Position;
end: Position;
&#125;
interface TextDocument &#123;
uri: string;
text: string;
version?: number;
&#125;
declare const WRN_COMPLETIONS: readonly [&quot;page&quot;, &quot;component&quot;, &quot;layout&quot;, &quot;props&quot;, &quot;outputs&quot;, &quot;state&quot;, &quot;computed&quot;, &quot;effect&quot;, &quot;watch&quot;, &quot;lifecycle&quot;, &quot;load&quot;, &quot;action&quot;, &quot;api&quot;, &quot;realtime&quot;, &quot;view&quot;, &quot;style&quot;, &quot;runtime&quot;, &quot;hydrate&quot;];
declare function offsetAt(text: string, position: Position): number;
declare function positionAt(text: string, requestedOffset: number): Position;
declare function wordAt(text: string, position: Position): &#123;
word: string;
range: Range;
&#125; | null;
declare function documentDiagnostics(document: TextDocument): &#123;
range: &#123;
start: &#123;
line: number;
character: number;
&#125;;
end: &#123;
line: number;
character: number;
&#125;;
&#125;;
severity: number;
code: string;
source: string;
message: string;
&#125;[];
/** TypeScript representation consumed by editor TypeScript plugins and safe refactoring tools. */
declare function virtualTypeScriptDocument(document: TextDocument): &#123;
uri: string;
languageId: &quot;typescript&quot;;
text: string;
mappings: Array&lt;&#123;
virtualStartLine: number;
virtualEndLine: number;
sourceStartLine: number;
sourceStartColumn: number;
&#125;&gt;;
&#125;;
declare function formatDocument(document: TextDocument, tabSize?: number, insertSpaces?: boolean): &#123;
range: &#123;
start: &#123;
line: number;
character: number;
&#125;;
end: Position;
&#125;;
newText: string;
&#125;[];
declare function documentSymbols(document: TextDocument): &#123;
name: string;
kind: number;
range: &#123;
start: Position;
end: Position;
&#125;;
selectionRange: &#123;
start: Position;
end: Position;
&#125;;
&#125;[];
declare function symbolLocations(document: TextDocument, position: Position): &#123;
uri: string;
range: &#123;
start: Position;
end: Position;
&#125;;
&#125;[];
declare function definitionLocation(document: TextDocument, position: Position): &#123;
uri: string;
range: &#123;
start: Position;
end: Position;
&#125;;
&#125; | null;
declare function hover(document: TextDocument, position: Position): &#123;
contents: &#123;
kind: string;
value: string;
&#125;;
range: Range;
&#125; | null;
declare function completionItems(): &#123;
label: &quot;page&quot; | &quot;component&quot; | &quot;layout&quot; | &quot;props&quot; | &quot;outputs&quot; | &quot;state&quot; | &quot;computed&quot; | &quot;effect&quot; | &quot;watch&quot; | &quot;lifecycle&quot; | &quot;load&quot; | &quot;action&quot; | &quot;api&quot; | &quot;realtime&quot; | &quot;view&quot; | &quot;style&quot; | &quot;runtime&quot; | &quot;hydrate&quot;;
kind: number;
detail: string;
&#125;[];
export &#123; type Position, type Range, type TextDocument, WRN_COMPLETIONS, type WorkspaceCompletionItem, clearWorkspaceIndexCache, completionItems, definitionLocation, documentDiagnostics, documentSymbols, extractComponentRefactor, formatDocument, hover, htmlToWrn, offsetAt, positionAt, symbolLocations, virtualTypeScriptDocument, wordAt, workspaceCompletionItems &#125;;
</code></pre></section><section id="examples" class="examples"><h2>Examples</h2><p>Copy-ready examples from the installed package documentation.</p><div class="example-grid"><article class="example-card"><h3>@wrnexus/syntax parser, diagnostics, accessibility rules, and formatter.</h3><pre data-language="bash"><code>bunx wrnexus-language-server --stdio</code></pre></article><article class="example-card"><h3>stdio command. Example Neovim configuration</h3><pre data-language="lua"><code>vim.lsp.start(&#123;
name = &quot;wrnexus&quot;,
cmd = &#123; &quot;bunx&quot;, &quot;wrnexus-language-server&quot;, &quot;--stdio&quot; &#125;,
root_dir = vim.fs.root(0, &#123; &quot;wrnexus.config.ts&quot;, &quot;package.json&quot;, &quot;.git&quot; &#125;),
&#125;)</code></pre></article></div></section></article>
<aside class="on-this-page"><h2>On this page</h2><nav><a class="toc-level-2" href="#guide">Guide</a><a class="toc-level-2" href="#api">Complete API</a><a class="toc-level-2" href="#examples">Examples</a></nav></aside>
</main>
<footer><div class="footer-brand"><span class="footer-mark" aria-hidden="true">W</span><p><strong>WRNexusJS 0.8.4</strong><span>Complete API documentation generated from installed package declarations.</span></p></div><nav aria-label="Footer"><a href="/packages">All packages</a><a href="/getting-started">Get started</a><a href="/security">Security</a><a href="/support">Support</a><a href="/llms.txt">AI guide</a></nav><p class="footer-meta">Private Developer Preview · Bun-native</p></footer>
</div>
}
}