refactor: automatically generate all configs

.eslintrc.json

@@ -23,6 +23,7 @@
   },
   "rules": {
     "no-var": "error",
-    "@typescript-eslint/explicit-function-return-type": "off"
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }]
   }
 }

CONTRIBUTING.md

@@ -63,11 +63,6 @@ each rule has three files named with its identifier (e.g. `no-debug`):
 
 Additionally, you need to do a couple of extra things:
 
-- Import the new rule in `lib/index.ts` and include it
-  in `rules` constant (there is a test which will make sure you did
-  this). Remember to include your rule under corresponding `config` if necessary
-  (a snapshot test will check this too, but you can update it just running
-  `npm run test:update`).
 - Include your rule in the "Supported Rules" table within the [README.md](./README.md).
   Don't forget to include the proper badges if needed and to sort alphabetically the rules for readability.
 
@@ -105,6 +100,8 @@ If you need some check related to Testing Library which is not available in any
 - pass it through `helpers`
 - write some generic test within `fake-rule.ts`, which is a dumb rule to be able to test all enhanced behavior from our custom Rule Creator.
 
+Take also into account that we're using our own `recommendedConfig` meta instead of the default `recommended` one. This is done so that our tools can automatically generate (`npm run generate:configs`) our configs.
+
 ## Updating existing rules
 
 A couple of things you need to remember when editing already existing rules:

lib/configs/angular.ts

@@ -0,0 +1,21 @@
+// THIS CODE WAS AUTOMATICALLY GENERATED
+// DO NOT EDIT THIS CODE BY HAND
+// YOU CAN REGENERATE IT USING npm run generate:configs
+
+export = {
+  plugins: ['testing-library'],
+  rules: {
+    'testing-library/await-async-query': 'error',
+    'testing-library/await-async-utils': 'error',
+    'testing-library/no-await-sync-query': 'error',
+    'testing-library/no-container': 'error',
+    'testing-library/no-debug': 'error',
+    'testing-library/no-dom-import': ['error', 'angular'],
+    'testing-library/no-node-access': 'error',
+    'testing-library/no-promise-in-fire-event': 'error',
+    'testing-library/no-wait-for-empty-callback': 'error',
+    'testing-library/prefer-find-by': 'error',
+    'testing-library/prefer-screen-queries': 'error',
+    'testing-library/render-result-naming-convention': 'error',
+  },
+};

lib/configs/dom.ts

@@ -0,0 +1,16 @@
+// THIS CODE WAS AUTOMATICALLY GENERATED
+// DO NOT EDIT THIS CODE BY HAND
+// YOU CAN REGENERATE IT USING npm run generate:configs
+
+export = {
+  plugins: ['testing-library'],
+  rules: {
+    'testing-library/await-async-query': 'error',
+    'testing-library/await-async-utils': 'error',
+    'testing-library/no-await-sync-query': 'error',
+    'testing-library/no-promise-in-fire-event': 'error',
+    'testing-library/no-wait-for-empty-callback': 'error',
+    'testing-library/prefer-find-by': 'error',
+    'testing-library/prefer-screen-queries': 'error',
+  },
+};

lib/configs/index.ts

@@ -0,0 +1,24 @@
+import { join } from 'path';
+
+import type { TSESLint } from '@typescript-eslint/experimental-utils';
+
+import {
+  importDefault,
+  SUPPORTED_TESTING_FRAMEWORKS,
+  SupportedTestingFramework,
+} from '../utils';
+
+export type LinterConfigRules = Record<string, TSESLint.Linter.RuleEntry>;
+
+const configsDir = __dirname;
+
+const getConfigForFramework = (framework: SupportedTestingFramework) =>
+  importDefault<LinterConfigRules>(join(configsDir, framework));
+
+export default SUPPORTED_TESTING_FRAMEWORKS.reduce(
+  (allConfigs, framework) => ({
+    ...allConfigs,
+    [framework]: getConfigForFramework(framework),
+  }),
+  {}
+) as Record<SupportedTestingFramework, LinterConfigRules>;

lib/configs/react.ts

@@ -0,0 +1,21 @@
+// THIS CODE WAS AUTOMATICALLY GENERATED
+// DO NOT EDIT THIS CODE BY HAND
+// YOU CAN REGENERATE IT USING npm run generate:configs
+
+export = {
+  plugins: ['testing-library'],
+  rules: {
+    'testing-library/await-async-query': 'error',
+    'testing-library/await-async-utils': 'error',
+    'testing-library/no-await-sync-query': 'error',
+    'testing-library/no-container': 'error',
+    'testing-library/no-debug': 'error',
+    'testing-library/no-dom-import': ['error', 'react'],
+    'testing-library/no-node-access': 'error',
+    'testing-library/no-promise-in-fire-event': 'error',
+    'testing-library/no-wait-for-empty-callback': 'error',
+    'testing-library/prefer-find-by': 'error',
+    'testing-library/prefer-screen-queries': 'error',
+    'testing-library/render-result-naming-convention': 'error',
+  },
+};

lib/configs/vue.ts

@@ -0,0 +1,22 @@
+// THIS CODE WAS AUTOMATICALLY GENERATED
+// DO NOT EDIT THIS CODE BY HAND
+// YOU CAN REGENERATE IT USING npm run generate:configs
+
+export = {
+  plugins: ['testing-library'],
+  rules: {
+    'testing-library/await-async-query': 'error',
+    'testing-library/await-async-utils': 'error',
+    'testing-library/await-fire-event': 'error',
+    'testing-library/no-await-sync-query': 'error',
+    'testing-library/no-container': 'error',
+    'testing-library/no-debug': 'error',
+    'testing-library/no-dom-import': ['error', 'vue'],
+    'testing-library/no-node-access': 'error',
+    'testing-library/no-promise-in-fire-event': 'error',
+    'testing-library/no-wait-for-empty-callback': 'error',
+    'testing-library/prefer-find-by': 'error',
+    'testing-library/prefer-screen-queries': 'error',
+    'testing-library/render-result-naming-convention': 'error',
+  },
+};

lib/create-testing-library-rule/index.ts

@@ -1,30 +1,25 @@
 import { ESLintUtils, TSESLint } from '@typescript-eslint/experimental-utils';
 
-import { getDocsUrl } from '../utils';
+import { getDocsUrl, TestingLibraryRuleMeta } from '../utils';
 
 import {
   DetectionOptions,
   detectTestingLibraryUtils,
   EnhancedRuleCreate,
 } from './detect-testing-library-utils';
 
-// These 2 types are copied from @typescript-eslint/experimental-utils
-type CreateRuleMetaDocs = Omit<TSESLint.RuleMetaDataDocs, 'url'>;
-type CreateRuleMeta<TMessageIds extends string> = {
-  docs: CreateRuleMetaDocs;
-} & Omit<TSESLint.RuleMetaData<TMessageIds>, 'docs'>;
-
 export function createTestingLibraryRule<
   TOptions extends readonly unknown[],
   TMessageIds extends string,
   TRuleListener extends TSESLint.RuleListener = TSESLint.RuleListener
 >({
   create,
   detectionOptions = {},
+  meta,
   ...remainingConfig
 }: Readonly<{
   name: string;
-  meta: CreateRuleMeta<TMessageIds>;
+  meta: TestingLibraryRuleMeta<TMessageIds, TOptions>;
   defaultOptions: Readonly<TOptions>;
   detectionOptions?: Partial<DetectionOptions>;
   create: EnhancedRuleCreate<TOptions, TMessageIds, TRuleListener>;
@@ -35,5 +30,14 @@ export function createTestingLibraryRule<
       create,
       detectionOptions
     ),
+    meta: {
+      ...meta,
+      docs: {
+        ...meta.docs,
+        // We're using our own recommendedConfig meta to tell our build tools
+        // if the rule is recommended on a config basis
+        recommended: false,
+      },
+    },
   });
 }

lib/index.ts

@@ -1,61 +1,7 @@
+import configs from './configs';
 import rules from './rules';
 
-const domRules = {
-  'testing-library/await-async-query': 'error',
-  'testing-library/await-async-utils': 'error',
-  'testing-library/no-await-sync-query': 'error',
-  'testing-library/no-promise-in-fire-event': 'error',
-  'testing-library/no-wait-for-empty-callback': 'error',
-  'testing-library/prefer-find-by': 'error',
-  'testing-library/prefer-screen-queries': 'error',
-};
-
-const angularRules = {
-  ...domRules,
-  'testing-library/no-container': 'error',
-  'testing-library/no-debug': 'error',
-  'testing-library/no-dom-import': ['error', 'angular'],
-  'testing-library/no-node-access': 'error',
-  'testing-library/render-result-naming-convention': 'error',
-};
-
-const reactRules = {
-  ...domRules,
-  'testing-library/no-container': 'error',
-  'testing-library/no-debug': 'error',
-  'testing-library/no-dom-import': ['error', 'react'],
-  'testing-library/no-node-access': 'error',
-  'testing-library/render-result-naming-convention': 'error',
-};
-
-const vueRules = {
-  ...domRules,
-  'testing-library/await-fire-event': 'error',
-  'testing-library/no-container': 'error',
-  'testing-library/no-debug': 'error',
-  'testing-library/no-dom-import': ['error', 'vue'],
-  'testing-library/no-node-access': 'error',
-  'testing-library/render-result-naming-convention': 'error',
-};
-
 export = {
+  configs,
   rules,
-  configs: {
-    dom: {
-      plugins: ['testing-library'],
-      rules: domRules,
-    },
-    angular: {
-      plugins: ['testing-library'],
-      rules: angularRules,
-    },
-    react: {
-      plugins: ['testing-library'],
-      rules: reactRules,
-    },
-    vue: {
-      plugins: ['testing-library'],
-      rules: vueRules,
-    },
-  },
 };

lib/rules/await-async-query.ts

@@ -19,7 +19,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Enforce promises from async queries to be handled',
       category: 'Best Practices',
-      recommended: 'warn',
+      recommendedConfig: {
+        dom: 'error',
+        angular: 'error',
+        react: 'error',
+        vue: 'error',
+      },
     },
     messages: {
       awaitAsyncQuery: 'promise returned from {{ name }} query must be handled',

lib/rules/await-async-utils.ts

@@ -19,7 +19,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Enforce promises from async utils to be handled',
       category: 'Best Practices',
-      recommended: 'warn',
+      recommendedConfig: {
+        dom: 'error',
+        angular: 'error',
+        react: 'error',
+        vue: 'error',
+      },
     },
     messages: {
       awaitAsyncUtil: 'Promise returned from `{{ name }}` must be handled',

lib/rules/await-fire-event.ts

@@ -19,7 +19,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Enforce promises from fire event methods to be handled',
       category: 'Best Practices',
-      recommended: false,
+      recommendedConfig: {
+        dom: false,
+        angular: false,
+        react: false,
+        vue: 'error',
+      },
     },
     messages: {
       awaitFireEvent:

lib/rules/consistent-data-testid.ts

@@ -19,7 +19,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Ensures consistent usage of `data-testid`',
       category: 'Best Practices',
-      recommended: false,
+      recommendedConfig: {
+        dom: false,
+        angular: false,
+        react: false,
+        vue: false,
+      },
     },
     messages: {
       consistentDataTestId: '`{{attr}}` "{{value}}" should match `{{regex}}`',

lib/rules/index.ts

@@ -3,16 +3,13 @@ import { join, parse } from 'path';
 
 import { TSESLint } from '@typescript-eslint/experimental-utils';
 
-type RuleModule = TSESLint.RuleModule<string, unknown[]>;
+import { importDefault, TestingLibraryRuleMeta } from '../utils';
 
-// Copied from https://github.com/babel/babel/blob/b35c78f08dd854b08575fc66ebca323fdbc59dab/packages/babel-helpers/src/helpers.js#L615-L619
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-const interopRequireDefault = (obj: any): { default: unknown } =>
-  obj?.__esModule ? obj : { default: obj };
-
-const importDefault = (moduleName: string) =>
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
-  interopRequireDefault(require(moduleName)).default;
+type RuleModule = TSESLint.RuleModule<string, unknown[]> & {
+  meta: TestingLibraryRuleMeta<string, unknown[]> & {
+    recommended: false;
+  };
+};
 
 const rulesDir = __dirname;
 const excludedFiles = ['index'];
@@ -23,7 +20,7 @@ export default readdirSync(rulesDir)
   .reduce<Record<string, RuleModule>>(
     (allRules, ruleName) => ({
       ...allRules,
-      [ruleName]: importDefault(join(rulesDir, ruleName)) as RuleModule,
+      [ruleName]: importDefault<RuleModule>(join(rulesDir, ruleName)),
     }),
     {}
   );

lib/rules/no-await-sync-events.ts

@@ -21,7 +21,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Disallow unnecessary `await` for sync events',
       category: 'Best Practices',
-      recommended: 'error',
+      recommendedConfig: {
+        dom: false,
+        angular: false,
+        react: false,
+        vue: false,
+      },
     },
     messages: {
       noAwaitSyncEvents:

lib/rules/no-await-sync-query.ts

@@ -13,7 +13,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Disallow unnecessary `await` for sync queries',
       category: 'Best Practices',
-      recommended: 'error',
+      recommendedConfig: {
+        dom: 'error',
+        angular: 'error',
+        react: 'error',
+        vue: 'error',
+      },
     },
     messages: {
       noAwaitSyncQuery:

lib/rules/no-container.ts

@@ -20,7 +20,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Disallow the use of container methods',
       category: 'Best Practices',
-      recommended: 'error',
+      recommendedConfig: {
+        dom: false,
+        angular: 'error',
+        react: 'error',
+        vue: 'error',
+      },
     },
     messages: {
       noContainer:

lib/rules/no-debug.ts

@@ -22,7 +22,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Disallow unnecessary debug usages in the tests',
       category: 'Best Practices',
-      recommended: 'warn',
+      recommendedConfig: {
+        dom: false,
+        angular: 'error',
+        react: 'error',
+        vue: 'error',
+      },
     },
     messages: {
       noDebug: 'Unexpected debug statement',