@goodbones/oxlint 0.1.0-beta.1 → 0.1.0-beta.10

package/src/oxlint-api.ts

@@ -1,5 +1,11 @@
 import * as path from "node:path";
 
+import {
+  type ProgramBody,
+  type ReadFacts,
+  readProgram,
+  type SyntaxNode,
+} from "@goodbones/typescript";
 import type { RuleTester } from "oxlint/plugins-dev";
 
 // oxlint publishes no plugin types, so the exact `Context`, node and fixer shapes
@@ -12,55 +18,33 @@ type Diagnostic = Parameters<RuleContext["report"]>[0];
 export type ReportableNode = Extract<Diagnostic, { node: unknown }>["node"];
 export type Fixer = Parameters<NonNullable<Diagnostic["fix"]>>[0];
 
-export type SourceNode = ReportableNode & {
-  readonly source?: { readonly value?: unknown } | null;
-};
+// The root of the tree oxlint hands a rule, and the one the pack's reader
+// walks.
+export type Program = RuleContext["sourceCode"]["ast"];
 
 export const toRepoRelative = (repoRoot: string, filename: string): string =>
   path.relative(repoRoot, filename).replaceAll(path.sep, "/");
 
-export const specifierOf = (node: SourceNode): string | null => {
-  const value = node.source?.value;
-  return typeof value === "string" ? value : null;
-};
-
-// The three forms that name a module without an `import … from`. Each is an
-// edge for the import rule and a whole-module binding for the export rule, so
-// both read them through these.
-
-// `require("m")` — a CallExpression whose callee is the bare identifier.
-export type CallNode = ReportableNode & {
-  readonly callee?: { readonly type: string; readonly name?: unknown } | null;
-  readonly arguments?: ReadonlyArray<{ readonly type: string; readonly value?: unknown }> | null;
-};
-
-// `import("m")` — `source` is any expression; only a string literal is an edge.
-export type ImportExpressionNode = ReportableNode & {
-  readonly source?: { readonly type?: string; readonly value?: unknown } | null;
-};
-
-// `import x = require("m")` — the module is under `moduleReference`, not `source`.
-export type ImportEqualsNode = ReportableNode & {
-  readonly moduleReference?: {
-    readonly type: string;
-    readonly expression?: { readonly value?: unknown } | null;
-  } | null;
-};
-
-export const requireSpecifierOf = (node: CallNode): string | null => {
-  if (node.callee?.type !== "Identifier" || node.callee.name !== "require") return null;
-  const [first] = node.arguments ?? [];
-  return first?.type === "Literal" && typeof first.value === "string" ? first.value : null;
-};
-
-export const importExpressionSpecifierOf = (node: ImportExpressionNode): string | null => {
-  const source = node.source;
-  return source?.type === "Literal" && typeof source.value === "string" ? source.value : null;
-};
-
-export const importEqualsSpecifierOf = (node: ImportEqualsNode): string | null => {
-  const reference = node.moduleReference;
-  if (reference?.type !== "TSExternalModuleReference") return null;
-  const value = reference.expression?.value;
-  return typeof value === "string" ? value : null;
+// A diagnostic is placed by the node's range, which every node of oxlint's
+// tree carries; a node from another parse carries `start` and `end`.
+export const at = (node: SyntaxNode): ReportableNode => ({
+  range: node.range ?? [node.start, node.end],
+});
+
+// The facts of one file, read once and shared by every rule that runs on it:
+// oxlint deserialises a file's tree once and hands the same `Program` to each
+// rule, so the tree is the key.
+const read = new WeakMap<Program, ReadFacts>();
+
+export const factsOfProgram = (file: string, program: Program): ReadFacts => {
+  const found = read.get(program);
+  if (found !== undefined) return found;
+  // oxlint's node types are `@oxc-project/types`' with `parent` required on
+  // every node — the same tree, generated from the same source. Each node
+  // type assigns on its own; the compiler gives up relating the two
+  // ~190-member recursive unions as wholes, so the boundary is asserted once,
+  // here. The parity suite is what proves the trees are one.
+  const facts = readProgram(file, program as ProgramBody);
+  read.set(program, facts);
+  return facts;
 };

package/src/plugin.ts

@@ -1,4 +1,5 @@
-import { DEFAULT_CONFIG_FILENAME, loadPolicyFromFile } from "./config-loader.js";
+import { makeCampaignsRule } from "./campaigns-rule.js";
+import { loadPolicyFromFile } from "./config-loader.js";
 import { makeExportsRule } from "./exports-rule.js";
 import { makeImportsRule } from "./imports-rule.js";
 import { makeMembersRule } from "./members-rule.js";
@@ -13,7 +14,7 @@ import { makeSurfaceRule } from "./surface-rule.js";
 // codebase.
 const policy = await loadPolicyFromFile(
   process.env.ARCHITECTURE_ROOT ?? process.cwd(),
-  process.env.ARCHITECTURE_CONFIG ?? DEFAULT_CONFIG_FILENAME,
+  process.env.ARCHITECTURE_CONFIG,
 );
 
 // A manifest written in a shape on its way out still loads; it says so once,
@@ -28,12 +29,14 @@ export const rules: {
   readonly members: OxlintRule;
   readonly structure: OxlintRule;
   readonly surface: OxlintRule;
+  readonly campaigns: OxlintRule;
 } = {
   imports: makeImportsRule(policy),
   exports: makeExportsRule(policy),
   members: makeMembersRule(policy),
   structure: makeStructureRule(policy),
   surface: makeSurfaceRule(policy),
+  campaigns: makeCampaignsRule(policy),
 };
 
 const plugin: { readonly meta: { readonly name: string }; readonly rules: typeof rules } = {

package/src/surface-rule.ts

@@ -1,193 +1,21 @@
 import {
   type CompiledSurfaceRule,
-  type DeclarationKind,
   evaluateSurface,
-  type ExportSite,
   formatMessage,
   type LoadedPolicy,
   surfaceRulesSelecting,
 } from "@goodbones/core";
+import type { ReadExportSite } from "@goodbones/typescript";
 
 import {
+  at,
+  factsOfProgram,
   type OxlintRule,
-  type ReportableNode,
+  type Program,
   type RuleContext,
   toRepoRelative,
 } from "./oxlint-api.js";
 
-type NamedNode = ReportableNode & {
-  readonly type?: string;
-  readonly name?: unknown;
-  readonly value?: unknown;
-};
-
-// A top-level statement, as far as this rule reads one. Every field is
-// optional because the visitor takes the whole `Node` union; each is checked
-// before use.
-type StatementNode = ReportableNode & {
-  readonly type: string;
-  readonly id?: NamedNode | null;
-  readonly declaration?: StatementNode | null;
-  readonly declarations?: ReadonlyArray<{ readonly id?: PatternNode | null }> | null;
-  readonly specifiers?: ReadonlyArray<SpecifierNode> | null;
-  readonly source?: { readonly value?: unknown } | null;
-  readonly exported?: NamedNode | null;
-};
-
-type PatternNode = ReportableNode & {
-  readonly type: string;
-  readonly name?: unknown;
-  readonly properties?: ReadonlyArray<{
-    readonly value?: PatternNode | null;
-    readonly argument?: PatternNode | null;
-  }> | null;
-  readonly elements?: ReadonlyArray<PatternNode | null> | null;
-  readonly left?: PatternNode | null;
-  readonly argument?: PatternNode | null;
-};
-
-type SpecifierNode = ReportableNode & {
-  readonly exported?: NamedNode | null;
-  readonly local?: NamedNode | null;
-};
-
-type ProgramNode = ReportableNode & { readonly body?: unknown };
-
-const isStatementList = (value: unknown): value is ReadonlyArray<StatementNode> =>
-  Array.isArray(value);
-
-const nameOf = (node: NamedNode | null | undefined): string | null => {
-  if (node === null || node === undefined) return null;
-  if (typeof node.name === "string") return node.name;
-  return typeof node.value === "string" ? node.value : null;
-};
-
-// The identifiers a binding pattern introduces.
-const patternNames = (pattern: PatternNode | null | undefined): ReadonlyArray<string> => {
-  if (pattern === null || pattern === undefined) return [];
-  switch (pattern.type) {
-    case "Identifier":
-      return typeof pattern.name === "string" ? [pattern.name] : [];
-    case "ObjectPattern":
-      return (pattern.properties ?? []).flatMap((property) =>
-        patternNames(property.value ?? property.argument),
-      );
-    case "ArrayPattern":
-      return (pattern.elements ?? []).flatMap(patternNames);
-    case "AssignmentPattern":
-      return patternNames(pattern.left);
-    case "RestElement":
-      return patternNames(pattern.argument);
-    default:
-      return [];
-  }
-};
-
-// The names a declaration statement introduces, with what it declares them as.
-const declaredNamesOf = (
-  statement: StatementNode,
-): ReadonlyArray<readonly [string, DeclarationKind]> => {
-  const named = (declares: DeclarationKind): ReadonlyArray<readonly [string, DeclarationKind]> => {
-    const name = nameOf(statement.id);
-    return name === null ? [] : [[name, declares]];
-  };
-  switch (statement.type) {
-    case "FunctionDeclaration":
-      return named("function");
-    case "ClassDeclaration":
-      return named("class");
-    case "VariableDeclaration":
-      return (statement.declarations ?? []).flatMap((declaration) =>
-        patternNames(declaration.id).map((name) => [name, "variable"] as const),
-      );
-    case "TSTypeAliasDeclaration":
-      return named("type");
-    case "TSInterfaceDeclaration":
-      return named("interface");
-    case "TSEnumDeclaration":
-      return named("enum");
-    case "TSModuleDeclaration":
-      return named("other");
-    default:
-      return [];
-  }
-};
-
-type Found = { readonly site: ExportSite; readonly node: ReportableNode };
-
-// A file's surface, read off the program body rather than by visiting export
-// nodes: an `export` inside a namespace body is that namespace's, not the
-// module's, and reading the top level directly is what says so without a
-// parent pointer. Mirrors the CLI's `exportSitesOf`.
-const surfaceOf = (file: string, body: ReadonlyArray<StatementNode>): ReadonlyArray<Found> => {
-  const locals = new Map<string, DeclarationKind>();
-  for (const statement of body) {
-    const declaration =
-      statement.type === "ExportNamedDeclaration" || statement.type === "ExportDefaultDeclaration"
-        ? statement.declaration
-        : statement;
-    if (declaration === null || declaration === undefined) continue;
-    for (const [name, declares] of declaredNamesOf(declaration)) locals.set(name, declares);
-  }
-
-  const found: Array<Found> = [];
-  const site = (
-    node: ReportableNode,
-    name: string,
-    kind: ExportSite["kind"],
-    declares: DeclarationKind,
-    reexport: boolean,
-  ): void => {
-    found.push({ node, site: { file, name, kind, declares, reexport } });
-  };
-
-  for (const statement of body) {
-    switch (statement.type) {
-      case "ExportNamedDeclaration": {
-        const declaration = statement.declaration;
-        if (declaration !== null && declaration !== undefined) {
-          for (const [name, declares] of declaredNamesOf(declaration)) {
-            site(declaration, name, "named", declares, false);
-          }
-          break;
-        }
-        const reexport = typeof statement.source?.value === "string";
-        for (const specifier of statement.specifiers ?? []) {
-          const name = nameOf(specifier.exported);
-          if (name === null) continue;
-          const local = nameOf(specifier.local) ?? name;
-          const declares = reexport ? "other" : (locals.get(local) ?? "other");
-          site(specifier, name, name === "default" ? "default" : "named", declares, reexport);
-        }
-        break;
-      }
-      case "ExportDefaultDeclaration": {
-        const declaration = statement.declaration;
-        const declares: DeclarationKind =
-          declaration === null || declaration === undefined
-            ? "expression"
-            : declaration.type === "FunctionDeclaration"
-              ? "function"
-              : declaration.type === "ClassDeclaration"
-                ? "class"
-                : declaration.type === "TSInterfaceDeclaration"
-                  ? "interface"
-                  : declaration.type === "Identifier"
-                    ? (locals.get(nameOf(declaration) ?? "") ?? "expression")
-                    : "expression";
-        site(statement, "default", "default", declares, false);
-        break;
-      }
-      case "ExportAllDeclaration":
-        site(statement, nameOf(statement.exported) ?? "*", "namespace", "other", true);
-        break;
-      default:
-        break;
-    }
-  }
-  return found;
-};
-
 export const makeSurfaceRule = (policy: LoadedPolicy): OxlintRule => ({
   meta: {
     type: "problem" as const,
@@ -210,26 +38,24 @@ export const makeSurfaceRule = (policy: LoadedPolicy): OxlintRule => ({
         return selected.length > 0;
       },
 
-      Program(node: ProgramNode) {
-        if (!isStatementList(node.body)) return;
-        const found = surfaceOf(file, node.body);
-        const violations = evaluateSurface(
-          selected,
-          file,
-          found.map((one) => one.site),
-        );
+      Program(node: Program) {
+        const sites = factsOfProgram(file, node).exportSites;
+        const violations = evaluateSurface(selected, file, sites);
 
         // A per-site violation lands on the site's own node; a `count` one, on
         // the program — it is about the file.
-        const used = new Set<Found>();
+        const used = new Set<ReadExportSite>();
         for (const violation of violations) {
           if (policy.baseline.isBaselined(violation)) continue;
-          const at =
+          const site =
             violation.subject === null
               ? undefined
-              : found.find((one) => one.site.name === violation.subject && !used.has(one));
-          if (at !== undefined) used.add(at);
-          context.report({ node: at?.node ?? node, message: formatMessage(violation) });
+              : sites.find((one) => one.name === violation.subject && !used.has(one));
+          if (site !== undefined) used.add(site);
+          context.report({
+            node: site === undefined ? node : at(site.node),
+            message: formatMessage(violation),
+          });
         }
       },
     };