@sarj/eslint-plugin 16.36.7 → 16.38.52

package/dist/rule-examples.cjs

@@ -35,68 +35,192 @@ __export(verify_rule_examples_exports, {
 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_eslint = require("eslint");
+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");
   }
-  for (const example of spec.examples) {
-    const root = await (0, import_promises.mkdtemp)((0, import_node_path.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_path.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_path.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_path.dirname)(destination), { recursive: true });
-        await (0, import_promises.symlink)((0, import_node_path.dirname)(packageFile), destination, process.platform === "win32" ? "junction" : "dir");
-      }
-      const tsconfig = (0, import_node_path.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 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.defaultOptions ?? []] }
+        };
+        await verifyExample(new import_eslint.Linter({ cwd: root }), config, example, root, ruleId);
+      } finally {
+        parser2.clearCaches();
+        await (0, import_promises.rm)(root, { recursive: true, force: true });
       }
-      const ruleId = `@sarj/${spec.ruleId}`;
-      const config = {
-        files: ["**/*.{ts,tsx,js,jsx,mts,cts,mjs,cjs}"],
-        languageOptions: { parser, parserOptions: { project: tsconfig, tsconfigRootDir: root, disallowAutomaticSingleRunInference: true } },
-        plugins: { "@sarj": { rules: { [spec.ruleId]: rule } } },
-        rules: { [ruleId]: ["error", ...example.ruleOptions ?? rule.defaultOptions ?? []] }
-      };
-      await verifyExample(new import_eslint.Linter({ cwd: root }), config, example, root, ruleId);
-    } finally {
-      parser.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_path.resolve)(root, path);
-  if (!resolved.startsWith(root + import_node_path.sep)) throw new Error(`unsafe example path: ${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 {
-    parser.parse(file.source, { filePath: path });
+    parser2.parse(file.source, { filePath: path });
   } catch (error) {
     throw new Error(`${exampleId}: invalid fixture ${file.path}`, { cause: error });
   }

package/dist/rule-examples.js

@@ -1,68 +1,192 @@
 // src/verify-rule-examples.ts
 import { mkdtemp, mkdir, rm, writeFile, readFile, symlink } from "fs/promises";
 import { tmpdir } from "os";
-import { dirname, join, resolve, sep } from "path";
-import * as parser from "@typescript-eslint/parser";
+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,
+  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
 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");
   }
-  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(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");
-      }
-      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 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.defaultOptions ?? []] }
+        };
+        await verifyExample(new Linter({ cwd: root }), config, example, root, ruleId);
+      } finally {
+        parser2.clearCaches();
+        await rm(root, { recursive: true, force: true });
       }
-      const ruleId = `@sarj/${spec.ruleId}`;
-      const config = {
-        files: ["**/*.{ts,tsx,js,jsx,mts,cts,mjs,cjs}"],
-        languageOptions: { parser, parserOptions: { project: tsconfig, tsconfigRootDir: root, disallowAutomaticSingleRunInference: true } },
-        plugins: { "@sarj": { rules: { [spec.ruleId]: rule } } },
-        rules: { [ruleId]: ["error", ...example.ruleOptions ?? rule.defaultOptions ?? []] }
-      };
-      await verifyExample(new Linter({ cwd: root }), config, example, root, ruleId);
-    } finally {
-      parser.clearCaches();
-      await rm(root, { recursive: true, force: true });
     }
+  } finally {
+    exampleParser.clear();
   }
   return spec.examples.length;
 }
 function fixturePath(root, path) {
-  const resolved = resolve(root, path);
+  const resolved = resolve2(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 {
-    parser.parse(file.source, { filePath: path });
+    parser2.parse(file.source, { filePath: path });
   } catch (error) {
     throw new Error(`${exampleId}: invalid fixture ${file.path}`, { cause: error });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sarj/eslint-plugin",
-  "version": "16.36.7",
+  "version": "16.38.52",
   "packageManager": "npm@12.2.1",
   "description": "Custom ESLint rules for hypermodern TypeScript / React / Next.js projects",
   "type": "module",