fix(utils): add defaultOptions to meta in rule (typescript-eslint#10339)

Co-authored-by: Brad Zacher <[email protected]>

Author: LuisUrrutia

packages/eslint-plugin/src/rules/consistent-return.ts

@@ -21,10 +21,12 @@ type FunctionNode =
   | TSESTree.FunctionDeclaration
   | TSESTree.FunctionExpression;
 
+const defaultOptions: Options = [{ treatUndefinedAsUnspecified: false }];
 export default createRule<Options, MessageIds>({
   name: 'consistent-return',
   meta: {
     type: 'suggestion',
+    defaultOptions,
     docs: {
       description:
         'Require `return` statements to either always or never specify values',
@@ -35,7 +37,7 @@ export default createRule<Options, MessageIds>({
     messages: baseRule.meta.messages,
     schema: baseRule.meta.schema,
   },
-  defaultOptions: [{ treatUndefinedAsUnspecified: false }],
+  defaultOptions,
   create(context, [options]) {
     const services = getParserServices(context);
     const checker = services.program.getTypeChecker();

packages/eslint-plugin/src/rules/dot-notation.ts

@@ -17,10 +17,21 @@ const baseRule = getESLintCoreRule('dot-notation');
 export type Options = InferOptionsTypeFromRule<typeof baseRule>;
 export type MessageIds = InferMessageIdsTypeFromRule<typeof baseRule>;
 
+const defaultOptions: Options = [
+  {
+    allowIndexSignaturePropertyAccess: false,
+    allowKeywords: true,
+    allowPattern: '',
+    allowPrivateClassPropertyAccess: false,
+    allowProtectedClassPropertyAccess: false,
+  },
+];
+
 export default createRule<Options, MessageIds>({
   name: 'dot-notation',
   meta: {
     type: 'suggestion',
+    defaultOptions,
     docs: {
       description: 'Enforce dot notation whenever possible',
       extendsBaseRule: true,
@@ -67,15 +78,7 @@ export default createRule<Options, MessageIds>({
       },
     ],
   },
-  defaultOptions: [
-    {
-      allowIndexSignaturePropertyAccess: false,
-      allowKeywords: true,
-      allowPattern: '',
-      allowPrivateClassPropertyAccess: false,
-      allowProtectedClassPropertyAccess: false,
-    },
-  ],
+  defaultOptions,
   create(context, [options]) {
     const rules = baseRule.create(context);
     const services = getParserServices(context);

packages/eslint-plugin/src/rules/init-declarations.ts

@@ -19,6 +19,7 @@ export default createRule<Options, MessageIds>({
   name: 'init-declarations',
   meta: {
     type: 'suggestion',
+    // defaultOptions, -- base rule does not use defaultOptions
     docs: {
       description:
         'Require or disallow initialization in variable declarations',

packages/eslint-plugin/src/rules/max-params.ts

@@ -26,6 +26,7 @@ export default createRule<Options, MessageIds>({
   name: 'max-params',
   meta: {
     type: 'suggestion',
+    // defaultOptions, -- base rule does not use defaultOptions
     docs: {
       description:
         'Enforce a maximum number of parameters in function definitions',

packages/eslint-plugin/src/rules/no-dupe-class-members.ts

@@ -19,6 +19,7 @@ export default createRule<Options, MessageIds>({
   name: 'no-dupe-class-members',
   meta: {
     type: 'problem',
+    // defaultOptions, -- base rule does not use defaultOptions
     docs: {
       description: 'Disallow duplicate class members',
       extendsBaseRule: true,

packages/eslint-plugin/src/rules/no-empty-function.ts

@@ -16,6 +16,12 @@ const baseRule = getESLintCoreRule('no-empty-function');
 type Options = InferOptionsTypeFromRule<typeof baseRule>;
 type MessageIds = InferMessageIdsTypeFromRule<typeof baseRule>;
 
+const defaultOptions: Options = [
+  {
+    allow: [],
+  },
+];
+
 const schema = deepMerge(
   // eslint-disable-next-line @typescript-eslint/no-unsafe-argument -- https://github.com/microsoft/TypeScript/issues/17002
   Array.isArray(baseRule.meta.schema)
@@ -54,6 +60,7 @@ export default createRule<Options, MessageIds>({
   name: 'no-empty-function',
   meta: {
     type: 'suggestion',
+    defaultOptions,
     docs: {
       description: 'Disallow empty functions',
       extendsBaseRule: true,
@@ -63,11 +70,7 @@ export default createRule<Options, MessageIds>({
     messages: baseRule.meta.messages,
     schema: [schema],
   },
-  defaultOptions: [
-    {
-      allow: [],
-    },
-  ],
+  defaultOptions,
   create(context, [{ allow = [] }]) {
     const rules = baseRule.create(context);
 

packages/eslint-plugin/src/rules/no-invalid-this.ts

@@ -15,10 +15,13 @@ const baseRule = getESLintCoreRule('no-invalid-this');
 export type Options = InferOptionsTypeFromRule<typeof baseRule>;
 export type MessageIds = InferMessageIdsTypeFromRule<typeof baseRule>;
 
+const defaultOptions: Options = [{ capIsConstructor: true }];
+
 export default createRule<Options, MessageIds>({
   name: 'no-invalid-this',
   meta: {
     type: 'suggestion',
+    defaultOptions,
     docs: {
       description:
         'Disallow `this` keywords outside of classes or class-like objects',
@@ -28,7 +31,7 @@ export default createRule<Options, MessageIds>({
     messages: baseRule.meta.messages,
     schema: baseRule.meta.schema,
   },
-  defaultOptions: [{ capIsConstructor: true }],
+  defaultOptions,
   create(context) {
     const rules = baseRule.create(context);
 

packages/eslint-plugin/src/rules/no-loop-func.ts

@@ -19,6 +19,7 @@ export default createRule<Options, MessageIds>({
   name: 'no-loop-func',
   meta: {
     type: 'suggestion',
+    // defaultOptions, -- base rule does not use defaultOptions
     docs: {
       description:
         'Disallow function declarations that contain unsafe references inside loop statements',

packages/eslint-plugin/src/rules/no-loss-of-precision.ts

@@ -15,6 +15,7 @@ export default createRule<Options, MessageIds>({
   name: 'no-loss-of-precision',
   meta: {
     type: 'problem',
+    // defaultOptions, -- base rule does not use defaultOptions
     deprecated: true,
     docs: {
       description: 'Disallow literal numbers that lose precision',

packages/eslint-plugin/src/rules/no-magic-numbers.ts

@@ -49,6 +49,7 @@ export default createRule<Options, MessageIds>({
   name: 'no-magic-numbers',
   meta: {
     type: 'suggestion',
+    // defaultOptions, -- base rule does not use defaultOptions
     docs: {
       description: 'Disallow magic numbers',
       extendsBaseRule: true,

packages/eslint-plugin/src/rules/no-restricted-imports.ts

@@ -233,6 +233,7 @@ export default createRule<Options, MessageIds>({
   name: 'no-restricted-imports',
   meta: {
     type: 'suggestion',
+    // defaultOptions, -- base rule does not use defaultOptions
     docs: {
       description: 'Disallow specified modules when loaded by `import`',
       extendsBaseRule: true,

packages/eslint-plugin/src/rules/no-unused-expressions.ts

@@ -13,10 +13,19 @@ const baseRule = getESLintCoreRule('no-unused-expressions');
 type MessageIds = InferMessageIdsTypeFromRule<typeof baseRule>;
 type Options = InferOptionsTypeFromRule<typeof baseRule>;
 
+const defaultOptions: Options = [
+  {
+    allowShortCircuit: false,
+    allowTaggedTemplates: false,
+    allowTernary: false,
+  },
+];
+
 export default createRule<Options, MessageIds>({
   name: 'no-unused-expressions',
   meta: {
     type: 'suggestion',
+    defaultOptions,
     docs: {
       description: 'Disallow unused expressions',
       extendsBaseRule: true,
@@ -26,13 +35,7 @@ export default createRule<Options, MessageIds>({
     messages: baseRule.meta.messages,
     schema: baseRule.meta.schema,
   },
-  defaultOptions: [
-    {
-      allowShortCircuit: false,
-      allowTaggedTemplates: false,
-      allowTernary: false,
-    },
-  ],
+  defaultOptions,
   create(context, [{ allowShortCircuit = false, allowTernary = false }]) {
     const rules = baseRule.create(context);
 

packages/eslint-plugin/src/rules/no-useless-constructor.ts

@@ -47,6 +47,7 @@ export default createRule<Options, MessageIds>({
   name: 'no-useless-constructor',
   meta: {
     type: 'problem',
+    // defaultOptions, -- base rule does not use defaultOptions
     docs: {
       description: 'Disallow unnecessary constructors',
       extendsBaseRule: true,

packages/eslint-plugin/src/rules/prefer-destructuring.ts

@@ -71,6 +71,7 @@ export default createRule<Options, MessageIds>({
   name: 'prefer-destructuring',
   meta: {
     type: 'suggestion',
+    // defaultOptions, -- base rule does not use defaultOptions
     docs: {
       description: 'Require destructuring from arrays and/or objects',
       extendsBaseRule: true,

packages/utils/src/eslint-utils/RuleCreator.ts

@@ -14,9 +14,10 @@ export type NamedCreateRuleMetaDocs = Omit<RuleMetaDataDocs, 'url'>;
 export type NamedCreateRuleMeta<
   MessageIds extends string,
   PluginDocs = unknown,
+  Options extends readonly unknown[] = [],
 > = {
   docs: PluginDocs & RuleMetaDataDocs;
-} & Omit<RuleMetaData<MessageIds, PluginDocs>, 'docs'>;
+} & Omit<RuleMetaData<MessageIds, PluginDocs, Options>, 'docs'>;
 
 export interface RuleCreateAndOptions<
   Options extends readonly unknown[],
@@ -34,15 +35,15 @@ export interface RuleWithMeta<
   MessageIds extends string,
   Docs = unknown,
 > extends RuleCreateAndOptions<Options, MessageIds> {
-  meta: RuleMetaData<MessageIds, Docs>;
+  meta: RuleMetaData<MessageIds, Docs, Options>;
 }
 
 export interface RuleWithMetaAndName<
   Options extends readonly unknown[],
   MessageIds extends string,
   Docs = unknown,
 > extends RuleCreateAndOptions<Options, MessageIds> {
-  meta: NamedCreateRuleMeta<MessageIds, Docs>;
+  meta: NamedCreateRuleMeta<MessageIds, Docs, Options>;
   name: string;
 }
 

packages/utils/src/ts-eslint/Rule.ts

@@ -27,7 +27,11 @@ export interface RuleMetaDataDocs {
   url?: string;
 }
 
-export interface RuleMetaData<MessageIds extends string, PluginDocs = unknown> {
+export interface RuleMetaData<
+  MessageIds extends string,
+  PluginDocs = unknown,
+  Options extends readonly unknown[] = [],
+> {
   /**
    * True if the rule is deprecated, false otherwise
    */
@@ -65,12 +69,22 @@ export interface RuleMetaData<MessageIds extends string, PluginDocs = unknown> {
    * - `"layout"` means the rule cares primarily about whitespace, semicolons, commas, and parentheses, all the parts of the program that determine how the code looks rather than how it executes. These rules work on parts of the code that aren’t specified in the AST.
    */
   type: 'layout' | 'problem' | 'suggestion';
+
+  /**
+   * Specifies default options for the rule. If present, any user-provided options in their config will be merged on top of them recursively.
+   * This merging will be applied directly to `context.options`.
+   * If you want backwards-compatible support for earlier ESLint version; consider using the top-level `defaultOptions` instead.
+   *
+   * since ESLint 9.15.0
+   */
+  defaultOptions?: Options;
 }
 
 export interface RuleMetaDataWithDocs<
   MessageIds extends string,
   PluginDocs = unknown,
-> extends RuleMetaData<MessageIds, PluginDocs> {
+  Options extends readonly unknown[] = [],
+> extends RuleMetaData<MessageIds, PluginDocs, Options> {
   /**
    * Documentation for the rule
    */
@@ -655,7 +669,7 @@ export interface RuleModule<
   /**
    * Metadata about the rule
    */
-  meta: RuleMetaData<MessageIds, Docs>;
+  meta: RuleMetaData<MessageIds, Docs, Options>;
 }
 
 export type AnyRuleModule = RuleModule<string, readonly unknown[]>;
@@ -670,7 +684,7 @@ export interface RuleModuleWithMetaDocs<
   /**
    * Metadata about the rule
    */
-  meta: RuleMetaDataWithDocs<MessageIds, Docs>;
+  meta: RuleMetaDataWithDocs<MessageIds, Docs, Options>;
 }
 
 export type AnyRuleModuleWithMetaDocs = RuleModuleWithMetaDocs<