@sarj/eslint-plugin 18.3.1 → 19.0.1

package/dist/rule-examples.js

@@ -1,295 +1,150 @@
 // src/verify-rule-examples.ts
+import { AssertionError } from "assert";
 import { mkdtemp, mkdir, rm, writeFile, readFile, symlink } from "fs/promises";
 import { tmpdir } from "os";
-import { dirname as dirname2, join, resolve as resolve2, sep } from "path";
-import * as parser2 from "@typescript-eslint/parser";
-import { Linter } from "eslint";
-
-// src/create-example-parser.ts
-import { basename, dirname, resolve } from "path";
-import * as parser from "@typescript-eslint/parser";
-import ts from "typescript";
-var WATCH_DEFAULTS = {
-  noEmit: true,
-  noUnusedLocals: true,
-  noUnusedParameters: true,
+import { dirname, join, resolve, sep } from "path";
+import { parseSync } from "oxc-parser";
+import { RuleTester } from "oxlint/plugins-dev";
+var UNREACHABLE_OUTPUT = "\0sarj-rule-examples: actual fixed source\0";
+var DEFAULT_TSCONFIG = JSON.stringify({ compilerOptions: {
+  target: "ESNext",
+  module: "ESNext",
+  moduleResolution: "Bundler",
+  strict: true,
   allowJs: true,
-  allowNonTsExtensions: true,
-  checkJs: true
-};
-var MAX_LIBRARY_FILES = 256;
-var MAX_LIBRARY_BYTES = 16 * 1024 * 1024;
-function createExampleParser() {
-  const libraryRoot = ts.sys.realpath?.(dirname(ts.getDefaultLibFilePath({})));
-  const cache = /* @__PURE__ */ new Map();
-  const registries = /* @__PURE__ */ new Map();
-  const counts = { programs: 0, libraryAcquires: 0, libraryHits: 0, nativeFallbacks: 0 };
-  let bytes = 0;
-  return {
-    meta: parser.meta,
-    clear() {
-      cache.clear();
-      registries.clear();
-      bytes = 0;
-    },
-    statistics() {
-      return { ...counts, libraryFiles: cache.size, libraryBytes: bytes };
-    },
-    parseForESLint(code, options) {
-      const fallback = () => {
-        counts.nativeFallbacks += 1;
-        return parser.parseForESLint(code, options);
-      };
-      if (!Object.hasOwn(ts, "JSDocParsingMode")) return fallback();
-      if (typeof options?.project !== "string" || typeof options.filePath !== "string" || options.programs != null || options.projectService || options.extraFileExtensions?.length || options.debugLevel) {
-        return fallback();
-      }
-      const config = resolve(options.tsconfigRootDir ?? process.cwd(), options.project);
-      let unrecoverable = false;
-      const parsed = ts.getParsedCommandLineOfConfigFile(config, WATCH_DEFAULTS, {
-        ...ts.sys,
-        onUnRecoverableConfigFileDiagnostic() {
-          unrecoverable = true;
-        }
-      });
-      if (unrecoverable || parsed === void 0 || parsed.errors.length > 0 || parsed.projectReferences?.length) {
-        return fallback();
-      }
-      const filename = resolve(options.filePath);
-      const host = ts.createCompilerHost(parsed.options, true);
-      const canonical = (path) => host.getCanonicalFileName(resolve(path));
-      if (!parsed.fileNames.some((path) => canonical(path) === canonical(filename))) return fallback();
-      const mode = options.jsDocParsingMode === "none" ? ts.JSDocParsingMode.ParseNone : options.jsDocParsingMode === "type-info" ? ts.JSDocParsingMode.ParseForTypeInfo : ts.JSDocParsingMode.ParseAll;
-      host.jsDocParsingMode = mode;
-      let registry = registries.get(mode);
-      if (registry === void 0) {
-        registry = ts.createDocumentRegistry(ts.sys.useCaseSensitiveFileNames, process.cwd(), mode);
-        registries.set(mode, registry);
-      }
-      const settingsKey = registry.getKeyForCompilationSettings(parsed.options);
-      const read = host.readFile.bind(host);
-      host.readFile = (path) => canonical(path) === canonical(filename) ? code : read(path);
-      const original = host.getSourceFile.bind(host);
-      host.getSourceFile = (path, language, onError, fresh) => {
-        if (fresh || libraryRoot === void 0 || host.realpath === void 0 || canonical(path) === canonical(filename) || dirname(resolve(path)) !== libraryRoot || !/^lib(?:\..+)?\.d\.ts$/u.test(basename(path)) || !host.fileExists(path)) {
-          return original(path, language, onError, fresh);
-        }
-        try {
-          if (host.realpath(path) !== resolve(path)) return original(path, language, onError, fresh);
-        } catch {
-          return original(path, language, onError, fresh);
-        }
-        const text = read(path);
-        if (text === void 0) return original(path, language, onError, fresh);
-        const version = typeof language === "number" ? language : language.languageVersion;
-        const format = typeof language === "number" ? void 0 : language.impliedNodeFormat;
-        const key = JSON.stringify([path, settingsKey, version, format, mode]);
-        const previous = cache.get(key);
-        if (previous?.text === text) {
-          counts.libraryHits += 1;
-          return previous.source;
-        }
-        const size = Buffer.byteLength(text);
-        if (previous !== void 0 || cache.size >= MAX_LIBRARY_FILES || bytes + size > MAX_LIBRARY_BYTES) {
-          return original(path, language, onError, fresh);
-        }
-        const source = registry.acquireDocument(
-          path,
-          parsed.options,
-          ts.ScriptSnapshot.fromString(text),
-          "unchanged-native-library",
-          ts.ScriptKind.TS,
-          language
-        );
-        cache.set(key, { text, source });
-        bytes += size;
-        counts.libraryAcquires += 1;
-        return source;
-      };
-      const program = ts.createProgram(parsed.fileNames, parsed.options, host);
-      counts.programs += 1;
-      if (program.getSourceFile(filename)?.text !== code) {
-        throw new Error("The example compiler did not load the current lint source.");
-      }
-      return parser.parseForESLint(code, {
-        ...options,
-        project: false,
-        projectService: false,
-        programs: [program],
-        disallowAutomaticSingleRunInference: true
-      });
-    }
-  };
-}
-
-// src/verify-rule-examples.ts
+  jsx: "preserve",
+  noEmit: true
+}, include: ["**/*"] });
 async function verifyRuleExamples(rule, setup = {}) {
   const spec = rule.documentation;
-  if (spec === void 0 || !spec.publicExamples.some((item) => item.outcome === "match") || !spec.publicExamples.some((item) => item.outcome === "no-match")) {
+  if (!spec.publicExamples.some((item) => item.outcome === "match") || !spec.publicExamples.some((item) => item.outcome === "no-match")) {
     throw new Error("rule requires documented public matching and non-matching examples");
   }
-  const exampleParser = createExampleParser();
-  try {
-    for (const example of spec.examples) {
-      const root = await mkdtemp(join(tmpdir(), "sarj-rule-example-"));
-      try {
-        for (const file of example.files) {
-          const path = fixturePath(root, file.path);
-          validateFixtureSyntax(example.id, file, path);
-          await mkdir(dirname2(path), { recursive: true });
-          await writeFile(path, file.source);
-        }
-        for (const dependency of example.installedDependencies ?? []) {
-          if (setup.installedDependencyRoot === void 0) throw new Error(`${example.id}: explicit installed dependency root is required`);
-          const packageFile = fixturePath(resolve2(setup.installedDependencyRoot), `node_modules/${dependency.module}/package.json`);
-          const metadata = JSON.parse(await readFile(packageFile, "utf8"));
-          if (typeof metadata !== "object" || metadata === null || !("name" in metadata) || !("version" in metadata) || metadata.name !== dependency.module || metadata.version !== dependency.version) throw new Error(`${example.id}: installed dependency identity/version mismatch for ${dependency.module}`);
-          const destination = fixturePath(root, `node_modules/${dependency.module}`);
-          await mkdir(dirname2(destination), { recursive: true });
-          await symlink(dirname2(packageFile), destination, process.platform === "win32" ? "junction" : "dir");
-        }
-        const tsconfig = join(root, "tsconfig.json");
-        if (!example.files.some((file) => file.path === "tsconfig.json")) {
-          await writeFile(tsconfig, JSON.stringify({ compilerOptions: {
-            target: "ESNext",
-            module: "ESNext",
-            moduleResolution: "Bundler",
-            strict: true,
-            allowJs: true,
-            jsx: "preserve",
-            noEmit: true
-          }, include: ["**/*"] }));
-        }
-        const ruleId = `@sarj/${spec.ruleId}`;
-        const config = {
-          files: ["**/*.{ts,tsx,js,jsx,mts,cts,mjs,cjs}"],
-          languageOptions: { parser: exampleParser, parserOptions: { project: tsconfig, tsconfigRootDir: root, disallowAutomaticSingleRunInference: true } },
-          plugins: { "@sarj": { rules: { [spec.ruleId]: rule } } },
-          rules: { [ruleId]: ["error", ...example.ruleOptions ?? rule.meta.defaultOptions ?? rule.defaultOptions ?? []] }
-        };
-        await verifyExample(new Linter({ cwd: root }), config, example, root, ruleId, setup.formatFixedSource);
-      } finally {
-        parser2.clearCaches();
-        await rm(root, { recursive: true, force: true });
-      }
+  for (const example of spec.examples) {
+    const root = await mkdtemp(join(tmpdir(), "sarj-rule-example-"));
+    try {
+      await writeProject(root, example, setup);
+      await verifyExample(rule, example, root, setup.formatFixedSource);
+    } finally {
+      await rm(root, { recursive: true, force: true });
     }
-  } finally {
-    exampleParser.clear();
   }
   return spec.examples.length;
 }
+async function writeProject(root, example, setup) {
+  for (const file of example.files) {
+    const path = fixturePath(root, file.path);
+    validateFixtureSyntax(example.id, file, path);
+    await mkdir(dirname(path), { recursive: true });
+    await writeFile(path, file.source);
+  }
+  for (const dependency of example.installedDependencies ?? []) {
+    if (setup.installedDependencyRoot === void 0) throw new Error(`${example.id}: explicit installed dependency root is required`);
+    const packageFile = fixturePath(resolve(setup.installedDependencyRoot), `node_modules/${dependency.module}/package.json`);
+    const metadata = JSON.parse(await readFile(packageFile, "utf8"));
+    if (typeof metadata !== "object" || metadata === null || !("name" in metadata) || !("version" in metadata) || metadata.name !== dependency.module || metadata.version !== dependency.version) throw new Error(`${example.id}: installed dependency identity/version mismatch for ${dependency.module}`);
+    const destination = fixturePath(root, `node_modules/${dependency.module}`);
+    await mkdir(dirname(destination), { recursive: true });
+    await symlink(dirname(packageFile), destination, process.platform === "win32" ? "junction" : "dir");
+  }
+  if (!example.files.some((file) => file.path === "tsconfig.json")) {
+    await writeFile(join(root, "tsconfig.json"), DEFAULT_TSCONFIG);
+  }
+}
 function fixturePath(root, path) {
-  const resolved = resolve2(root, path);
+  const resolved = resolve(root, path);
   if (!resolved.startsWith(root + sep)) throw new Error(`unsafe example path: ${path}`);
   return resolved;
 }
 function validateFixtureSyntax(exampleId, file, path) {
   if (!/\.[cm]?[jt]sx?$/u.test(file.path)) return;
-  try {
-    parser2.parse(file.source, { filePath: path });
-  } catch (error) {
-    throw new Error(`${exampleId}: invalid fixture ${file.path}`, { cause: error });
-  }
+  const [error] = parseSync(path, file.source).errors;
+  if (error !== void 0) throw new Error(`${exampleId}: invalid fixture ${file.path}: ${error.message}`);
 }
-async function verifyExample(linter, config, example, root, ruleId, formatFixedSource) {
+async function verifyExample(rule, example, root, formatFixedSource) {
   const focus = example.files.find((file) => file.path === example.focusPath);
   if (focus === void 0) throw new Error(`${example.id}: focus file is missing`);
-  const filename = fixturePath(root, focus.path);
-  const messages = linter.verify(focus.source, config, { filename });
-  if (messages.some((message) => message.fatal || message.ruleId !== ruleId)) {
-    throw new Error(`${example.id}: invalid fixture: ${messages.map((message) => message.message).join("; ")}`);
-  }
-  const lines = linter.getSourceCode().lines;
-  if (messages.some((message) => !physicalDiagnosticLocation(message, lines))) {
-    throw new Error(`${example.id}: invalid diagnostic location`);
-  }
-  const locations = messages.map((message) => JSON.stringify([
-    message.ruleId,
-    message.messageId ?? message.message,
-    message.line,
-    message.column,
-    message.endLine,
-    message.endColumn
-  ]));
-  if (new Set(locations).size !== locations.length) throw new Error(`${example.id}: duplicate diagnostic`);
-  if (messages.length !== example.expectedCount) {
-    throw new Error(`${example.id}: expected ${example.expectedCount} findings, received ${messages.length}`);
-  }
-  if (example.expectedDiagnostics !== void 0) {
-    verifyExpectedDiagnostics(example, messages, focus.source, lines);
+  const base = {
+    code: focus.source,
+    filename: fixturePath(root, focus.path),
+    // Authored options are JSON data: the catalog publishes them.
+    ...example.ruleOptions !== void 0 && { options: [...example.ruleOptions] }
+  };
+  const name = rule.documentation.ruleId;
+  const tested = rule;
+  const tester = new RuleTester({ eslintCompat: true, cwd: root });
+  if (example.expectedCount === 0) {
+    run(example, () => {
+      tester.run(name, tested, { valid: [base], invalid: [] });
+    });
+    return;
   }
-  for (const expected of example.fixedFiles ?? []) {
-    const input = example.files.find((file) => file.path === expected.path);
-    if (input === void 0) throw new Error(`${example.id}: fixed file has no original`);
-    const options = { filename: fixturePath(root, input.path) };
-    const fixed = linter.verifyAndFix(input.source, config, options);
-    if (formatFixedSource === void 0 && fixed.output !== expected.source) throw new Error(`${example.id}: unexpected fixed source`);
-    await writeFile(options.filename, fixed.output);
-    const repeated = linter.verifyAndFix(fixed.output, config, options);
-    if (repeated.fixed || repeated.output !== fixed.output || repeated.messages.length > 0) {
-      throw new Error(`${example.id}: fix is not clean and idempotent`);
-    }
-    if (formatFixedSource !== void 0 && await formatFixedSource({ path: input.path, source: fixed.output }, example) !== expected.source) {
-      throw new Error(`${example.id}: unexpected fixed source`);
+  const expected = example.expectedDiagnostics?.toSorted(byLocation);
+  const fixed = actualFixedSource(example, () => {
+    tester.run(name, tested, { valid: [], invalid: [{ ...base, errors: expected?.map(identity) ?? example.expectedCount, output: UNREACHABLE_OUTPUT, recursive: true }] });
+  });
+  if (expected !== void 0) {
+    actualFixedSource(example, () => {
+      tester.run(name, tested, { valid: [], invalid: [{ ...base, errors: expected.map(message), output: UNREACHABLE_OUTPUT, recursive: true }] });
+    });
+    if (expected.some((item) => item.automaticFix) !== (fixed !== focus.source)) {
+      throw new Error(`${example.id}: automatic fix delivery differs from the expected diagnostics`);
     }
   }
-}
-function verifyExpectedDiagnostics(example, messages, source, lines) {
-  const expectations = example.expectedDiagnostics ?? [];
-  if (expectations.some((item) => !physicalExpectedLocation(item.location, lines))) {
-    throw new Error(`${example.id}: invalid expected diagnostic location`);
-  }
-  const expected = expectations.map(expectedDiagnosticKey).sort();
-  const actual = messages.map((message) => JSON.stringify([
-    message.messageId,
-    message.message,
-    [message.line, message.column, message.endLine, message.endColumn],
-    message.fix !== void 0,
-    (message.suggestions ?? []).map((suggestion) => [
-      suggestion.messageId,
-      applySuggestion(source, suggestion.fix, example.id)
-    ])
-  ])).sort();
-  if (JSON.stringify(actual) !== JSON.stringify(expected)) {
-    throw new Error(`${example.id}: unexpected diagnostics
-expected: ${JSON.stringify(expected)}
-received: ${JSON.stringify(actual)}`);
+  const expectedFixed = example.fixedFiles?.find((file) => file.path === focus.path);
+  if (expectedFixed === void 0) return;
+  if (formatFixedSource === void 0 && fixed !== expectedFixed.source) throw new Error(`${example.id}: unexpected fixed source`);
+  await writeFile(fixturePath(root, focus.path), fixed);
+  run(example, () => {
+    tester.run(name, tested, { valid: [{ ...base, code: fixed }], invalid: [] });
+  });
+  if (formatFixedSource !== void 0 && await formatFixedSource({ path: focus.path, source: fixed }, example) !== expectedFixed.source) {
+    throw new Error(`${example.id}: unexpected fixed source`);
   }
 }
-function expectedDiagnosticKey(expected) {
-  return JSON.stringify([
-    expected.messageId,
-    expected.message,
-    [expected.location.line, expected.location.column, expected.location.end?.line, expected.location.end?.column],
-    expected.automaticFix,
-    expected.suggestions.map((suggestion) => [suggestion.messageId, suggestion.output])
-  ]);
+function byLocation(left, right) {
+  const lines = left.location.line - right.location.line;
+  return lines === 0 ? left.location.column - right.location.column : lines;
 }
-function applySuggestion(source, fix, exampleId) {
-  const bom = source.startsWith("\uFEFF") ? "\uFEFF" : "";
-  const text = bom === "" ? source : source.slice(1);
-  const [start, end] = fix.range;
-  if (!Number.isSafeInteger(start) || !Number.isSafeInteger(end) || start > end || start < (bom === "" ? 0 : -1) || end < 0 || end > text.length) {
-    throw new Error(`${exampleId}: invalid suggestion edit range`);
-  }
-  const prefix = start < 0 && end >= 0 || start === 0 && fix.text.startsWith("\uFEFF") ? "" : bom;
-  return prefix + text.slice(0, Math.max(0, start)) + fix.text + text.slice(end);
+function location({ location: { line, column, end } }) {
+  return { line, column, endLine: end?.line, endColumn: end?.column };
 }
-function physicalExpectedLocation(location, lines) {
-  if (!physicalPosition(lines, location.line, location.column)) return false;
-  if (location.end === void 0) return true;
-  return physicalPosition(lines, location.end.line, location.end.column) && (location.end.line > location.line || location.end.line === location.line && location.end.column >= location.column);
+function identity(expected) {
+  return {
+    ...location(expected),
+    messageId: expected.messageId,
+    suggestions: expected.suggestions.map((suggestion) => ({ messageId: suggestion.messageId, output: suggestion.output }))
+  };
 }
-function physicalDiagnosticLocation(message, lines) {
-  if (!physicalPosition(lines, message.line, message.column)) return false;
-  if (message.endLine === void 0 && message.endColumn === void 0) return true;
-  if (!physicalPosition(lines, message.endLine, message.endColumn)) return false;
-  return message.endLine !== void 0 && message.endColumn !== void 0 && (message.endLine > message.line || message.endLine === message.line && message.endColumn >= message.column);
+function message(expected) {
+  return { ...location(expected), message: expected.message };
 }
-function physicalPosition(lines, line, column) {
-  if (line === void 0 || column === void 0 || !Number.isInteger(line) || !Number.isInteger(column)) return false;
-  const text = lines[line - 1];
-  return text !== void 0 && column >= 1 && column <= text.length + 1;
+function run(example, body) {
+  const { describe, it } = RuleTester;
+  RuleTester.describe = (_text, method) => {
+    method();
+  };
+  RuleTester.it = (_text, method) => {
+    method();
+  };
+  try {
+    body();
+  } catch (error) {
+    throw new Error(`${example.id}: ${error instanceof Error ? error.message : String(error)}`, { cause: error });
+  } finally {
+    RuleTester.describe = describe;
+    RuleTester.it = it;
+  }
+}
+function actualFixedSource(example, body) {
+  try {
+    run(example, body);
+  } catch (error) {
+    const { cause } = error;
+    if (cause instanceof AssertionError && cause.expected === UNREACHABLE_OUTPUT && typeof cause.actual === "string") return cause.actual;
+    throw error;
+  }
+  throw new Error(`${example.id}: RuleTester accepted an unreachable fixed source`);
 }
 export {
   verifyRuleExamples