chore: better error message for missing plugin in config (#19402)

Tanujkanti4441 · web-flow · commit dab5478e8628 · 2025-02-19T12:53:12.000-05:00
* chore: better error message for missing plugin

* update error message in test

* refactor code for error message

* update error message variable name
diff --git a/lib/config/rule-validator.js b/lib/config/rule-validator.js
@@ -36,7 +36,10 @@ function throwRuleNotFoundError({ pluginName, ruleName }, config) {
     const ruleId = pluginName === "@" ? ruleName : `${pluginName}/${ruleName}`;
 
     const errorMessageHeader = `Key "rules": Key "${ruleId}"`;
-    let errorMessage = `${errorMessageHeader}: Could not find plugin "${pluginName}".`;
+
+    let errorMessage = `${errorMessageHeader}: Could not find plugin "${pluginName}" in configuration.`;
+
+    const missingPluginErrorMessage = errorMessage;
 
     // if the plugin exists then we need to check if the rule exists
     if (config.plugins && config.plugins[pluginName]) {
@@ -63,7 +66,14 @@ function throwRuleNotFoundError({ pluginName, ruleName }, config) {
         // falls through to throw error
     }
 
-    throw new TypeError(errorMessage);
+    const error = new TypeError(errorMessage);
+
+    if (errorMessage === missingPluginErrorMessage) {
+        error.messageTemplate = "config-plugin-missing";
+        error.messageData = { pluginName, ruleId };
+    }
+
+    throw error;
 }
 
 /**
diff --git a/messages/config-plugin-missing.js b/messages/config-plugin-missing.js
@@ -0,0 +1,12 @@
+"use strict";
+
+module.exports = function(it) {
+    const { pluginName, ruleId } = it;
+
+    return `
+Common causes of this problem include:
+
+1. The "${pluginName}" plugin is not defined in your configuration file.
+2. The "${pluginName}" plugin is not defined within the same configuration object in which the "${ruleId}" rule is applied.
+`.trimStart();
+};
diff --git a/tests/lib/config/flat-config-array.js b/tests/lib/config/flat-config-array.js
@@ -2373,7 +2373,7 @@ describe("FlatConfigArray", () => {
                             "doesnt-exist/match": "error"
                         }
                     }
-                ], /Key "rules": Key "doesnt-exist\/match": Could not find plugin "doesnt-exist"\./u);
+                ], /Key "rules": Key "doesnt-exist\/match": Could not find plugin "doesnt-exist" in configuration\./u);
             });
 
             it("should error when rule options don't match schema", async () => {

Original file line number	Diff line number	Diff line change
`@@ -2373,7 +2373,7 @@ describe("FlatConfigArray", () => {`
`2373`	`2373`	`"doesnt-exist/match": "error"`
`2374`	`2374`	`}`
`2375`	`2375`	`}`
`2376`		`- ], /Key "rules": Key "doesnt-exist\/match": Could not find plugin "doesnt-exist"\./u);`
	`2376`	`+ ], /Key "rules": Key "doesnt-exist\/match": Could not find plugin "doesnt-exist" in configuration\./u);`
`2377`	`2377`	`});`
`2378`	`2378`
`2379`	`2379`	`it("should error when rule options don't match schema", async () => {`