@sarj/eslint-plugin 18.3.1 → 19.0.1

package/dist/rule-examples.cjs

@@ -1,331 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/verify-rule-examples.ts
-var verify_rule_examples_exports = {};
-__export(verify_rule_examples_exports, {
-  verifyRuleExamples: () => verifyRuleExamples
-});
-module.exports = __toCommonJS(verify_rule_examples_exports);
-var import_promises = require("fs/promises");
-var import_node_os = require("os");
-var import_node_path2 = require("path");
-var parser2 = __toESM(require("@typescript-eslint/parser"), 1);
-var import_eslint = require("eslint");
-
-// src/create-example-parser.ts
-var import_node_path = require("path");
-var parser = __toESM(require("@typescript-eslint/parser"), 1);
-var import_typescript = __toESM(require("typescript"), 1);
-var WATCH_DEFAULTS = {
-  noEmit: true,
-  noUnusedLocals: true,
-  noUnusedParameters: true,
-  allowJs: true,
-  allowNonTsExtensions: true,
-  checkJs: true
-};
-var MAX_LIBRARY_FILES = 256;
-var MAX_LIBRARY_BYTES = 16 * 1024 * 1024;
-function createExampleParser() {
-  const libraryRoot = import_typescript.default.sys.realpath?.((0, import_node_path.dirname)(import_typescript.default.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(import_typescript.default, "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 = (0, import_node_path.resolve)(options.tsconfigRootDir ?? process.cwd(), options.project);
-      let unrecoverable = false;
-      const parsed = import_typescript.default.getParsedCommandLineOfConfigFile(config, WATCH_DEFAULTS, {
-        ...import_typescript.default.sys,
-        onUnRecoverableConfigFileDiagnostic() {
-          unrecoverable = true;
-        }
-      });
-      if (unrecoverable || parsed === void 0 || parsed.errors.length > 0 || parsed.projectReferences?.length) {
-        return fallback();
-      }
-      const filename = (0, import_node_path.resolve)(options.filePath);
-      const host = import_typescript.default.createCompilerHost(parsed.options, true);
-      const canonical = (path) => host.getCanonicalFileName((0, import_node_path.resolve)(path));
-      if (!parsed.fileNames.some((path) => canonical(path) === canonical(filename))) return fallback();
-      const mode = options.jsDocParsingMode === "none" ? import_typescript.default.JSDocParsingMode.ParseNone : options.jsDocParsingMode === "type-info" ? import_typescript.default.JSDocParsingMode.ParseForTypeInfo : import_typescript.default.JSDocParsingMode.ParseAll;
-      host.jsDocParsingMode = mode;
-      let registry = registries.get(mode);
-      if (registry === void 0) {
-        registry = import_typescript.default.createDocumentRegistry(import_typescript.default.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) || (0, import_node_path.dirname)((0, import_node_path.resolve)(path)) !== libraryRoot || !/^lib(?:\..+)?\.d\.ts$/u.test((0, import_node_path.basename)(path)) || !host.fileExists(path)) {
-          return original(path, language, onError, fresh);
-        }
-        try {
-          if (host.realpath(path) !== (0, import_node_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,
-          import_typescript.default.ScriptSnapshot.fromString(text),
-          "unchanged-native-library",
-          import_typescript.default.ScriptKind.TS,
-          language
-        );
-        cache.set(key, { text, source });
-        bytes += size;
-        counts.libraryAcquires += 1;
-        return source;
-      };
-      const program = import_typescript.default.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
-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")) {
-    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 (0, import_promises.mkdtemp)((0, import_node_path2.join)((0, import_node_os.tmpdir)(), "sarj-rule-example-"));
-      try {
-        for (const file of example.files) {
-          const path = fixturePath(root, file.path);
-          validateFixtureSyntax(example.id, file, path);
-          await (0, import_promises.mkdir)((0, import_node_path2.dirname)(path), { recursive: true });
-          await (0, import_promises.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((0, import_node_path2.resolve)(setup.installedDependencyRoot), `node_modules/${dependency.module}/package.json`);
-          const metadata = JSON.parse(await (0, import_promises.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 (0, import_promises.mkdir)((0, import_node_path2.dirname)(destination), { recursive: true });
-          await (0, import_promises.symlink)((0, import_node_path2.dirname)(packageFile), destination, process.platform === "win32" ? "junction" : "dir");
-        }
-        const tsconfig = (0, import_node_path2.join)(root, "tsconfig.json");
-        if (!example.files.some((file) => file.path === "tsconfig.json")) {
-          await (0, import_promises.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 import_eslint.Linter({ cwd: root }), config, example, root, ruleId, setup.formatFixedSource);
-      } finally {
-        parser2.clearCaches();
-        await (0, import_promises.rm)(root, { recursive: true, force: true });
-      }
-    }
-  } finally {
-    exampleParser.clear();
-  }
-  return spec.examples.length;
-}
-function fixturePath(root, path) {
-  const resolved = (0, import_node_path2.resolve)(root, path);
-  if (!resolved.startsWith(root + import_node_path2.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 });
-  }
-}
-async function verifyExample(linter, config, example, root, ruleId, 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);
-  }
-  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 (0, import_promises.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`);
-    }
-  }
-}
-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)}`);
-  }
-}
-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 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 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 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 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;
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  verifyRuleExamples
-});

package/dist/rule-examples.d.cts

@@ -1,15 +0,0 @@
-import { E as ExampleFile, R as RuleExample } from './_docs-d31-QA2S.cjs';
-import { DocumentedRule } from './index.cjs';
-import '@typescript-eslint/utils';
-import 'eslint';
-import '@eslint/core';
-
-type FixedSourceFormatter = (file: ExampleFile, example: RuleExample) => string | Promise<string>;
-/** Execute all authored examples, including private regressions, in isolated projects. */
-declare function verifyRuleExamples<Options extends readonly unknown[], MessageIds extends string>(rule: DocumentedRule<Options, MessageIds>, setup?: {
-    readonly installedDependencyRoot?: string;
-    readonly formatFixedSource?: FixedSourceFormatter;
-}): Promise<number>;
-
-export { ExampleFile, RuleExample, verifyRuleExamples };
-export type { FixedSourceFormatter };

package/dist/rule-examples.d.ts

@@ -1,15 +0,0 @@
-import { E as ExampleFile, R as RuleExample } from './_docs-d31-QA2S.js';
-import { DocumentedRule } from './index.js';
-import '@typescript-eslint/utils';
-import 'eslint';
-import '@eslint/core';
-
-type FixedSourceFormatter = (file: ExampleFile, example: RuleExample) => string | Promise<string>;
-/** Execute all authored examples, including private regressions, in isolated projects. */
-declare function verifyRuleExamples<Options extends readonly unknown[], MessageIds extends string>(rule: DocumentedRule<Options, MessageIds>, setup?: {
-    readonly installedDependencyRoot?: string;
-    readonly formatFixedSource?: FixedSourceFormatter;
-}): Promise<number>;
-
-export { ExampleFile, RuleExample, verifyRuleExamples };
-export type { FixedSourceFormatter };