refactor: use defaultOptions in rules (#1105)

Author: 9romise

eslint.config.mjs

@@ -86,7 +86,6 @@ export default antfu(
     rules: {
       'eslint-plugin/meta-property-ordering': 'error',
       'eslint-plugin/no-meta-schema-default': 'off',
-      'eslint-plugin/require-meta-default-options': 'off',
       'eslint-plugin/require-meta-schema-description': 'off',
       'perfectionist/sort-objects': [
         'error',

packages/eslint-plugin/rules/array-bracket-newline/array-bracket-newline.ts

@@ -39,6 +39,8 @@ export default createRule<RuleOptions, MessageIds>({
         ],
       },
     ],
+    // eslint-disable-next-line eslint-plugin/require-meta-default-options
+    defaultOptions: [],
     messages: {
       unexpectedOpeningLinebreak: 'There should be no linebreak after \'[\'.',
       unexpectedClosingLinebreak: 'There should be no linebreak before \']\'.',

packages/eslint-plugin/rules/array-bracket-spacing/array-bracket-spacing.ts

@@ -37,15 +37,16 @@ export default createRule<RuleOptions, MessageIds>({
         additionalProperties: false,
       },
     ],
+    defaultOptions: ['never'],
     messages: {
       unexpectedSpaceAfter: 'There should be no space after \'{{tokenValue}}\'.',
       unexpectedSpaceBefore: 'There should be no space before \'{{tokenValue}}\'.',
       missingSpaceAfter: 'A space is required after \'{{tokenValue}}\'.',
       missingSpaceBefore: 'A space is required before \'{{tokenValue}}\'.',
     },
   },
-  create(context) {
-    const spaced = context.options[0] === 'always'
+  create(context, [style]) {
+    const spaced = style === 'always'
     const sourceCode = context.sourceCode
 
     /**

packages/eslint-plugin/rules/array-element-newline/array-element-newline.ts

@@ -67,6 +67,7 @@ export default createRule<RuleOptions, MessageIds>({
         },
       ],
     },
+    defaultOptions: [],
     messages: {
       unexpectedLineBreak: 'There should be no linebreak here.',
       missingLineBreak: 'There should be a linebreak after this element.',

packages/eslint-plugin/rules/arrow-parens/arrow-parens.ts

@@ -41,17 +41,17 @@ export default createRule<RuleOptions, MessageIds>({
         additionalProperties: false,
       },
     ],
+    defaultOptions: ['always'],
     messages: {
       unexpectedParens: 'Unexpected parentheses around single function argument.',
       expectedParens: 'Expected parentheses around arrow function argument.',
-
       unexpectedParensInline: 'Unexpected parentheses around single function argument having a body with no curly braces.',
       expectedParensBlock: 'Expected parentheses around arrow function argument having a body with curly braces.',
     },
   },
-  create(context) {
-    const asNeeded = context.options[0] === 'as-needed'
-    const requireForBlockBody = asNeeded && context.options[1] && context.options[1].requireForBlockBody === true
+  create(context, [style, options]) {
+    const asNeeded = style === 'as-needed'
+    const requireForBlockBody = asNeeded && options?.requireForBlockBody === true
 
     const sourceCode = context.sourceCode
 

packages/eslint-plugin/rules/arrow-spacing/arrow-spacing.ts

@@ -29,6 +29,7 @@ export default createRule<RuleOptions, MessageIds>({
         additionalProperties: false,
       },
     ],
+    defaultOptions: [{ before: true, after: true }],
     messages: {
       expectedBefore: 'Missing space before =>.',
       unexpectedBefore: 'Unexpected space before =>.',
@@ -37,13 +38,7 @@ export default createRule<RuleOptions, MessageIds>({
       unexpectedAfter: 'Unexpected space after =>.',
     },
   },
-  create(context) {
-    // merge rules with default
-    const rule = Object.assign({}, context.options[0])
-
-    rule.before = rule.before !== false
-    rule.after = rule.after !== false
-
+  create(context, [option]) {
     const sourceCode = context.sourceCode
 
     function getArrow(node: SupportedNode) {
@@ -67,7 +62,7 @@ export default createRule<RuleOptions, MessageIds>({
       const beforeToken = sourceCode.getTokenBefore(arrowToken, { includeComments: true })!
       const isSpacedBefore = sourceCode.isSpaceBetween(beforeToken, arrowToken)
 
-      if (rule.before) {
+      if (option!.before) {
         // should be space(s) before arrow
         if (!isSpacedBefore) {
           context.report({
@@ -95,7 +90,7 @@ export default createRule<RuleOptions, MessageIds>({
       const afterToken = sourceCode.getTokenAfter(arrowToken, { includeComments: true })!
       const isSpacedAfter = sourceCode.isSpaceBetween(arrowToken, afterToken)
 
-      if (rule.after) {
+      if (option!.after) {
         // should be space(s) after arrow
         if (!isSpacedAfter) {
           context.report({

packages/eslint-plugin/rules/block-spacing/block-spacing.ts

@@ -17,12 +17,12 @@ export default createRule<RuleOptions, MessageIds>({
     schema: [
       { type: 'string', enum: ['always', 'never'] },
     ],
+    defaultOptions: ['always'],
     messages: {
       missing: 'Requires a space {{location}} \'{{token}}\'.',
       extra: 'Unexpected space(s) {{location}} \'{{token}}\'.',
     },
   },
-  defaultOptions: ['always'],
   create(context, [whenToApplyOption]) {
     const sourceCode = context.sourceCode
     const always = whenToApplyOption !== 'never'

packages/eslint-plugin/rules/brace-style/brace-style.ts

@@ -28,6 +28,7 @@ export default createRule<RuleOptions, MessageIds>({
         additionalProperties: false,
       },
     ],
+    defaultOptions: ['1tbs', { allowSingleLine: false }],
     messages: {
       nextLineOpen: 'Opening curly brace does not appear on the same line as controlling statement.',
       sameLineOpen: 'Opening curly brace appears on the same line as controlling statement.',
@@ -37,15 +38,14 @@ export default createRule<RuleOptions, MessageIds>({
       sameLineClose: 'Closing curly brace appears on the same line as the subsequent block.',
     },
   },
-  defaultOptions: ['1tbs', { allowSingleLine: false }],
-  create(context, optionsWithDefaults) {
-    const [
-      style,
-      { allowSingleLine } = { allowSingleLine: false },
-    ] = optionsWithDefaults
+  create(context, [style, options]) {
+    const sourceCode = context.sourceCode
+
+    const {
+      allowSingleLine,
+    } = options!
 
     const isAllmanStyle = style === 'allman'
-    const sourceCode = context.sourceCode
 
     /**
      * Validates a pair of curly brackets based on the user's config

packages/eslint-plugin/rules/comma-dangle/comma-dangle.ts

@@ -98,12 +98,12 @@ export default createRule<RuleOptions, MessageIds>({
       ],
       additionalItems: false,
     },
+    defaultOptions: ['never'],
     messages: {
       unexpected: 'Unexpected trailing comma.',
       missing: 'Missing trailing comma.',
     },
   },
-  defaultOptions: ['never'],
   create(context, [options]) {
     function normalizeOptions(options: Option = {}, ecmaVersion: EcmaVersion | 'latest' | undefined): NormalizedOptions {
       const DEFAULT_OPTION_VALUE = 'never'

packages/eslint-plugin/rules/comma-spacing/comma-spacing.ts

@@ -34,19 +34,19 @@ export default createRule<RuleOptions, MessageIds>({
         additionalProperties: false,
       },
     ],
+    defaultOptions: [
+      {
+        before: false,
+        after: true,
+      },
+    ],
     messages: {
       unexpected: `There should be no space {{loc}} ','.`,
       missing: `A space is required {{loc}} ','.`,
     },
   },
-  defaultOptions: [
-    {
-      before: false,
-      after: true,
-    },
-  ],
-  create(context, [options = {}]) {
-    const { before: spaceBefore, after: spaceAfter } = options
+  create(context, [options]) {
+    const { before: spaceBefore, after: spaceAfter } = options!
     const sourceCode = context.sourceCode
     const tokensAndComments = sourceCode.tokensAndComments
     const ignoredTokens = new Set<Tree.PunctuatorToken>()