fix: improve error message for invalid rule config (#18147)

* fix: improve error message for invalid rule config * refactor: update indentation & use more strict checks
eslint · Mar 1, 2024 · e37153f · e37153f
1 parent c49ed63
commit e37153f
Show file tree

Hide file tree

Showing 2 changed files with 125 additions and 2 deletions.
diff --git a/lib/config/rule-validator.js b/lib/config/rule-validator.js
@@ -167,9 +167,22 @@ class RuleValidator {
  validateRule(ruleOptions.slice(1));
 
  if (validateRule.errors) {
- throw new Error(`Key "rules": Key "${ruleId}": ${
+ throw new Error(`Key "rules": Key "${ruleId}":\n${
  validateRule.errors.map(
- error => `\tValue ${JSON.stringify(error.data)} ${error.message}.\n`
+ error => {
+ if (
+ error.keyword === "additionalProperties" &&
+ error.schema === false &&
+ typeof error.parentSchema?.properties === "object" &&
+ typeof error.params?.additionalProperty === "string"
+ ) {
+ const expectedProperties = Object.keys(error.parentSchema.properties).map(property => `"${property}"`);
+
+ return `\tValue ${JSON.stringify(error.data)} ${error.message}.\n\t\tUnexpected property "${error.params.additionalProperty}". Expected properties: ${expectedProperties.join(", ")}.\n`;
+ }
+
+ return `\tValue ${JSON.stringify(error.data)} ${error.message}.\n`;
+ }
  ).join("")
  }`);
  }

diff --git a/tests/lib/config/flat-config-array.js b/tests/lib/config/flat-config-array.js
@@ -44,6 +44,81 @@ const baseConfig = {
  baz: {
 
  },
+ "prefer-const": {
+ meta: {
+ schema: [
+ {
+ type: "object",
+ properties: {
+ destructuring: { enum: ["any", "all"], default: "any" },
+ ignoreReadBeforeAssign: { type: "boolean", default: false }
+ },
+ additionalProperties: false
+ }
+ ]
+ }
+ },
+ "prefer-destructuring": {
+ meta: {
+ schema: [
+ {
+ oneOf: [
+ {
+ type: "object",
+ properties: {
+ VariableDeclarator: {
+ type: "object",
+ properties: {
+ array: {
+ type: "boolean"
+ },
+ object: {
+ type: "boolean"
+ }
+ },
+ additionalProperties: false
+ },
+ AssignmentExpression: {
+ type: "object",
+ properties: {
+ array: {
+ type: "boolean"
+ },
+ object: {
+ type: "boolean"
+ }
+ },
+ additionalProperties: false
+ }
+ },
+ additionalProperties: false
+ },
+ {
+ type: "object",
+ properties: {
+ array: {
+ type: "boolean"
+ },
+ object: {
+ type: "boolean"
+ }
+ },
+ additionalProperties: false
+ }
+ ]
+ },
+ {
+ type: "object",
+ properties: {
+ enforceForRenamedProperties: {
+ type: "boolean"
+ }
+ },
+ additionalProperties: false
+ }
+ ]
+ }
+ },
 
  // old-style
  boom() {},
@@ -2157,6 +2232,41 @@ describe("FlatConfigArray", () => {
  }
  }));
 
+ it("should error show expected properties", async () => {
+
+ await assertInvalidConfig([
+ {
+ rules: {
+ "prefer-const": ["error", { destruct: true }]
+ }
+ }
+ ], "Unexpected property \"destruct\". Expected properties: \"destructuring\", \"ignoreReadBeforeAssign\"");
+
+ await assertInvalidConfig([
+ {
+ rules: {
+ "prefer-destructuring": ["error", { obj: true }]
+ }
+ }
+ ], "Unexpected property \"obj\". Expected properties: \"VariableDeclarator\", \"AssignmentExpression\"");
+
+ await assertInvalidConfig([
+ {
+ rules: {
+ "prefer-destructuring": ["error", { obj: true }]
+ }
+ }
+ ], "Unexpected property \"obj\". Expected properties: \"array\", \"object\"");
+
+ await assertInvalidConfig([
+ {
+ rules: {
+ "prefer-destructuring": ["error", { object: true }, { enforceRenamedProperties: true }]
+ }
+ }
+ ], "Unexpected property \"enforceRenamedProperties\". Expected properties: \"enforceForRenamedProperties\"");
+ });
+
  });
 
  describe("Invalid Keys", () => {