@birdcc/lsp 0.0.1-alpha.0 → 0.0.1-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@birdcc/lsp",
-  "version": "0.0.1-alpha.0",
+  "version": "0.0.1-alpha.1",
   "private": false,
   "type": "module",
   "license": "GPL-3.0-only",
@@ -9,21 +9,28 @@
     "email": "npm-dev@birdcc.link",
     "url": "https://github.com/bird-chinese-community/"
   },
+  "description": "Language Server Protocol implementation for BIRD2 configuration files.",
   "main": "./dist/index.js",
-  "types": "./src/index.ts",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./src/index.ts",
+      "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     }
   },
+  "sideEffects": false,
+  "files": [
+    "dist/**",
+    "README.md",
+    "LICENSE"
+  ],
   "dependencies": {
     "yaml": "^2.8.2",
     "vscode-languageserver": "^9.0.1",
     "vscode-languageserver-textdocument": "^1.0.12",
-    "@birdcc/linter": "0.0.1-alpha.0",
-    "@birdcc/core": "0.0.1-alpha.0",
-    "@birdcc/parser": "0.0.1-alpha.0"
+    "@birdcc/core": "0.0.1-alpha.1",
+    "@birdcc/linter": "0.0.1-alpha.1",
+    "@birdcc/parser": "0.0.1-alpha.1"
   },
   "repository": {
     "type": "git",

package/.oxfmtrc.json

@@ -1,16 +0,0 @@
-{
-  "$schema": "../../../node_modules/oxfmt/configuration_schema.json",
-  "ignorePatterns": [
-    "node_modules/*",
-    "package.json",
-    "dist/*",
-    ".turbo/*",
-    "target/*",
-    "*.lock",
-    "pnpm-*.yaml",
-    "*-lock.json"
-  ],
-  "printWidth": 80,
-  "tabWidth": 2,
-  "useTabs": false
-}

package/scripts/copy-hover-yaml.mjs

@@ -1,14 +0,0 @@
-import { copyFile, mkdir } from "node:fs/promises";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-const packageRoot = path.resolve(__dirname, "..");
-
-const sourcePath = path.join(packageRoot, "src", "hover-docs.yaml");
-const targetDir = path.join(packageRoot, "dist");
-const targetPath = path.join(targetDir, "hover-docs.yaml");
-
-await mkdir(targetDir, { recursive: true });
-await copyFile(sourcePath, targetPath);

package/src/completion.ts

@@ -1,223 +0,0 @@
-import {
-  CompletionItemKind,
-  InsertTextFormat,
-  type CompletionItem,
-} from "vscode-languageserver/node.js";
-import type { ParsedBirdDocument } from "@birdcc/parser";
-import { declarationMetadata, KEYWORD_DOCS } from "./shared.js";
-
-const COMPLETION_KEYWORDS = [
-  "protocol",
-  "template",
-  "filter",
-  "function",
-  "define",
-  "include",
-  "import",
-  "export",
-  "neighbor",
-  "local as",
-  "router id",
-  "table",
-  "ipv4",
-  "ipv6",
-];
-
-interface CompletionSnippet {
-  label: string;
-  detail: string;
-  documentation: string;
-  insertText: string;
-}
-
-const COMPLETION_SNIPPETS: CompletionSnippet[] = [
-  {
-    label: 'include "..."',
-    detail: "BIRD snippet",
-    documentation: "Insert include statement.",
-    insertText: 'include "${1:path/to/file.conf}";',
-  },
-  {
-    label: "define NAME = value;",
-    detail: "BIRD snippet",
-    documentation: "Insert define statement.",
-    insertText: "define ${1:NAME} = ${2:value};",
-  },
-  {
-    label: "router id 1.1.1.1;",
-    detail: "BIRD snippet",
-    documentation: "Insert router id statement.",
-    insertText: "router id ${1:1.1.1.1};",
-  },
-  {
-    label: "protocol bgp ...",
-    detail: "BIRD snippet",
-    documentation: "Insert minimal BGP protocol block.",
-    insertText:
-      "protocol bgp ${1:name} {\n  neighbor ${2:192.0.2.1} as ${3:65001};\n  local as ${4:65000};\n}",
-  },
-];
-
-export interface CompletionContextOptions {
-  linePrefix?: string;
-  additionalDeclarations?: ParsedBirdDocument["program"]["declarations"];
-}
-
-const isFromTemplateContext = (linePrefix: string): boolean =>
-  /\bfrom\s+[A-Za-z_][A-Za-z0-9_]*$/i.test(linePrefix) ||
-  /\bfrom\s*$/i.test(linePrefix);
-
-const isIncludePathContext = (linePrefix: string): boolean =>
-  /\binclude\s+["'][^"']*$/i.test(linePrefix);
-
-const isFilterContext = (linePrefix: string): boolean =>
-  /\b(?:import|export)\s+filter\s+[A-Za-z_][A-Za-z0-9_]*$/i.test(linePrefix) ||
-  /\b(?:import|export)\s+filter\s*$/i.test(linePrefix);
-
-const isTableContext = (linePrefix: string): boolean =>
-  /\btable\s+[A-Za-z_][A-Za-z0-9_]*$/i.test(linePrefix) ||
-  /\btable\s*$/i.test(linePrefix);
-
-const allDeclarations = (
-  parsed: ParsedBirdDocument,
-  options: CompletionContextOptions,
-): ParsedBirdDocument["program"]["declarations"] => {
-  const additional = options.additionalDeclarations ?? [];
-  if (additional.length === 0) {
-    return parsed.program.declarations;
-  }
-
-  return [...parsed.program.declarations, ...additional];
-};
-
-const keywordCompletionItems = (): CompletionItem[] =>
-  COMPLETION_KEYWORDS.map((keyword) => ({
-    label: keyword,
-    kind: CompletionItemKind.Keyword,
-    detail: "BIRD keyword",
-    documentation: KEYWORD_DOCS[keyword] ?? "",
-  }));
-
-const snippetCompletionItems = (): CompletionItem[] =>
-  COMPLETION_SNIPPETS.map((snippet) => ({
-    label: snippet.label,
-    kind: CompletionItemKind.Snippet,
-    detail: snippet.detail,
-    documentation: snippet.documentation,
-    insertText: snippet.insertText,
-    insertTextFormat: InsertTextFormat.Snippet,
-  }));
-
-const includePathCompletionItems = (
-  declarations: ParsedBirdDocument["program"]["declarations"],
-  options: { quoteWrapped: boolean },
-): CompletionItem[] => {
-  const paths = new Set<string>();
-
-  for (const declaration of declarations) {
-    if (declaration.kind !== "include") {
-      continue;
-    }
-
-    if (declaration.path.length > 0) {
-      paths.add(declaration.path);
-    }
-  }
-
-  return Array.from(paths).map((path) => ({
-    label: path,
-    kind: CompletionItemKind.File,
-    detail: "include path",
-    insertText: options.quoteWrapped ? path : `"${path}"`,
-  }));
-};
-
-const collectDeclarationCompletionItems = (
-  declarations: ParsedBirdDocument["program"]["declarations"],
-  predicate: (
-    declaration: ParsedBirdDocument["program"]["declarations"][number],
-  ) => boolean,
-): CompletionItem[] => {
-  const items: CompletionItem[] = [];
-  const seen = new Set<string>();
-
-  for (const declaration of declarations) {
-    if (!predicate(declaration)) {
-      continue;
-    }
-
-    const metadata = declarationMetadata(declaration);
-    if (!metadata?.completionLabel || seen.has(metadata.completionLabel)) {
-      continue;
-    }
-
-    seen.add(metadata.completionLabel);
-    items.push({
-      label: metadata.completionLabel,
-      kind: metadata.completionKind ?? CompletionItemKind.Reference,
-      detail: metadata.completionDetail ?? metadata.detail,
-    });
-  }
-
-  return items;
-};
-
-const templateCompletionItems = (
-  declarations: ParsedBirdDocument["program"]["declarations"],
-): CompletionItem[] =>
-  collectDeclarationCompletionItems(
-    declarations,
-    (declaration) => declaration.kind === "template",
-  );
-
-const filterCompletionItems = (
-  declarations: ParsedBirdDocument["program"]["declarations"],
-): CompletionItem[] =>
-  collectDeclarationCompletionItems(
-    declarations,
-    (declaration) => declaration.kind === "filter",
-  );
-
-const tableCompletionItems = (
-  declarations: ParsedBirdDocument["program"]["declarations"],
-): CompletionItem[] =>
-  collectDeclarationCompletionItems(
-    declarations,
-    (declaration) => declaration.kind === "table",
-  );
-
-const declarationCompletionItems = (
-  declarations: ParsedBirdDocument["program"]["declarations"],
-): CompletionItem[] => {
-  return collectDeclarationCompletionItems(declarations, () => true);
-};
-
-export const createCompletionItemsFromParsed = (
-  parsed: ParsedBirdDocument,
-  options: CompletionContextOptions = {},
-): CompletionItem[] => {
-  const linePrefix = options.linePrefix ?? "";
-  const declarations = allDeclarations(parsed, options);
-
-  if (isIncludePathContext(linePrefix)) {
-    return includePathCompletionItems(declarations, { quoteWrapped: true });
-  }
-
-  if (isFromTemplateContext(linePrefix)) {
-    return templateCompletionItems(declarations);
-  }
-
-  if (isFilterContext(linePrefix)) {
-    return filterCompletionItems(declarations);
-  }
-
-  if (isTableContext(linePrefix)) {
-    return tableCompletionItems(declarations);
-  }
-
-  return [
-    ...keywordCompletionItems(),
-    ...snippetCompletionItems(),
-    ...declarationCompletionItems(declarations),
-  ];
-};

package/src/definition.ts

@@ -1,50 +0,0 @@
-import type { SymbolTable } from "@birdcc/core";
-import type { Location, Position } from "vscode-languageserver/node.js";
-import {
-  containsPosition,
-  createSymbolLookupIndex,
-  dedupeLocations,
-  extractWordAtPosition,
-  toLocation,
-} from "./symbol-utils.js";
-
-/** Resolves symbol definition locations from a merged cross-file symbol table. */
-export const createDefinitionLocations = (
-  symbolTable: SymbolTable,
-  uri: string,
-  position: Position,
-  sourceText: string,
-): Location[] => {
-  const index = createSymbolLookupIndex(
-    symbolTable.definitions,
-    symbolTable.references,
-  );
-
-  const reference = symbolTable.references.find(
-    (item) => item.uri === uri && containsPosition(item, position),
-  );
-
-  if (reference) {
-    return dedupeLocations(
-      (index.definitionsByName.get(reference.name.toLowerCase()) ?? [])
-        .filter((definition) => definition.kind === reference.kind)
-        .map(toLocation),
-    );
-  }
-
-  const definition = symbolTable.definitions.find(
-    (item) => item.uri === uri && containsPosition(item, position),
-  );
-  if (definition) {
-    return [toLocation(definition)];
-  }
-
-  const name = extractWordAtPosition(sourceText, position);
-  if (!name) {
-    return [];
-  }
-
-  return dedupeLocations(
-    (index.definitionsByName.get(name.toLowerCase()) ?? []).map(toLocation),
-  );
-};

package/src/diagnostic.ts

@@ -1,48 +0,0 @@
-import {
-  DiagnosticSeverity,
-  type Diagnostic,
-} from "vscode-languageserver/node.js";
-import type { BirdDiagnostic } from "@birdcc/core";
-
-const toLspSeverity = (
-  severity: BirdDiagnostic["severity"],
-): DiagnosticSeverity => {
-  if (severity === "error") {
-    return DiagnosticSeverity.Error;
-  }
-
-  if (severity === "warning") {
-    return DiagnosticSeverity.Warning;
-  }
-
-  return DiagnosticSeverity.Information;
-};
-
-/** Maps Bird diagnostic schema into LSP Diagnostic schema. */
-export const toLspDiagnostic = (diagnostic: BirdDiagnostic): Diagnostic => ({
-  code: diagnostic.code,
-  message: diagnostic.message,
-  severity: toLspSeverity(diagnostic.severity),
-  source: diagnostic.source,
-  range: {
-    start: {
-      line: Math.max(diagnostic.range.line - 1, 0),
-      character: Math.max(diagnostic.range.column - 1, 0),
-    },
-    end: {
-      line: Math.max(diagnostic.range.endLine - 1, 0),
-      character: Math.max(diagnostic.range.endColumn - 1, 0),
-    },
-  },
-});
-
-export const toInternalErrorDiagnostic = (error: unknown): Diagnostic => ({
-  code: "lsp/internal-error",
-  message: error instanceof Error ? error.message : String(error),
-  severity: DiagnosticSeverity.Error,
-  source: "lsp",
-  range: {
-    start: { line: 0, character: 0 },
-    end: { line: 0, character: 1 },
-  },
-});

package/src/document-symbol.ts

@@ -1,27 +0,0 @@
-import type { DocumentSymbol } from "vscode-languageserver/node.js";
-import type { ParsedBirdDocument } from "@birdcc/parser";
-import { declarationMetadata, toLspRange } from "./shared.js";
-
-export const createDocumentSymbolsFromParsed = (
-  parsed: ParsedBirdDocument,
-): DocumentSymbol[] => {
-  const symbols: DocumentSymbol[] = [];
-
-  for (const declaration of parsed.program.declarations) {
-    const metadata = declarationMetadata(declaration);
-    if (!metadata) {
-      continue;
-    }
-
-    symbols.push({
-      name: metadata.symbolName,
-      detail: metadata.detail,
-      kind: metadata.symbolKind,
-      range: toLspRange(declaration),
-      selectionRange: toLspRange(metadata.selectionRange),
-      children: [],
-    });
-  }
-
-  return symbols;
-};

package/src/hover-docs.ts

@@ -1,223 +0,0 @@
-import { readFileSync } from "node:fs";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-
-import { parse } from "yaml";
-
-export type HoverDocDiffType = "same" | "added" | "modified" | "removed";
-export type HoverDocVersionTag = "v2+" | "v3+" | "v2" | "v2-v3";
-
-interface HoverDocYamlEntry {
-  readonly keyword: string;
-  readonly description: string;
-  readonly detail: string;
-  readonly diff: HoverDocDiffType;
-  readonly version: HoverDocVersionTag;
-  readonly anchor?: string;
-  readonly anchors?: {
-    readonly v2?: string;
-    readonly v3?: string;
-  };
-  readonly notes?: {
-    readonly v2?: string;
-    readonly v3?: string;
-  };
-}
-
-interface HoverDocYamlSource {
-  readonly version: number;
-  readonly baseUrls: {
-    readonly v2: string;
-    readonly v3: string;
-  };
-  readonly entries: readonly HoverDocYamlEntry[];
-}
-
-const normalizeAnchor = (value: string | undefined): string | undefined => {
-  if (typeof value !== "string") {
-    return undefined;
-  }
-
-  const normalized = value.trim().replace(/^#/, "");
-  return normalized.length > 0 ? normalized : undefined;
-};
-
-const loadHoverDocYaml = (): HoverDocYamlSource => {
-  const hoverDocsPath = path.join(
-    path.dirname(fileURLToPath(import.meta.url)),
-    "hover-docs.yaml",
-  );
-  const raw = readFileSync(hoverDocsPath, "utf8");
-  const parsed = parse(raw) as HoverDocYamlSource;
-
-  if (!parsed || !Array.isArray(parsed.entries) || !parsed.baseUrls) {
-    throw new Error("Invalid hover docs yaml structure");
-  }
-
-  return parsed;
-};
-
-const isDiffType = (value: string): value is HoverDocDiffType =>
-  value === "same" ||
-  value === "added" ||
-  value === "modified" ||
-  value === "removed";
-
-const isVersionTag = (value: string): value is HoverDocVersionTag =>
-  value === "v2+" || value === "v3+" || value === "v2" || value === "v2-v3";
-
-const hoverDocSource = loadHoverDocYaml();
-
-const VERSION_BASE_URLS = {
-  v2: hoverDocSource.baseUrls.v2,
-  v3: hoverDocSource.baseUrls.v3,
-} as const;
-
-const toCanonicalEntry = (entry: HoverDocYamlEntry): HoverDocYamlEntry => {
-  const keyword = entry.keyword.trim().toLowerCase();
-  if (keyword.length === 0) {
-    throw new Error("Hover keyword must not be empty");
-  }
-
-  if (!isDiffType(entry.diff)) {
-    throw new Error(`Invalid diff type for keyword '${keyword}'`);
-  }
-
-  if (!isVersionTag(entry.version)) {
-    throw new Error(`Invalid version tag for keyword '${keyword}'`);
-  }
-
-  const anchor = normalizeAnchor(entry.anchor);
-  const anchors = entry.anchors
-    ? {
-        ...(normalizeAnchor(entry.anchors.v2)
-          ? { v2: normalizeAnchor(entry.anchors.v2) }
-          : {}),
-        ...(normalizeAnchor(entry.anchors.v3)
-          ? { v3: normalizeAnchor(entry.anchors.v3) }
-          : {}),
-      }
-    : undefined;
-
-  if (
-    (entry.version === "v2+" ||
-      entry.version === "v3+" ||
-      entry.version === "v2") &&
-    !anchor
-  ) {
-    throw new Error(
-      `Keyword '${keyword}' requires a single anchor for version '${entry.version}'`,
-    );
-  }
-
-  if (
-    entry.version === "v2-v3" &&
-    !anchor &&
-    (!anchors || Object.keys(anchors).length === 0)
-  ) {
-    throw new Error(
-      `Keyword '${keyword}' requires anchor or anchors for version 'v2-v3'`,
-    );
-  }
-
-  return {
-    ...entry,
-    keyword,
-    anchor,
-    anchors,
-  };
-};
-
-const normalizedEntries = hoverDocSource.entries.map(toCanonicalEntry);
-
-const dedupedEntries: HoverDocYamlEntry[] = [];
-const seenKeywords = new Set<string>();
-for (const entry of normalizedEntries) {
-  if (seenKeywords.has(entry.keyword)) {
-    continue;
-  }
-
-  seenKeywords.add(entry.keyword);
-  dedupedEntries.push(entry);
-}
-
-const buildDocUrl = (
-  version: keyof typeof VERSION_BASE_URLS,
-  anchor?: string,
-): string => {
-  const baseUrl = VERSION_BASE_URLS[version];
-  if (!anchor || anchor.length === 0) {
-    return baseUrl;
-  }
-
-  return `${baseUrl}#${anchor}`;
-};
-
-const buildDocsSection = (entry: HoverDocYamlEntry): string => {
-  const lines: string[] = [];
-
-  if (entry.version === "v2+") {
-    lines.push(`- [BIRD v2.18 / v3.2.0](${buildDocUrl("v2", entry.anchor)})`);
-  } else if (entry.version === "v3+") {
-    lines.push(`- [BIRD v3.2.0](${buildDocUrl("v3", entry.anchor)})`);
-  } else if (entry.version === "v2") {
-    lines.push(`- [BIRD v2.18](${buildDocUrl("v2", entry.anchor)})`);
-  } else {
-    const v2Anchor = entry.anchors?.v2 ?? entry.anchor;
-    const v3Anchor = entry.anchors?.v3 ?? entry.anchor;
-
-    if (v2Anchor) {
-      lines.push(`- [BIRD v2.18](${buildDocUrl("v2", v2Anchor)})`);
-    }
-
-    if (v3Anchor) {
-      lines.push(`- [BIRD v3.2.0](${buildDocUrl("v3", v3Anchor)})`);
-    }
-  }
-
-  return lines.join("\n");
-};
-
-const buildNotesSection = (entry: HoverDocYamlEntry): string => {
-  if (!entry.notes) {
-    return "";
-  }
-
-  const lines: string[] = [];
-  if (entry.notes.v2) {
-    lines.push(`- v2: ${entry.notes.v2}`);
-  }
-
-  if (entry.notes.v3) {
-    lines.push(`- v3: ${entry.notes.v3}`);
-  }
-
-  if (lines.length === 0) {
-    return "";
-  }
-
-  return `\n\nNotes:\n${lines.join("\n")}`;
-};
-
-const toHoverMarkdown = (entry: HoverDocYamlEntry): string => {
-  return (
-    [
-      `### ${entry.description}`,
-      "",
-      entry.detail,
-      "",
-      `Diff: \`${entry.diff}\``,
-      `Version: \`${entry.version}\``,
-      "Docs:",
-      buildDocsSection(entry),
-    ].join("\n") + buildNotesSection(entry)
-  );
-};
-
-export const HOVER_KEYWORD_DOCS: Record<string, string> = Object.fromEntries(
-  dedupedEntries.map((entry) => [entry.keyword, toHoverMarkdown(entry)]),
-);
-
-export const HOVER_KEYWORDS: readonly string[] = Object.freeze(
-  dedupedEntries.map((entry) => entry.keyword),
-);