fix: Avoid dirname for built-in configs.

Load eslint:recommended and eslint:all configs via import instead file paths. Fixes: eslint/eslint#15575
daidodo · Feb 13, 2022 · a1181ef · a1181ef
1 parent 8761efb
commit a1181ef
Show file tree

Hide file tree

Showing 7 changed files with 186 additions and 171 deletions.
diff --git a/lib/cascading-config-array-factory.js b/lib/cascading-config-array-factory.js
@@ -22,13 +22,18 @@
 // Requirements
 //------------------------------------------------------------------------------
 
+import debugOrig from "debug";
 import os from "os";
 import path from "path";
+
+import { ConfigArrayFactory } from "./config-array-factory.js";
+import {
+    ConfigArray,
+    ConfigDependency,
+    IgnorePattern
+} from "./config-array/index.js";
 import ConfigValidator from "./shared/config-validator.js";
 import { emitDeprecationWarning } from "./shared/deprecation-warnings.js";
-import { ConfigArrayFactory } from "./config-array-factory.js";
-import { ConfigArray, ConfigDependency, IgnorePattern } from "./config-array/index.js";
-import debugOrig from "debug";
 
 const debug = debugOrig("eslintrc:cascading-config-array-factory");
 
@@ -56,8 +61,8 @@ const debug = debugOrig("eslintrc:cascading-config-array-factory");
  * @property {Function} loadRules The function to use to load rules.
  * @property {Map<string,Rule>} builtInRules The rules that are built in to ESLint.
  * @property {Object} [resolver=ModuleResolver] The module resolver object.
- * @property {string} eslintAllPath The path to the definitions for eslint:all.
- * @property {string} eslintRecommendedPath The path to the definitions for eslint:recommended.
+ * @property {ConfigData} eslintAllConfig The config data to the definitions for eslint:all.
+ * @property {ConfigData} eslintRecommendedConfig The config data to the definitions for eslint:recommended.
  */
 
 /**
@@ -77,8 +82,8 @@ const debug = debugOrig("eslintrc:cascading-config-array-factory");
  * @property {Function} loadRules The function to use to load rules.
  * @property {Map<string,Rule>} builtInRules The rules that are built in to ESLint.
  * @property {Object} [resolver=ModuleResolver] The module resolver object.
- * @property {string} eslintAllPath The path to the definitions for eslint:all.
- * @property {string} eslintRecommendedPath The path to the definitions for eslint:recommended.
+ * @property {ConfigData} eslintAllConfig The config data to the definitions for eslint:all.
+ * @property {ConfigData} eslintRecommendedConfig The config data to the definitions for eslint:recommended.
  */
 
 /** @type {WeakMap<CascadingConfigArrayFactory, CascadingConfigArrayFactoryInternalSlots>} */
@@ -218,17 +223,17 @@ class CascadingConfigArrayFactory {
         builtInRules = new Map(),
         loadRules,
         resolver,
-        eslintRecommendedPath,
-        eslintAllPath
+        eslintRecommendedConfig,
+        eslintAllConfig
     } = {}) {
         const configArrayFactory = new ConfigArrayFactory({
             additionalPluginPool,
             cwd,
             resolvePluginsRelativeTo,
             builtInRules,
             resolver,
-            eslintRecommendedPath,
-            eslintAllPath
+            eslintRecommendedConfig,
+            eslintAllConfig
         });
 
         internalSlotsMap.set(this, {
@@ -516,5 +521,4 @@ class CascadingConfigArrayFactory {
 //------------------------------------------------------------------------------
 // Public Interface
 //------------------------------------------------------------------------------
-
 export { CascadingConfigArrayFactory };
diff --git a/lib/config-array-factory.js b/lib/config-array-factory.js
@@ -38,22 +38,23 @@
 // Requirements
 //------------------------------------------------------------------------------
 
+import debugOrig from "debug";
 import fs from "fs";
-import path from "path";
 import importFresh from "import-fresh";
+import { createRequire } from "module";
+import path from "path";
 import stripComments from "strip-json-comments";
-import ConfigValidator from "./shared/config-validator.js";
-import * as naming from "./shared/naming.js";
-import * as ModuleResolver from "./shared/relative-module-resolver.js";
+
 import {
     ConfigArray,
     ConfigDependency,
     IgnorePattern,
     OverrideTester
 } from "./config-array/index.js";
-import debugOrig from "debug";
+import ConfigValidator from "./shared/config-validator.js";
+import * as naming from "./shared/naming.js";
+import * as ModuleResolver from "./shared/relative-module-resolver.js";
 
-import { createRequire } from "module";
 const require = createRequire(import.meta.url);
 
 const debug = debugOrig("eslintrc:config-array-factory");
@@ -89,8 +90,8 @@ const configFilenames = [
  * @property {string} [resolvePluginsRelativeTo] A path to the directory that plugins should be resolved from. Defaults to `cwd`.
  * @property {Map<string,Rule>} builtInRules The rules that are built in to ESLint.
  * @property {Object} [resolver=ModuleResolver] The module resolver object.
- * @property {string} eslintAllPath The path to the definitions for eslint:all.
- * @property {string} eslintRecommendedPath The path to the definitions for eslint:recommended.
+ * @property {import("./shared/types").ConfigData} eslintAllConfig The config data to the definitions for eslint:all.
+ * @property {import("./shared/types").ConfigData} eslintRecommendedConfig The config data to the definitions for eslint:recommended.
  */
 
 /**
@@ -100,8 +101,8 @@ const configFilenames = [
  * @property {string | undefined} resolvePluginsRelativeTo An absolute path the the directory that plugins should be resolved from.
  * @property {Map<string,Rule>} builtInRules The rules that are built in to ESLint.
  * @property {Object} [resolver=ModuleResolver] The module resolver object.
- * @property {string} eslintAllPath The path to the definitions for eslint:all.
- * @property {string} eslintRecommendedPath The path to the definitions for eslint:recommended.
+ * @property {import("./shared/types").ConfigData} eslintAllConfig The config data to the definitions for eslint:all.
+ * @property {import("./shared/types").ConfigData} eslintRecommendedConfig The config data to the definitions for eslint:recommended.
  */
 
 /**
@@ -427,8 +428,8 @@ class ConfigArrayFactory {
         resolvePluginsRelativeTo,
         builtInRules,
         resolver = ModuleResolver,
-        eslintAllPath,
-        eslintRecommendedPath
+        eslintAllConfig,
+        eslintRecommendedConfig
     } = {}) {
         internalSlotsMap.set(this, {
             additionalPluginPool,
@@ -438,8 +439,8 @@ class ConfigArrayFactory {
                 path.resolve(cwd, resolvePluginsRelativeTo),
             builtInRules,
             resolver,
-            eslintAllPath,
-            eslintRecommendedPath
+            eslintAllConfig,
+            eslintRecommendedConfig
         });
     }
 
@@ -797,19 +798,17 @@ class ConfigArrayFactory {
      * @private
      */
     _loadExtendedBuiltInConfig(extendName, ctx) {
-        const { eslintAllPath, eslintRecommendedPath } = internalSlotsMap.get(this);
+        const { eslintAllConfig, eslintRecommendedConfig } = internalSlotsMap.get(this);
 
         if (extendName === "eslint:recommended") {
-            return this._loadConfigData({
+            return this._normalizeConfigData(eslintRecommendedConfig, {
                 ...ctx,
-                filePath: eslintRecommendedPath,
                 name: `${ctx.name} » ${extendName}`
             });
         }
         if (extendName === "eslint:all") {
-            return this._loadConfigData({
+            return this._normalizeConfigData(eslintAllConfig, {
                 ...ctx,
-                filePath: eslintAllPath,
                 name: `${ctx.name} » ${extendName}`
             });
         }

diff --git a/lib/flat-compat.js b/lib/flat-compat.js
@@ -7,14 +7,13 @@
 // Requirements
 //-----------------------------------------------------------------------------
 
-import path from "path";
-import { fileURLToPath } from "url";
 import createDebug from "debug";
+import path from "path";
 
-import { ConfigArrayFactory } from "./config-array-factory.js";
 import environments from "../conf/environments.js";
-
-const dirname = path.dirname(fileURLToPath(import.meta.url));
+import eslintAllConfig from "../conf/eslint-all.cjs";
+import eslintRecommendedConfig from "../conf/eslint-recommended.cjs";
+import { ConfigArrayFactory } from "./config-array-factory.js";
 
 //-----------------------------------------------------------------------------
 // Helpers
@@ -225,8 +224,8 @@ class FlatCompat {
         this[cafactory] = new ConfigArrayFactory({
             cwd: baseDirectory,
             resolvePluginsRelativeTo,
-            eslintAllPath: path.resolve(dirname, "../conf/eslint-all.cjs"),
-            eslintRecommendedPath: path.resolve(dirname, "../conf/eslint-recommended.cjs")
+            eslintAllConfig,
+            eslintRecommendedConfig
         });
     }
 

diff --git a/package.json b/package.json
@@ -50,6 +50,7 @@
   },
   "homepage": "https://github.com/eslint/eslintrc#readme",
   "devDependencies": {
+    "@rollup/plugin-commonjs": "^21.0.1",
     "c8": "^7.7.3",
     "chai": "^4.3.4",
     "eslint": "^7.31.0",

diff --git a/rollup.config.js b/rollup.config.js
@@ -1,3 +1,5 @@
+import commonjs from "@rollup/plugin-commonjs";
+
 export default [
     {
         input: "./lib/index.js",
@@ -12,7 +14,8 @@ export default [
             file: "dist/eslintrc.cjs",
             sourcemap: true,
             freeze: false
-        }
+        },
+        plugins: [commonjs()]
     },
     {
         input: "./lib/index-universal.js",
@@ -27,6 +30,7 @@ export default [
             file: "dist/eslintrc-universal.cjs",
             sourcemap: true,
             freeze: false
-        }
+        },
+        plugins: [commonjs()]
     }
 ];