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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@birdcc/linter",
-  "version": "0.0.1-alpha.0",
+  "version": "0.0.1-alpha.1",
   "private": false,
   "type": "module",
   "license": "GPL-3.0-only",
@@ -9,17 +9,24 @@
     "email": "npm-dev@birdcc.link",
     "url": "https://github.com/bird-chinese-community/"
   },
+  "description": "Lint rule engine 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": {
-    "@birdcc/core": "0.0.1-alpha.0",
-    "@birdcc/parser": "0.0.1-alpha.0"
+    "@birdcc/core": "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/src/index.ts

@@ -1,155 +0,0 @@
-import type { CrossFileResolutionResult, SymbolTable } from "@birdcc/core";
-import {
-  buildCoreSnapshotFromParsed,
-  type BirdDiagnostic,
-  type CoreSnapshot,
-} from "@birdcc/core";
-import { parseBirdConfig, type ParsedBirdDocument } from "@birdcc/parser";
-import { collectBgpRuleDiagnostics } from "./rules/bgp.js";
-import { collectCfgRuleDiagnostics } from "./rules/cfg.js";
-import { collectNetRuleDiagnostics } from "./rules/net.js";
-import { normalizeBaseDiagnostics } from "./rules/normalize.js";
-import { collectOspfRuleDiagnostics } from "./rules/ospf.js";
-import { collectSymRuleDiagnostics } from "./rules/sym.js";
-import { type RuleContext } from "./rules/shared.js";
-import { collectTypeRuleDiagnostics } from "./rules/type.js";
-
-export interface LintResult {
-  parsed: ParsedBirdDocument;
-  core: CoreSnapshot;
-  diagnostics: BirdDiagnostic[];
-}
-
-const dedupeDiagnostics = (diagnostics: BirdDiagnostic[]): BirdDiagnostic[] => {
-  const seen = new Set<string>();
-  const output: BirdDiagnostic[] = [];
-
-  for (const diagnostic of diagnostics) {
-    const key = [
-      diagnostic.code,
-      diagnostic.message,
-      diagnostic.uri ?? "",
-      diagnostic.range.line,
-      diagnostic.range.column,
-      diagnostic.range.endLine,
-      diagnostic.range.endColumn,
-    ].join(":");
-
-    if (seen.has(key)) {
-      continue;
-    }
-
-    seen.add(key);
-    output.push(diagnostic);
-  }
-
-  return output;
-};
-
-const diagnosticsForUri = (
-  diagnostics: BirdDiagnostic[],
-  uri: string,
-  entryUri: string,
-): BirdDiagnostic[] => {
-  return diagnostics.filter(
-    (diagnostic) => (diagnostic.uri ?? entryUri) === uri,
-  );
-};
-
-const createMergedCoreSnapshot = (
-  localCore: CoreSnapshot,
-  mergedSymbolTable: SymbolTable,
-  scopedDiagnostics: BirdDiagnostic[],
-): CoreSnapshot => ({
-  ...localCore,
-  symbols: mergedSymbolTable.definitions,
-  references: mergedSymbolTable.references,
-  symbolTable: mergedSymbolTable,
-  diagnostics: scopedDiagnostics,
-});
-
-export interface LintBirdConfigOptions {
-  parsed?: ParsedBirdDocument;
-  core?: CoreSnapshot;
-  uri?: string;
-}
-
-export interface CrossFileLintResult {
-  diagnostics: BirdDiagnostic[];
-  byUri: Record<string, LintResult>;
-}
-
-/** Runs parser + core + normalized 32-rule linter pipeline and returns merged diagnostics. */
-export const lintBirdConfig = async (
-  text: string,
-  options: LintBirdConfigOptions = {},
-): Promise<LintResult> => {
-  const parsed = options.parsed ?? (await parseBirdConfig(text));
-  const core =
-    options.core ?? buildCoreSnapshotFromParsed(parsed, { uri: options.uri });
-
-  const context: RuleContext = { text, parsed, core };
-
-  const normalizedBaseDiagnostics = normalizeBaseDiagnostics(
-    parsed,
-    core.diagnostics,
-    {
-      uri: options.uri,
-    },
-  );
-  const ruleDiagnostics: BirdDiagnostic[] = [
-    ...collectSymRuleDiagnostics(context),
-    ...collectCfgRuleDiagnostics(context),
-    ...collectNetRuleDiagnostics(context),
-    ...collectTypeRuleDiagnostics(context),
-    ...collectBgpRuleDiagnostics(context),
-    ...collectOspfRuleDiagnostics(context),
-  ].map((diagnostic) => ({
-    ...diagnostic,
-    uri: diagnostic.uri ?? options.uri,
-  }));
-
-  return {
-    parsed,
-    core,
-    diagnostics: dedupeDiagnostics([
-      ...normalizedBaseDiagnostics,
-      ...ruleDiagnostics,
-    ]),
-  };
-};
-
-export const lintResolvedCrossFileGraph = async (
-  resolution: CrossFileResolutionResult,
-): Promise<CrossFileLintResult> => {
-  const byUri: Record<string, LintResult> = {};
-  const diagnostics: BirdDiagnostic[] = [];
-  const uris =
-    resolution.visitedUris.length > 0
-      ? resolution.visitedUris
-      : [resolution.entryUri];
-
-  for (const uri of uris) {
-    const text = resolution.documents[uri];
-    const localCore = resolution.snapshots[uri];
-    if (!text || !localCore) {
-      continue;
-    }
-
-    const lintResult = await lintBirdConfig(text, {
-      uri,
-      core: createMergedCoreSnapshot(
-        localCore,
-        resolution.symbolTable,
-        diagnosticsForUri(resolution.diagnostics, uri, resolution.entryUri),
-      ),
-    });
-    byUri[uri] = lintResult;
-    diagnostics.push(...lintResult.diagnostics);
-  }
-
-  return {
-    byUri,
-    diagnostics: dedupeDiagnostics(diagnostics),
-  };
-};

package/src/rules/bgp.ts

@@ -1,239 +0,0 @@
-import type { BirdDiagnostic } from "@birdcc/core";
-import {
-  createProtocolDiagnostic,
-  createRuleDiagnostic,
-  extractFirstNumberAfterKeyword,
-  isProtocolType,
-  numericValue,
-  protocolDeclarations,
-  type BirdRule,
-} from "./shared.js";
-
-const isInternalSession = (value: string | undefined): boolean =>
-  /^(internal|ibgp)$/i.test(value?.trim() ?? "");
-
-const isExternalSession = (value: string | undefined): boolean =>
-  /^(external|ebgp)$/i.test(value?.trim() ?? "");
-
-const bgpMissingLocalAsRule: BirdRule = ({ parsed }) => {
-  const diagnostics: BirdDiagnostic[] = [];
-
-  for (const declaration of protocolDeclarations(parsed)) {
-    if (!isProtocolType(declaration, "bgp")) {
-      continue;
-    }
-
-    if (
-      declaration.statements.some((statement) => statement.kind === "local-as")
-    ) {
-      continue;
-    }
-
-    diagnostics.push(
-      createProtocolDiagnostic(
-        "bgp/missing-local-as",
-        `BGP protocol '${declaration.name}' missing local AS number`,
-        declaration,
-      ),
-    );
-  }
-
-  return diagnostics;
-};
-
-const bgpMissingNeighborRule: BirdRule = ({ parsed }) => {
-  const diagnostics: BirdDiagnostic[] = [];
-
-  for (const declaration of protocolDeclarations(parsed)) {
-    if (!isProtocolType(declaration, "bgp")) {
-      continue;
-    }
-
-    if (
-      declaration.statements.some((statement) => statement.kind === "neighbor")
-    ) {
-      continue;
-    }
-
-    diagnostics.push(
-      createProtocolDiagnostic(
-        "bgp/missing-neighbor",
-        `BGP protocol '${declaration.name}' missing neighbor configuration`,
-        declaration,
-      ),
-    );
-  }
-
-  return diagnostics;
-};
-
-const bgpMissingRemoteAsRule: BirdRule = ({ parsed }) => {
-  const diagnostics: BirdDiagnostic[] = [];
-
-  for (const declaration of protocolDeclarations(parsed)) {
-    if (!isProtocolType(declaration, "bgp")) {
-      continue;
-    }
-
-    for (const statement of declaration.statements) {
-      if (statement.kind !== "neighbor") {
-        continue;
-      }
-
-      if (
-        isInternalSession(statement.asn) ||
-        isExternalSession(statement.asn)
-      ) {
-        continue;
-      }
-
-      if (statement.asn && numericValue(statement.asn) !== null) {
-        continue;
-      }
-
-      diagnostics.push(
-        createRuleDiagnostic(
-          "bgp/missing-remote-as",
-          `BGP protocol '${declaration.name}' neighbor '${statement.address}' missing remote AS`,
-          statement.asnRange ?? statement.addressRange,
-        ),
-      );
-    }
-  }
-
-  return diagnostics;
-};
-
-const bgpAsMismatchRule: BirdRule = ({ parsed }) => {
-  const diagnostics: BirdDiagnostic[] = [];
-
-  for (const declaration of protocolDeclarations(parsed)) {
-    if (!isProtocolType(declaration, "bgp")) {
-      continue;
-    }
-
-    const localAsStatement = declaration.statements.find(
-      (statement) => statement.kind === "local-as",
-    );
-    if (!localAsStatement || localAsStatement.kind !== "local-as") {
-      continue;
-    }
-
-    const localAs = numericValue(localAsStatement.asn);
-    if (localAs === null) {
-      continue;
-    }
-
-    const hasInternalNeighbor = declaration.statements.some(
-      (statement) =>
-        statement.kind === "neighbor" && isInternalSession(statement.asn),
-    );
-
-    if (!hasInternalNeighbor) {
-      continue;
-    }
-
-    for (const statement of declaration.statements) {
-      if (statement.kind !== "neighbor" || !statement.asn) {
-        continue;
-      }
-
-      if (
-        isInternalSession(statement.asn) ||
-        isExternalSession(statement.asn)
-      ) {
-        continue;
-      }
-
-      const remoteAs = numericValue(statement.asn);
-      if (remoteAs === null || remoteAs === localAs) {
-        continue;
-      }
-
-      diagnostics.push(
-        createRuleDiagnostic(
-          "bgp/as-mismatch",
-          `BGP protocol '${declaration.name}' internal session requires same ASN (local ${localAs}, remote ${remoteAs})`,
-          statement.asnRange ?? statement.addressRange,
-        ),
-      );
-    }
-  }
-
-  return diagnostics;
-};
-
-const bgpTimerInvalidRule: BirdRule = ({ parsed }) => {
-  const diagnostics: BirdDiagnostic[] = [];
-
-  for (const declaration of protocolDeclarations(parsed)) {
-    if (!isProtocolType(declaration, "bgp")) {
-      continue;
-    }
-
-    let hold: number | null = null;
-    let keepalive: number | null = null;
-
-    for (const statement of declaration.statements) {
-      if (statement.kind !== "other") {
-        continue;
-      }
-
-      const text = statement.text.toLowerCase();
-      const holdValue = extractFirstNumberAfterKeyword(text, "hold");
-      const keepaliveValue = extractFirstNumberAfterKeyword(text, "keepalive");
-
-      if (holdValue !== null) {
-        hold = holdValue;
-        if (hold < 3 || hold > 65_535) {
-          diagnostics.push(
-            createRuleDiagnostic(
-              "bgp/timer-invalid",
-              `BGP protocol '${declaration.name}' hold time must be in range 3..65535`,
-              statement,
-            ),
-          );
-        }
-      }
-
-      if (keepaliveValue !== null) {
-        keepalive = keepaliveValue;
-        if (keepalive < 1 || keepalive > 65_535) {
-          diagnostics.push(
-            createRuleDiagnostic(
-              "bgp/timer-invalid",
-              `BGP protocol '${declaration.name}' keepalive must be in range 1..65535`,
-              statement,
-            ),
-          );
-        }
-      }
-    }
-
-    if (hold !== null && keepalive !== null && keepalive >= hold) {
-      diagnostics.push(
-        createProtocolDiagnostic(
-          "bgp/timer-invalid",
-          `BGP protocol '${declaration.name}' keepalive (${keepalive}) must be smaller than hold (${hold})`,
-          declaration,
-        ),
-      );
-    }
-  }
-
-  return diagnostics;
-};
-
-export const bgpRules: BirdRule[] = [
-  bgpMissingLocalAsRule,
-  bgpMissingNeighborRule,
-  bgpMissingRemoteAsRule,
-  bgpAsMismatchRule,
-  bgpTimerInvalidRule,
-];
-
-export const collectBgpRuleDiagnostics = (
-  context: Parameters<BirdRule>[0],
-): BirdDiagnostic[] => {
-  return bgpRules.flatMap((rule) => rule(context));
-};

package/src/rules/catalog.ts

@@ -1,80 +0,0 @@
-import type { BirdDiagnosticSeverity } from "@birdcc/core";
-
-export const RULE_CODES = {
-  sym: [
-    "sym/undefined",
-    "sym/duplicate",
-    "sym/proto-type-mismatch",
-    "sym/filter-required",
-    "sym/function-required",
-    "sym/table-required",
-    "sym/variable-scope",
-  ],
-  cfg: [
-    "cfg/no-protocol",
-    "cfg/missing-router-id",
-    "cfg/syntax-error",
-    "cfg/value-out-of-range",
-    "cfg/switch-value-expected",
-    "cfg/number-expected",
-    "cfg/incompatible-type",
-    "cfg/ip-network-mismatch",
-    "cfg/circular-template",
-  ],
-  net: [
-    "net/invalid-prefix-length",
-    "net/invalid-ipv4-prefix",
-    "net/invalid-ipv6-prefix",
-    "net/max-prefix-length",
-  ],
-  type: ["type/mismatch", "type/not-iterable", "type/set-incompatible"],
-  bgp: [
-    "bgp/missing-local-as",
-    "bgp/missing-neighbor",
-    "bgp/missing-remote-as",
-    "bgp/as-mismatch",
-    "bgp/timer-invalid",
-  ],
-  ospf: [
-    "ospf/missing-area",
-    "ospf/backbone-stub",
-    "ospf/vlink-in-backbone",
-    "ospf/asbr-stub-area",
-  ],
-} as const;
-
-export type RuleCode =
-  | (typeof RULE_CODES.sym)[number]
-  | (typeof RULE_CODES.cfg)[number]
-  | (typeof RULE_CODES.net)[number]
-  | (typeof RULE_CODES.type)[number]
-  | (typeof RULE_CODES.bgp)[number]
-  | (typeof RULE_CODES.ospf)[number];
-
-const ruleSeverityEntries: ReadonlyArray<
-  readonly [RuleCode, BirdDiagnosticSeverity]
-> = [
-  ...RULE_CODES.sym.map((code) => [code, "error"] as const),
-  ...RULE_CODES.cfg.map((code) => [code, "error"] as const),
-  ...RULE_CODES.net.map((code) => [code, "error"] as const),
-  ...RULE_CODES.type.map((code) => [code, "error"] as const),
-  ...RULE_CODES.bgp.map((code) => [code, "warning"] as const),
-  ...RULE_CODES.ospf.map((code) => [code, "warning"] as const),
-];
-
-export const RULE_SEVERITY: Record<RuleCode, BirdDiagnosticSeverity> =
-  Object.fromEntries(ruleSeverityEntries) as Record<
-    RuleCode,
-    BirdDiagnosticSeverity
-  >;
-
-export const LEGACY_CODE_PATTERNS = [
-  /^protocol\//,
-  /^security\//,
-  /^performance\//,
-  /^structure\//,
-] as const;
-
-export const isRuleCode = (code: string): code is RuleCode => {
-  return code in RULE_SEVERITY;
-};