chore: make no-config-imports rule tied to config itself

Author: himanshusinghs

eslint-rules/no-config-imports.js

@@ -1,6 +1,17 @@
 "use strict";
 import path from "path";
 
+// The file from which we wish to discourage importing values
+const configFilePath = path.resolve(import.meta.dirname, "../src/common/config.js");
+
+// Files that are allowed to import value exports from config.ts
+const allowedConfigValueImportFiles = [
+    // Main entry point that injects the config
+    "src/index.ts",
+    // Config resource definition that works with the some config values
+    "src/resources/common/config.ts",
+];
+
 // Ref: https://eslint.org/docs/latest/extend/custom-rules
 export default {
     meta: {
@@ -11,41 +22,15 @@ export default {
             recommended: true,
         },
         fixable: null,
-        schema: [
-            {
-                type: "object",
-                properties: {
-                    configFilePath: {
-                        type: "string",
-                        description: "Path to the config file to restrict.",
-                    },
-                    allowedFiles: {
-                        type: "array",
-                        items: { type: "string" },
-                        description: "List of file paths that are allowed to import value exports from config.ts.",
-                    },
-                },
-                required: ["configFilePath"],
-            },
-        ],
         messages: {
             noConfigImports:
                 "Value imports from config.ts are not allowed. Use dependency injection instead. Only type imports are permitted.",
         },
     },
     create(context) {
-        const options = context.options[0];
-        if (!options) {
-            throw new Error(
-                "no-config-imports should be configured with an object with at-least 'configFilePath' key."
-            );
-        }
-        const configFilePath = path.resolve(options.configFilePath);
-        const allowedFiles = options.allowedFiles || [];
-
         const currentFilePath = path.resolve(context.getFilename());
 
-        const isCurrentFileAllowedToImport = allowedFiles.some((allowedFile) => {
+        const isCurrentFileAllowedToImport = allowedConfigValueImportFiles.some((allowedFile) => {
             const resolvedAllowedFile = path.resolve(allowedFile);
             return currentFilePath === resolvedAllowedFile;
         });

eslint-rules/no-config-imports.test.js

@@ -6,8 +6,6 @@ import rule from "./no-config-imports.js";
 
 const ROOT = process.cwd();
 const resolve = (p) => path.resolve(ROOT, p);
-const CONFIG_FILE_PATH = resolve("src/common/config.js");
-const ALLOWED_CONFIG_VALUE_IMPORT_FILES = [resolve("src/index.ts"), resolve("src/resources/common/config.ts")];
 
 const ruleTester = new RuleTester({
     languageOptions: {
@@ -23,22 +21,18 @@ describe("no-config-imports", () => {
                 {
                     filename: resolve("src/some/module.ts"),
                     code: 'import type { UserConfig } from "../common/config.js";\n',
-                    options: [{ configFilePath: CONFIG_FILE_PATH, allowedFiles: ALLOWED_CONFIG_VALUE_IMPORT_FILES }],
                 },
                 {
                     filename: resolve("src/some/module.ts"),
                     code: 'import { something } from "../common/logger.js";\n',
-                    options: [{ configFilePath: CONFIG_FILE_PATH, allowedFiles: ALLOWED_CONFIG_VALUE_IMPORT_FILES }],
                 },
                 {
                     filename: resolve("src/some/module.ts"),
                     code: 'import type * as Cfg from "../common/config.js";\n',
-                    options: [{ configFilePath: CONFIG_FILE_PATH, allowedFiles: ALLOWED_CONFIG_VALUE_IMPORT_FILES }],
                 },
                 {
-                    filename: ALLOWED_CONFIG_VALUE_IMPORT_FILES[1],
+                    filename: resolve("src/index.ts"),
                     code: 'import { driverOptions } from "../common/config.js";\n',
-                    options: [{ configFilePath: CONFIG_FILE_PATH, allowedFiles: ALLOWED_CONFIG_VALUE_IMPORT_FILES }],
                 },
             ],
             invalid: [],
@@ -52,25 +46,21 @@ describe("no-config-imports", () => {
                 {
                     filename: resolve("src/another/module.ts"),
                     code: 'import { driverOptions } from "../common/config.js";\n',
-                    options: [{ configFilePath: CONFIG_FILE_PATH, allowedFiles: ALLOWED_CONFIG_VALUE_IMPORT_FILES }],
                     errors: [{ messageId: "noConfigImports" }],
                 },
                 {
                     filename: resolve("src/another/module.ts"),
                     code: 'import configDefault from "../common/config.js";\n',
-                    options: [{ configFilePath: CONFIG_FILE_PATH, allowedFiles: ALLOWED_CONFIG_VALUE_IMPORT_FILES }],
                     errors: [{ messageId: "noConfigImports" }],
                 },
                 {
                     filename: resolve("src/another/module.ts"),
                     code: 'import * as cfg from "../common/config.js";\n',
-                    options: [{ configFilePath: CONFIG_FILE_PATH, allowedFiles: ALLOWED_CONFIG_VALUE_IMPORT_FILES }],
                     errors: [{ messageId: "noConfigImports" }],
                 },
                 {
                     filename: resolve("src/another/module.ts"),
                     code: 'import { type UserConfig, driverOptions } from "../common/config.js";\n',
-                    options: [{ configFilePath: CONFIG_FILE_PATH, allowedFiles: ALLOWED_CONFIG_VALUE_IMPORT_FILES }],
                     errors: [{ messageId: "noConfigImports" }],
                 },
             ],

eslint.config.js

@@ -11,16 +11,6 @@ const testFiles = ["tests/**/*.test.ts", "tests/**/*.ts"];
 
 const files = [...testFiles, "src/**/*.ts", "scripts/**/*.ts"];
 
-// Files that are allowed to import value exports from config.ts
-const allowedConfigValueImportFiles = [
-    // Main entry point that injects the config
-    "src/index.ts",
-    // Config resource definition that works with the some config values
-    "src/resources/common/config.ts",
-];
-
-const configFilePath = path.resolve(import.meta.dirname, "src/common/config.js");
-
 export default defineConfig([
     { files, plugins: { js }, extends: ["js/recommended"] },
     { files, languageOptions: { globals: globals.node } },
@@ -84,13 +74,7 @@ export default defineConfig([
             },
         },
         rules: {
-            "no-config-imports/no-config-imports": [
-                "error",
-                {
-                    configFilePath,
-                    allowedFiles: allowedConfigValueImportFiles,
-                },
-            ],
+            "no-config-imports/no-config-imports": "error",
         },
     },
     globalIgnores([