@utoo/lint 0.2.2 → 0.2.3

package/README.md

@@ -64,6 +64,21 @@ lists autofix coverage by rule.
 
 ## Configuration
 
+`utoo-lint` supports two canonical project config formats:
+
+| Config | Use it when | Raw native binary |
+| --- | --- | --- |
+| `utlint.config.ts` | You want typed authoring, imports, or computed values. | No |
+| `utlint.config.json` | You want a static, runtime-independent config. | Yes |
+
+The npm CLI discovers either format automatically. It can also select one
+explicitly:
+
+```bash
+pnpm exec utoo-lint --config=utlint.config.ts src
+pnpm exec utoo-lint --config=utlint.config.json src
+```
+
 For a static config readable by both the npm CLI and raw native binary, create
 `utlint.config.json`:
 

package/index.cjs

@@ -484,7 +484,7 @@ class UtooLint {
   }
 
   async lintFiles(patterns, options = {}) {
-    const mergedOptions = mergeLintOptions(this.options, options);
+    const mergedOptions = withConfigCache(mergeLintOptions(this.options, options));
     const customRuleConfig = [mergedOptions.baseConfig, mergedOptions.overrideConfig].filter(Boolean);
     const customRuleFilterMap = customRuleMapForConfig(customRuleConfig, new Map());
     const nativeOptions = lintOptionsWithoutCustomRules(mergedOptions, customRuleFilterMap);
@@ -504,7 +504,7 @@ class UtooLint {
       throw new TypeError("code must be a string");
     }
 
-    const mergedOptions = mergeLintOptions(this.options, options);
+    const mergedOptions = withConfigCache(mergeLintOptions(this.options, options));
     const filePath = normalizeESLintFilePath(textFilePathForOptions(options, "<text>"), mergedOptions.cwd);
     const customRuleConfig = [mergedOptions.baseConfig, mergedOptions.overrideConfig].filter(Boolean);
     const customRuleMap = customRuleMapForConfig(customRuleConfig, new Map(), filePath, mergedOptions.cwd);
@@ -528,7 +528,7 @@ class UtooLint {
   }
 
   async calculateConfigForFile(filePath) {
-    return publicCalculatedConfig(eslintConstructorOptions(this.options), filePath);
+    return publicCalculatedConfig(withConfigCache(eslintConstructorOptions(this.options)), filePath);
   }
 
   async findConfigFile(filePath) {
@@ -610,7 +610,7 @@ class CLIEngine {
   }
 
   executeOnFiles(patterns) {
-    const mergedOptions = eslintConstructorOptions(this.options);
+    const mergedOptions = withConfigCache(eslintConstructorOptions(this.options));
     const report = lintFiles(patterns, mergedOptions);
     throwOnUnmatchedPatternDiagnostics(report, mergedOptions);
     const results = maybeFilterQuietResults(reportToESLintResults(report, {
@@ -630,10 +630,10 @@ class CLIEngine {
       typeof filePathOrOptions === "object" && filePathOrOptions !== null
         ? filePathOrOptions.filePath ?? filePathOrOptions.filename ?? "input.js"
         : filePathOrOptions;
-    const mergedOptions = {
+    const mergedOptions = withConfigCache({
       ...eslintConstructorOptions(this.options),
       ...textOptions
-    };
+    });
     const report = lintText(code, {
       ...mergedOptions,
       filePath
@@ -670,7 +670,7 @@ class CLIEngine {
   }
 
   getConfigForFile(filePath) {
-    return publicCalculatedConfig(eslintConstructorOptions(this.options), filePath);
+    return publicCalculatedConfig(withConfigCache(eslintConstructorOptions(this.options)), filePath);
   }
 }
 
@@ -812,12 +812,12 @@ function runCli(args = [], options = {}) {
     return run(parsed.passthroughArgs, options);
   }
 
-  const cliOptions = {
+  const cliOptions = withConfigCache({
     ...options,
     ...parsed.options,
     extraArgs: parsed.passthroughArgs,
     preserveNativeDefaults: Boolean(parsed.options.noConfig)
-  };
+  });
   const targets = parsed.targets.length > 0 ? parsed.targets : defaultLintTargets(cliOptions);
   const report = lintFiles(targets, cliOptions);
   report.diagnostics = normalizeReportDiagnostics(report.diagnostics, cliOptions);
@@ -1063,6 +1063,7 @@ function booleanFlagValue(arg) {
 }
 
 function lintFiles(paths, options = {}) {
+  options = withConfigCache(options);
   const targets = lintTargetsForInput(paths, options);
   const ignoredDiagnostics = ignoredLintPathDiagnostics(targets, options);
   const lintPaths = filteredLintPaths(targets, options);
@@ -1241,6 +1242,7 @@ function mergeNativeReports(reports) {
 }
 
 function lintText(code, options = {}) {
+  options = withConfigCache(options);
   if (typeof code !== "string") {
     throw new TypeError("code must be a string");
   }
@@ -1307,7 +1309,7 @@ function buildNativeLintArgs(paths, options) {
   if (!options.rules && !options.forceMaterializedConfig && (options.config || options.baseConfig || options.overrideConfig)) {
     const configForRuleSelection = options.noConfig
       ? undefined
-      : options.config ? readConfig(options.config, options.cwd) : undefined;
+      : options.config ? readConfig(options.config, options.cwd, options.configCache) : undefined;
     const enabledRules = enabledRuleNamesFromConfigs(
       configForRuleSelection,
       options.baseConfig,
@@ -1353,6 +1355,12 @@ function mergeLintOptions(base, override) {
   };
 }
 
+function withConfigCache(options) {
+  // Executable configs are otherwise re-evaluated at every per-file lookup.
+  // Keep the cache on the options object so one public invocation shares it.
+  return options.configCache ? options : { ...options, configCache: new Map() };
+}
+
 function eslintConstructorOptions(options) {
   const mapped = {
     cwd: options.cwd,
@@ -1525,7 +1533,7 @@ function rulesFromFileConfig(options, filePath) {
     return {};
   }
 
-  const config = readConfig(configPath, options.cwd);
+  const config = readConfig(configPath, options.cwd, options.configCache);
   return rulesFromConfig(config, filePath, dirname(configPath));
 }
 
@@ -1539,7 +1547,7 @@ function configDataFromFileConfig(options, filePath) {
     return {};
   }
 
-  const config = readConfig(configPath, options.cwd);
+  const config = readConfig(configPath, options.cwd, options.configCache);
   return configDataFromConfig(config, filePath, dirname(configPath));
 }
 
@@ -1560,7 +1568,7 @@ function defaultLintTargets(options = {}) {
     return ["."];
   }
 
-  const targets = filePatternsFromConfig(readConfig(configPath, options.cwd));
+  const targets = filePatternsFromConfig(readConfig(configPath, options.cwd, options.configCache));
   return targets.length > 0
     ? targets.map((target) => resolveConfigPattern(target, dirname(configPath)))
     : ["."];
@@ -1652,7 +1660,9 @@ function configPathFromDirectory(directory) {
 function withTemporaryConfig(options, callback) {
   const fileConfigPath = !options.noConfig ? configPathForOptions(options) : undefined;
   const shouldMaterializeFileConfig = Boolean(fileConfigPath);
-  const fileConfig = shouldMaterializeFileConfig ? readConfig(fileConfigPath, options.cwd) : undefined;
+  const fileConfig = shouldMaterializeFileConfig
+    ? readConfig(fileConfigPath, options.cwd, options.configCache)
+    : undefined;
   const configs = [options.baseConfig, fileConfig, options.overrideConfig];
   const rules = shouldMaterializeFileConfig
     ? materializedRulesFromConfigs(...configs)
@@ -4012,7 +4022,7 @@ function ignorePatternsFromFileConfig(options, filePath) {
   }
 
   const cwd = options.cwd ?? process.cwd();
-  return ignorePatternsFromConfig(readConfig(configPath, options.cwd)).map((pattern) =>
+  return ignorePatternsFromConfig(readConfig(configPath, options.cwd, options.configCache)).map((pattern) =>
     rebaseConfigPattern(pattern, dirname(configPath), cwd)
   );
 }

package/index.js

@@ -487,7 +487,7 @@ export class UtooLint {
   }
 
   async lintFiles(patterns, options = {}) {
-    const mergedOptions = mergeLintOptions(this.options, options);
+    const mergedOptions = withConfigCache(mergeLintOptions(this.options, options));
     const customRuleConfig = [mergedOptions.baseConfig, mergedOptions.overrideConfig].filter(Boolean);
     const customRuleFilterMap = customRuleMapForConfig(customRuleConfig, new Map());
     const nativeOptions = lintOptionsWithoutCustomRules(mergedOptions, customRuleFilterMap);
@@ -507,7 +507,7 @@ export class UtooLint {
       throw new TypeError("code must be a string");
     }
 
-    const mergedOptions = mergeLintOptions(this.options, options);
+    const mergedOptions = withConfigCache(mergeLintOptions(this.options, options));
     const filePath = normalizeESLintFilePath(textFilePathForOptions(options, "<text>"), mergedOptions.cwd);
     const customRuleConfig = [mergedOptions.baseConfig, mergedOptions.overrideConfig].filter(Boolean);
     const customRuleMap = customRuleMapForConfig(customRuleConfig, new Map(), filePath, mergedOptions.cwd);
@@ -531,7 +531,7 @@ export class UtooLint {
   }
 
   async calculateConfigForFile(filePath) {
-    return publicCalculatedConfig(eslintConstructorOptions(this.options), filePath);
+    return publicCalculatedConfig(withConfigCache(eslintConstructorOptions(this.options)), filePath);
   }
 
   async findConfigFile(filePath) {
@@ -2446,7 +2446,7 @@ export class CLIEngine {
   }
 
   executeOnFiles(patterns) {
-    const mergedOptions = eslintConstructorOptions(this.options);
+    const mergedOptions = withConfigCache(eslintConstructorOptions(this.options));
     const report = lintFiles(patterns, mergedOptions);
     throwOnUnmatchedPatternDiagnostics(report, mergedOptions);
     const results = maybeFilterQuietResults(reportToESLintResults(report, {
@@ -2466,10 +2466,10 @@ export class CLIEngine {
       typeof filePathOrOptions === "object" && filePathOrOptions !== null
         ? filePathOrOptions.filePath ?? filePathOrOptions.filename ?? "input.js"
         : filePathOrOptions;
-    const mergedOptions = {
+    const mergedOptions = withConfigCache({
       ...eslintConstructorOptions(this.options),
       ...textOptions
-    };
+    });
     const report = lintText(code, {
       ...mergedOptions,
       filePath
@@ -2506,7 +2506,7 @@ export class CLIEngine {
   }
 
   getConfigForFile(filePath) {
-    return publicCalculatedConfig(eslintConstructorOptions(this.options), filePath);
+    return publicCalculatedConfig(withConfigCache(eslintConstructorOptions(this.options)), filePath);
   }
 }
 
@@ -2648,12 +2648,12 @@ export function runCli(args = [], options = {}) {
     return run(parsed.passthroughArgs, options);
   }
 
-  const cliOptions = {
+  const cliOptions = withConfigCache({
     ...options,
     ...parsed.options,
     extraArgs: parsed.passthroughArgs,
     preserveNativeDefaults: Boolean(parsed.options.noConfig)
-  };
+  });
   const targets = parsed.targets.length > 0 ? parsed.targets : defaultLintTargets(cliOptions);
   const report = lintFiles(targets, cliOptions);
   report.diagnostics = normalizeReportDiagnostics(report.diagnostics, cliOptions);
@@ -2899,6 +2899,7 @@ function booleanFlagValue(arg) {
 }
 
 export function lintFiles(paths, options = {}) {
+  options = withConfigCache(options);
   const targets = lintTargetsForInput(paths, options);
   const ignoredDiagnostics = ignoredLintPathDiagnostics(targets, options);
   const lintPaths = filteredLintPaths(targets, options);
@@ -3077,6 +3078,7 @@ function mergeNativeReports(reports) {
 }
 
 export function lintText(code, options = {}) {
+  options = withConfigCache(options);
   if (typeof code !== "string") {
     throw new TypeError("code must be a string");
   }
@@ -3143,7 +3145,7 @@ function buildNativeLintArgs(paths, options) {
   if (!options.rules && !options.forceMaterializedConfig && (options.config || options.baseConfig || options.overrideConfig)) {
     const configForRuleSelection = options.noConfig
       ? undefined
-      : options.config ? readConfig(options.config, options.cwd) : undefined;
+      : options.config ? readConfig(options.config, options.cwd, options.configCache) : undefined;
     const enabledRules = enabledRuleNamesFromConfigs(
       configForRuleSelection,
       options.baseConfig,
@@ -3189,6 +3191,12 @@ function mergeLintOptions(base, override) {
   };
 }
 
+function withConfigCache(options) {
+  // Executable configs are otherwise re-evaluated at every per-file lookup.
+  // Keep the cache on the options object so one public invocation shares it.
+  return options.configCache ? options : { ...options, configCache: new Map() };
+}
+
 function eslintConstructorOptions(options) {
   const mapped = {
     cwd: options.cwd,
@@ -3361,7 +3369,7 @@ function rulesFromFileConfig(options, filePath) {
     return {};
   }
 
-  const config = readConfig(configPath, options.cwd);
+  const config = readConfig(configPath, options.cwd, options.configCache);
   return rulesFromConfig(config, filePath, dirname(configPath));
 }
 
@@ -3375,7 +3383,7 @@ function configDataFromFileConfig(options, filePath) {
     return {};
   }
 
-  const config = readConfig(configPath, options.cwd);
+  const config = readConfig(configPath, options.cwd, options.configCache);
   return configDataFromConfig(config, filePath, dirname(configPath));
 }
 
@@ -3396,7 +3404,7 @@ function defaultLintTargets(options = {}) {
     return ["."];
   }
 
-  const targets = filePatternsFromConfig(readConfig(configPath, options.cwd));
+  const targets = filePatternsFromConfig(readConfig(configPath, options.cwd, options.configCache));
   return targets.length > 0
     ? targets.map((target) => resolveConfigPattern(target, dirname(configPath)))
     : ["."];
@@ -3488,7 +3496,9 @@ function configPathFromDirectory(directory) {
 function withTemporaryConfig(options, callback) {
   const fileConfigPath = !options.noConfig ? configPathForOptions(options) : undefined;
   const shouldMaterializeFileConfig = Boolean(fileConfigPath);
-  const fileConfig = shouldMaterializeFileConfig ? readConfig(fileConfigPath, options.cwd) : undefined;
+  const fileConfig = shouldMaterializeFileConfig
+    ? readConfig(fileConfigPath, options.cwd, options.configCache)
+    : undefined;
   const configs = [options.baseConfig, fileConfig, options.overrideConfig];
   const rules = shouldMaterializeFileConfig
     ? materializedRulesFromConfigs(...configs)
@@ -4015,7 +4025,7 @@ function ignorePatternsFromFileConfig(options, filePath) {
   }
 
   const cwd = options.cwd ?? process.cwd();
-  return ignorePatternsFromConfig(readConfig(configPath, options.cwd)).map((pattern) =>
+  return ignorePatternsFromConfig(readConfig(configPath, options.cwd, options.configCache)).map((pattern) =>
     rebaseConfigPattern(pattern, dirname(configPath), cwd)
   );
 }

package/lib/config-loader.cjs

@@ -38,17 +38,25 @@ function isFile(path) {
   }
 }
 
-function readConfig(path, cwd) {
+function readConfig(path, cwd, cache) {
   const configPath = resolvePath(cwd ?? process.cwd(), path);
-  if (isExecutableConfigPath(configPath)) {
-    return readExecutableConfig(configPath, cwd);
+  if (cache?.has(configPath)) {
+    return cache.get(configPath);
   }
 
-  try {
-    return JSON.parse(readFileSync(configPath, "utf8"));
-  } catch (error) {
-    throw configReadError(configPath, error.message);
+  let config;
+  if (isExecutableConfigPath(configPath)) {
+    config = readExecutableConfig(configPath, cwd);
+  } else {
+    try {
+      config = JSON.parse(readFileSync(configPath, "utf8"));
+    } catch (error) {
+      throw configReadError(configPath, error.message);
+    }
   }
+
+  cache?.set(configPath, config);
+  return config;
 }
 
 function isExecutableConfigPath(path) {

package/lib/config-loader.js

@@ -39,17 +39,25 @@ function isFile(path) {
   }
 }
 
-export function readConfig(path, cwd) {
+export function readConfig(path, cwd, cache) {
   const configPath = resolvePath(cwd ?? process.cwd(), path);
-  if (isExecutableConfigPath(configPath)) {
-    return readExecutableConfig(configPath, cwd);
+  if (cache?.has(configPath)) {
+    return cache.get(configPath);
   }
 
-  try {
-    return JSON.parse(readFileSync(configPath, "utf8"));
-  } catch (error) {
-    throw configReadError(configPath, error.message);
+  let config;
+  if (isExecutableConfigPath(configPath)) {
+    config = readExecutableConfig(configPath, cwd);
+  } else {
+    try {
+      config = JSON.parse(readFileSync(configPath, "utf8"));
+    } catch (error) {
+      throw configReadError(configPath, error.message);
+    }
   }
+
+  cache?.set(configPath, config);
+  return config;
 }
 
 export function isExecutableConfigPath(path) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@utoo/lint",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Experimental JavaScript and TypeScript linter powered by Yuku",
   "license": "MIT",
   "repository": {
@@ -73,11 +73,11 @@
     "use-at-your-own-risk.js"
   ],
   "optionalDependencies": {
-    "@utoo/lint-darwin-arm64": "0.2.2",
-    "@utoo/lint-darwin-x64": "0.2.2",
-    "@utoo/lint-linux-arm64": "0.2.2",
-    "@utoo/lint-linux-x64": "0.2.2",
-    "@utoo/lint-win32-x64": "0.2.2"
+    "@utoo/lint-darwin-arm64": "0.2.3",
+    "@utoo/lint-darwin-x64": "0.2.3",
+    "@utoo/lint-linux-arm64": "0.2.3",
+    "@utoo/lint-linux-x64": "0.2.3",
+    "@utoo/lint-win32-x64": "0.2.3"
   },
   "dependencies": {
     "jiti": "2.7.0"