fix: relax type for rule.meta.docs.recommended (#235)

Author: kirkwaiblinger

packages/config-helpers/tests/types/types.test.ts

@@ -71,3 +71,23 @@ defineConfig(
 
 globalIgnores(["node_modules"]);
 globalIgnores(["dist", "build"], "my name");
+
+defineConfig({
+	plugins: {
+		"some-plugin": {
+			rules: {
+				"some-rule": {
+					meta: {
+						docs: {
+							recommended: "not a boolean!",
+						},
+					},
+
+					create() {
+						return {};
+					},
+				},
+			},
+		},
+	},
+});

packages/core/src/types.ts

@@ -127,8 +127,10 @@ export interface RulesMetaDocs {
 
 	/**
 	 * Indicates if the rule is generally recommended for all users.
+	 *
+	 * Note - this will always be a boolean for core rules, but may be used in any way by plugins.
 	 */
-	recommended?: boolean | undefined;
+	recommended?: unknown;
 
 	/**
 	 * Indicates if the rule is frozen (no longer accepting feature requests).

packages/core/tests/types/types.test.ts

@@ -23,6 +23,7 @@ import type {
 	RuleDefinition,
 	RulesConfig,
 	RulesMeta,
+	RulesMetaDocs,
 	RuleTextEdit,
 	RuleTextEditor,
 	RuleVisitor,
@@ -240,6 +241,9 @@ const testRule: RuleDefinition<{
 	meta: {
 		type: "problem",
 		fixable: "code",
+		docs: {
+			recommended: true,
+		},
 		deprecated: {
 			message: "use something else",
 			url: "https://example.com",
@@ -413,3 +417,16 @@ export type Rule5 = TestRuleDefinition<{ Code: TestSourceCode }>;
 
 // @ts-expect-error -- undefined value not allow for optional property (assumes `exactOptionalPropertyTypes` tsc compiler option)
 export type Rule6 = TestRuleDefinition<{ RuleOptions: undefined }>;
+
+export const shouldAllowRecommendedBoolean: RulesMetaDocs = {
+	recommended: true,
+};
+export const shouldAllowRecommendedString: RulesMetaDocs = {
+	recommended: "strict",
+};
+
+export const shouldAllowRecommendedObject: RulesMetaDocs = {
+	recommended: {
+		someKey: "some value",
+	},
+};