fix: Ensure config keys are printed for config errors (#18067)

snitin315 · nzakas · web-flow · commit 69dd1d1387b7 · 2024-02-01T13:58:54.000+01:00
* fix: Ensure config keys are printed for config errors

* Remove unnecessary test

Co-authored-by: Nicholas C. Zakas &lt;nicholas@humanwhocodes.com&gt;
diff --git a/package.json b/package.json
@@ -66,7 +66,7 @@
     "@eslint-community/regexpp": "^4.6.1",
     "@eslint/eslintrc": "^2.1.4",
     "@eslint/js": "8.56.0",
-    "@humanwhocodes/config-array": "^0.11.13",
+    "@humanwhocodes/config-array": "^0.11.14",
     "@humanwhocodes/module-importer": "^1.0.1",
     "@nodelib/fs.walk": "^1.2.8",
     "@ungap/structured-clone": "^1.2.0",
diff --git a/tests/bin/eslint.js b/tests/bin/eslint.js
@@ -440,6 +440,21 @@ describe("bin/eslint.js", () => {
             });
         });
 
+        // https://github.com/eslint/eslint/issues/17960
+        it("should include key information in the error message when there is an invalid config", () => {
+
+            // The error message should include the key name
+            const config = path.join(__dirname, "../fixtures/bin/eslint.config-invalid-key.js");
+            const child = runESLint(["--config", config, "conf", "tools"]);
+            const exitCodeAssertion = assertExitCode(child, 2);
+            const outputAssertion = getOutput(child).then(output => {
+                assert.include(output.stderr, "Key \"linterOptions\": Key \"reportUnusedDisableDirectives\"");
+            });
+
+            return Promise.all([exitCodeAssertion, outputAssertion]);
+
+        });
+
         it("prints the error message pointing to line of code", () => {
             const invalidConfig = path.join(__dirname, "../fixtures/bin/eslint.config.js");
             const child = runESLint(["--no-ignore", "-c", invalidConfig]);
diff --git a/tests/fixtures/bin/eslint.config-invalid-key.js b/tests/fixtures/bin/eslint.config-invalid-key.js
@@ -0,0 +1,5 @@
+module.exports = [{
+    linterOptions: {
+        reportUnusedDisableDirectives: "banana"
+    }
+}];
diff --git a/tests/lib/config/flat-config-array.js b/tests/lib/config/flat-config-array.js
@@ -1039,7 +1039,7 @@ describe("FlatConfigArray", () => {
                                 reportUnusedDisableDirectives: {}
                             }
                         }
-                    ], /Expected one of: "error", "warn", "off", 0, 1, 2, or a boolean./u);
+                    ], /Key "linterOptions": Key "reportUnusedDisableDirectives": Expected one of: "error", "warn", "off", 0, 1, 2, or a boolean./u);
                 });
 
                 it("should merge two objects when second object has overrides", () => assertMergedResult([
@@ -2054,4 +2054,5 @@ describe("FlatConfigArray", () => {
         });
 
     });
+
 });

Original file line number	Diff line number	Diff line change
`@@ -1039,7 +1039,7 @@ describe("FlatConfigArray", () => {`
`1039`	`1039`	`reportUnusedDisableDirectives: {}`
`1040`	`1040`	`}`
`1041`	`1041`	`}`
`1042`		`- ], /Expected one of: "error", "warn", "off", 0, 1, 2, or a boolean./u);`
	`1042`	`+ ], /Key "linterOptions": Key "reportUnusedDisableDirectives": Expected one of: "error", "warn", "off", 0, 1, 2, or a boolean./u);`
`1043`	`1043`	`});`
`1044`	`1044`
`1045`	`1045`	`it("should merge two objects when second object has overrides", () => assertMergedResult([`
`@@ -2054,4 +2054,5 @@ describe("FlatConfigArray", () => {`
`2054`	`2054`	`});`
`2055`	`2055`
`2056`	`2056`	`});`
	`2057`	`+`
`2057`	`2058`	`});`