refactor!: switch to meta.defaultOptions (#353)

Consolidate default options for each rule into one place.

Resolves #51

Author: JasonWeinzierl

.eslint-doc-generatorrc.js

@@ -2,4 +2,11 @@
 
 /** @type {import('eslint-doc-generator').GenerateOptions} */
 export default {
+  ruleDocTitleFormat: 'desc-parens-prefix-name',
+  ruleDocNotices: [
+    'deprecated',
+    'configs',
+    'fixableAndHasSuggestions',
+    'requiresTypeChecking',
+  ],
 };

…eslint-plugin-npm-7.3.0-d800475165.patch …eslint-plugin-npm-7.3.1-6b766f9a07.patch.yarn/patches/eslint-plugin-eslint-plugin-npm-7.3.0-d800475165.patch renamed to .yarn/patches/eslint-plugin-eslint-plugin-npm-7.3.1-6b766f9a07.patch .yarn/patches/eslint-plugin-eslint-plugin-npm-7.3.0-d800475165.patch renamed to .yarn/patches/eslint-plugin-eslint-plugin-npm-7.3.1-6b766f9a07.patch

@@ -1,55 +1,47 @@
 diff --git a/dist/rules/require-test-case-name.js b/dist/rules/require-test-case-name.js
-index 74d279129e367ed2a4e6c601f2b596579a690f9e..9aec1f032bea7ae9324e9928b522fc6f386a9c83 100644
+index b60e75d4ac94a725e09ba1fdd86dbd71228762b4..8bf4fbc0009eaecc429a0f54f22e454f825c66d0 100644
 --- a/dist/rules/require-test-case-name.js
 +++ b/dist/rules/require-test-case-name.js
-@@ -54,6 +54,12 @@ const rule = {
+@@ -54,6 +54,13 @@ const rule = {
  					hasName: false,
  					hasConfig: false
  				};
++				// We use tagged template literals to strip indentation in test cases.
 +				if (testCase.type === "TaggedTemplateExpression" && testCase.quasi?.type === "TemplateLiteral") return {
-+				    node: testCase.quasi,
-+				    isObject: false,
-+				    hasName: false,
-+				    hasConfig: false
-+        		};
++					node: testCase,
++					isObject: false,
++					hasName: false,
++					hasConfig: false
++				};
  				if (testCase.type === "ObjectExpression") {
  					let hasName = false;
  					let hasConfig = false;
 diff --git a/dist/rules/test-case-shorthand-strings.js b/dist/rules/test-case-shorthand-strings.js
-index 584c6a36a619ab1241b72ce4f8aa199e8023f8bc..b4134b70f1871b1fcb99f0f33c16fa7524cb81a3 100644
+index 8474a7400eddb2fba2e46b71b815f237e2ee1242..c7ddefb9b16007166086246962ac44451f231565 100644
 --- a/dist/rules/test-case-shorthand-strings.js
 +++ b/dist/rules/test-case-shorthand-strings.js
 @@ -37,6 +37,12 @@ const rule = {
  					shorthand: true,
  					needsLongform: false
  				};
++				// We use tagged template literals to strip indentation in test cases.
 +				if (testCase.type === "TaggedTemplateExpression" && testCase.quasi?.type === "TemplateLiteral") return {
-+          			node: testCase.quasi,
-+          			fixNode: testCase,
-+          			shorthand: true,
-+          			needsLongform: false
-+        		};
++					node: testCase,
++					shorthand: true,
++					needsLongform: false
++				};
  				if (testCase.type === "ObjectExpression") return {
  					node: testCase,
  					shorthand: false,
-@@ -71,7 +77,8 @@ const rule = {
- 						actual: badCaseInfo.shorthand ? "a string" : "an object"
- 					},
- 					fix(fixer) {
--						return fixer.replaceText(badCaseInfo.node, badCaseInfo.shorthand ? `{code: ${sourceCode.getText(badCaseInfo.node)}}` : sourceCode.getText(badCaseInfo.node.properties[0].value));
-+						const fixNode = badCaseInfo.fixNode || badCaseInfo.node;
-+						return fixer.replaceText(fixNode, badCaseInfo.shorthand ? `{code: ${sourceCode.getText(fixNode)}}` : sourceCode.getText(fixNode.properties[0].value));
- 					}
- 				});
- 			});
 diff --git a/dist/utils.js b/dist/utils.js
-index 8ab5f760911fb4441ed9c54272504bb848a1e705..140e1a3cd080905752a6865a775c4bd9ddd70ba7 100644
+index 8ab5f760911fb4441ed9c54272504bb848a1e705..04eba7ce82ef00e9b9d4188946065a6d4d8d1718 100644
 --- a/dist/utils.js
 +++ b/dist/utils.js
-@@ -22,6 +22,7 @@ function isNormalFunctionExpression(node) {
+@@ -22,6 +22,8 @@ function isNormalFunctionExpression(node) {
  * @returns `true` if the node is probably constructing a RuleTester instance
  */
  function isRuleTesterConstruction(node) {
++	// We import "ruleTester" from a custom util.
 +	if (node.type === "CallExpression" && node.callee.type === "Identifier" && node.callee.name === "ruleTester") return true;
  	return node.type === "NewExpression" && (node.callee.type === "Identifier" && node.callee.name === "RuleTester" || node.callee.type === "MemberExpression" && node.callee.property.type === "Identifier" && node.callee.property.name === "RuleTester");
  }

AGENTS.md

@@ -61,7 +61,7 @@ eslint-plugin-rxjs-x/
 ├── package.json
 ├── README.md
 ├── tsdown.config.ts        # Build configuration
-├── vitest.config.mts       # Test configuration
+├── vitest.config.ts        # Test configuration
 └── yarn.lock               # Packages lockfile
 ```
 
@@ -164,32 +164,34 @@ import { TSESTree as es } from '@typescript-eslint/utils';
 import { getTypeServices } from '../etc';
 import { ruleCreator } from '../utils';
 
-const defaultOptions: readonly {
+type Options = [{
   allowSomething?: boolean;
-}[] = [];
+}];
 
 export const ruleName = ruleCreator({
-  defaultOptions,
   meta: {
     docs: {
       description: 'Rule description',
       recommended: 'recommended', // or 'strict' or false or { recommended: true, strict: {...stricterOptions} }
       requiresTypeChecking: true, // if TypeScript info needed (e.g importing getTypeServices)
     },
+    fixable: 'code' | 'whitespace', // if auto-fixable
+    hasSuggestions: true, // if reported issues have suggestions
     messages: {
       messageId: 'Error message with {{interpolation}}',
     },
     schema: [ // JSON schema for options
       {
         properties: {
-          allowSomething: { type: 'boolean', description: 'Allows something.', default: false },
+          allowSomething: { type: 'boolean', description: 'Allows something.' },
         },
         type: 'object',
       },
     ],
     type: 'problem' | 'suggestion' | 'layout', // "problem" identifies code that causes errors or unexpected behavior; "suggestion" identifies something that could be done better; "layout" is stylistic outside the AST
-    fixable: 'code' | 'whitespace', // if auto-fixable
-    hasSuggestions: true, // if reported issues have suggestions
+    defaultOptions: [{
+      allowSomething: false,
+    }] as Options,
   },
   name: 'rule-name',
   create: (context) => {

docs/rules/finnish.md

@@ -40,17 +40,17 @@ const answer$ = 'green';
 
 <!-- begin auto-generated rule options list -->
 
-| Name         | Description                                                                | Type    |
-| :----------- | :------------------------------------------------------------------------- | :------ |
-| `functions`  | Require for functions.                                                     | Boolean |
-| `methods`    | Require for methods.                                                       | Boolean |
-| `names`      | Enforce for specific names. Keys are a RegExp, values are a boolean.       | Object  |
-| `objects`    | Require for object literal keys.                                           | Boolean |
-| `parameters` | Require for parameters.                                                    | Boolean |
-| `properties` | Require for properties, except object literal keys (see "objects" option). | Boolean |
-| `strict`     | Disallow Finnish notation for non-Observables.                             | Boolean |
-| `types`      | Enforce for specific types. Keys are a RegExp, values are a boolean.       | Object  |
-| `variables`  | Require for variables.                                                     | Boolean |
+| Name         | Description                                                                | Type    | Default           |
+| :----------- | :------------------------------------------------------------------------- | :------ | :---------------- |
+| `functions`  | Require for functions.                                                     | Boolean | `true`            |
+| `methods`    | Require for methods.                                                       | Boolean | `true`            |
+| `names`      | Enforce for specific names. Keys are a RegExp, values are a boolean.       | Object  | `[object Object]` |
+| `objects`    | Require for object literal keys.                                           | Boolean | `true`            |
+| `parameters` | Require for parameters.                                                    | Boolean | `true`            |
+| `properties` | Require for properties, except object literal keys (see "objects" option). | Boolean | `true`            |
+| `strict`     | Disallow Finnish notation for non-Observables.                             | Boolean | `false`           |
+| `types`      | Enforce for specific types. Keys are a RegExp, values are a boolean.       | Object  | `[object Object]` |
+| `variables`  | Require for variables.                                                     | Boolean | `true`            |
 
 <!-- end auto-generated rule options list -->
 

docs/rules/suffix-subjects.md

@@ -32,14 +32,14 @@ combineLatest({ answers: new Subject<number>() });
 
 <!-- begin auto-generated rule options list -->
 
-| Name         | Description                                                                | Type    |
-| :----------- | :------------------------------------------------------------------------- | :------ |
-| `objects`    | Require for object literal keys.                                           | Boolean |
-| `parameters` | Require for parameters.                                                    | Boolean |
-| `properties` | Require for properties, except object literal keys (see "objects" option). | Boolean |
-| `suffix`     | The suffix to enforce.                                                     | String  |
-| `types`      | Enforce for specific types. Keys are a RegExp, values are a boolean.       | Object  |
-| `variables`  | Require for variables.                                                     | Boolean |
+| Name         | Description                                                                | Type    | Default           |
+| :----------- | :------------------------------------------------------------------------- | :------ | :---------------- |
+| `objects`    | Require for object literal keys.                                           | Boolean | `true`            |
+| `parameters` | Require for parameters.                                                    | Boolean | `true`            |
+| `properties` | Require for properties, except object literal keys (see "objects" option). | Boolean | `true`            |
+| `suffix`     | The suffix to enforce.                                                     | String  | `Subject`         |
+| `types`      | Enforce for specific types. Keys are a RegExp, values are a boolean.       | Object  | `[object Object]` |
+| `variables`  | Require for variables.                                                     | Boolean | `true`            |
 
 <!-- end auto-generated rule options list -->
 

eslint.config.js

@@ -80,11 +80,6 @@ export default defineConfig(gitignore(), {
     ],
     'eslint-plugin/unique-test-case-names': 'error',
     'eslint-plugin/no-matching-violation-suggest-message-ids': 'error',
-    // TODO(https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/issues/51):
-    // fixing these may require bumping the minimum ESLint version.
-    'eslint-plugin/require-meta-default-options': 'off',
-    'eslint-plugin/no-meta-schema-default': 'off',
-    'eslint-plugin/no-meta-replaced-by': 'off',
 
     '@typescript-eslint/no-unnecessary-condition': 'off',
     '@typescript-eslint/restrict-template-expressions': [

package.json

@@ -81,9 +81,9 @@
     "bumpp": "^10.4.1",
     "eslint": "^10.0.0",
     "eslint-config-flat-gitignore": "^2.1.0",
-    "eslint-doc-generator": "^2.4.0",
+    "eslint-doc-generator": "^3.1.0",
     "eslint-import-resolver-typescript": "^4.4.4",
-    "eslint-plugin-eslint-plugin": "patch:eslint-plugin-eslint-plugin@npm%3A7.3.0#~/.yarn/patches/eslint-plugin-eslint-plugin-npm-7.3.0-d800475165.patch",
+    "eslint-plugin-eslint-plugin": "patch:eslint-plugin-eslint-plugin@npm%3A7.3.1#~/.yarn/patches/eslint-plugin-eslint-plugin-npm-7.3.1-6b766f9a07.patch",
     "eslint-plugin-import-x": "^4.16.1",
     "eslint-plugin-n": "^17.23.2",
     "markdownlint-cli2": "~0.19.0",

src/rules/ban-observables.ts

@@ -1,11 +1,11 @@
-import { AST_NODE_TYPES, TSESTree as es } from '@typescript-eslint/utils';
+import { TSESTree as es } from '@typescript-eslint/utils';
 import { stripIndent } from 'common-tags';
+import { isIdentifier } from '../etc';
 import { ruleCreator } from '../utils';
 
-const defaultOptions: readonly Record<string, boolean | string>[] = [];
+type Options = readonly [Record<string, boolean | string>];
 
 export const banObservablesRule = ruleCreator({
-  defaultOptions,
   meta: {
     docs: {
       description: 'Disallow banned observable creators.',
@@ -19,16 +19,27 @@ export const banObservablesRule = ruleCreator({
         description: stripIndent`
           An object containing keys that are names of observable factory functions
           and values that are either booleans or strings containing the explanation for the ban.`,
+        additionalProperties: {
+          anyOf: [
+            {
+              type: 'boolean',
+            },
+            {
+              type: 'string',
+            },
+          ],
+        },
       },
     ],
     type: 'problem',
+    defaultOptions: [{}] as Options,
   },
   name: 'ban-observables',
   create: (context) => {
     const bans: { explanation: string; regExp: RegExp }[] = [];
 
     const [config] = context.options;
-    if (!config) {
+    if (!config || !Object.keys(config).length) {
       return {};
     }
 
@@ -60,7 +71,7 @@ export const banObservablesRule = ruleCreator({
         node: es.ImportSpecifier,
       ) => {
         const identifier = node.imported;
-        const name = identifier.type === AST_NODE_TYPES.Identifier ? identifier.name : identifier.value;
+        const name = isIdentifier(identifier) ? identifier.name : identifier.value;
         const failure = getFailure(name);
         if (failure) {
           context.report({

src/rules/ban-operators.ts

@@ -3,10 +3,9 @@ import { stripIndent } from 'common-tags';
 import { getTypeServices } from '../etc';
 import { ruleCreator } from '../utils';
 
-const defaultOptions: readonly Record<string, boolean | string>[] = [];
+type Options = readonly [Record<string, boolean | string>];
 
 export const banOperatorsRule = ruleCreator({
-  defaultOptions,
   meta: {
     docs: {
       description: 'Disallow banned operators.',
@@ -21,17 +20,28 @@ export const banOperatorsRule = ruleCreator({
         description: stripIndent`
           An object containing keys that are names of operators
           and values that are either booleans or strings containing the explanation for the ban.`,
+        additionalProperties: {
+          anyOf: [
+            {
+              type: 'boolean',
+            },
+            {
+              type: 'string',
+            },
+          ],
+        },
       },
     ],
     type: 'problem',
+    defaultOptions: [{}] as Options,
   },
   name: 'ban-operators',
   create: (context) => {
     const { couldBeType } = getTypeServices(context);
     const bans: { name: string; explanation: string }[] = [];
 
     const [config] = context.options;
-    if (!config) {
+    if (!config || !Object.keys(config).length) {
       return {};
     }