refactor: use recommendedConfig instead of recommended in meta docs

MichaelDeBoey · MichaelDeBoey · commit 65f208b2f803 · 2021-04-27T19:43:43.000+02:00
diff --git a/lib/configs/angular.ts b/lib/configs/angular.ts
@@ -2,4 +2,20 @@
 // DO NOT EDIT THIS CODE BY HAND
 // YOU CAN REGENERATE IT USING yarn generate:configs
 
-export = { plugins: ['testing-library'], rules: {} };
+export = {
+  plugins: ['testing-library'],
+  rules: {
+    'await-async-query': 'error',
+    'await-async-utils': 'error',
+    'no-await-sync-query': 'error',
+    'no-container': 'error',
+    'no-debug': 'error',
+    'no-dom-import': ['error', 'angular'],
+    'no-node-access': 'error',
+    'no-promise-in-fire-event': 'error',
+    'no-wait-for-empty-callback': 'error',
+    'prefer-find-by': 'error',
+    'prefer-screen-queries': 'error',
+    'render-result-naming-convention': 'error',
+  },
+};
diff --git a/lib/configs/dom.ts b/lib/configs/dom.ts
@@ -2,4 +2,15 @@
 // DO NOT EDIT THIS CODE BY HAND
 // YOU CAN REGENERATE IT USING yarn generate:configs
 
-export = { plugins: ['testing-library'], rules: {} };
+export = {
+  plugins: ['testing-library'],
+  rules: {
+    'await-async-query': 'error',
+    'await-async-utils': 'error',
+    'no-await-sync-query': 'error',
+    'no-promise-in-fire-event': 'error',
+    'no-wait-for-empty-callback': 'error',
+    'prefer-find-by': 'error',
+    'prefer-screen-queries': 'error',
+  },
+};
diff --git a/lib/configs/react.ts b/lib/configs/react.ts
@@ -2,4 +2,20 @@
 // DO NOT EDIT THIS CODE BY HAND
 // YOU CAN REGENERATE IT USING yarn generate:configs
 
-export = { plugins: ['testing-library'], rules: {} };
+export = {
+  plugins: ['testing-library'],
+  rules: {
+    'await-async-query': 'error',
+    'await-async-utils': 'error',
+    'no-await-sync-query': 'error',
+    'no-container': 'error',
+    'no-debug': 'error',
+    'no-dom-import': ['error', 'react'],
+    'no-node-access': 'error',
+    'no-promise-in-fire-event': 'error',
+    'no-wait-for-empty-callback': 'error',
+    'prefer-find-by': 'error',
+    'prefer-screen-queries': 'error',
+    'render-result-naming-convention': 'error',
+  },
+};
diff --git a/lib/configs/vue.ts b/lib/configs/vue.ts
@@ -2,4 +2,21 @@
 // DO NOT EDIT THIS CODE BY HAND
 // YOU CAN REGENERATE IT USING yarn generate:configs
 
-export = { plugins: ['testing-library'], rules: {} };
+export = {
+  plugins: ['testing-library'],
+  rules: {
+    'await-async-query': 'error',
+    'await-async-utils': 'error',
+    'await-fire-event': 'error',
+    'no-await-sync-query': 'error',
+    'no-container': 'error',
+    'no-debug': 'error',
+    'no-dom-import': ['error', 'vue'],
+    'no-node-access': 'error',
+    'no-promise-in-fire-event': 'error',
+    'no-wait-for-empty-callback': 'error',
+    'prefer-find-by': 'error',
+    'prefer-screen-queries': 'error',
+    'render-result-naming-convention': 'error',
+  },
+};
diff --git a/lib/rules/await-async-query.ts b/lib/rules/await-async-query.ts
@@ -19,7 +19,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Enforce promises from async queries to be handled',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: 'error',
         angular: 'error',
         react: 'error',
diff --git a/lib/rules/await-async-utils.ts b/lib/rules/await-async-utils.ts
@@ -19,7 +19,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Enforce promises from async utils to be handled',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: 'error',
         angular: 'error',
         react: 'error',
diff --git a/lib/rules/await-fire-event.ts b/lib/rules/await-fire-event.ts
@@ -19,7 +19,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Enforce promises from fire event methods to be handled',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: false,
         angular: false,
         react: false,
diff --git a/lib/rules/consistent-data-testid.ts b/lib/rules/consistent-data-testid.ts
@@ -19,7 +19,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Ensures consistent usage of `data-testid`',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: false,
         angular: false,
         react: false,
diff --git a/lib/rules/index.ts b/lib/rules/index.ts
@@ -6,7 +6,9 @@ import { TSESLint } from '@typescript-eslint/experimental-utils';
 import { importDefault, TestingLibraryRuleMeta } from '../utils';
 
 type RuleModule = TSESLint.RuleModule<string, unknown[]> & {
-  meta: TestingLibraryRuleMeta<string, unknown[]>;
+  meta: TestingLibraryRuleMeta<string, unknown[]> & {
+    recommended: false;
+  };
 };
 
 const rulesDir = __dirname;
diff --git a/lib/rules/no-await-sync-events.ts b/lib/rules/no-await-sync-events.ts
@@ -21,7 +21,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Disallow unnecessary `await` for sync events',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: false,
         angular: false,
         react: false,
diff --git a/lib/rules/no-await-sync-query.ts b/lib/rules/no-await-sync-query.ts
@@ -13,7 +13,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Disallow unnecessary `await` for sync queries',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: 'error',
         angular: 'error',
         react: 'error',
diff --git a/lib/rules/no-container.ts b/lib/rules/no-container.ts
@@ -20,7 +20,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Disallow the use of container methods',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: false,
         angular: 'error',
         react: 'error',
diff --git a/lib/rules/no-debug.ts b/lib/rules/no-debug.ts
@@ -22,7 +22,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Disallow unnecessary debug usages in the tests',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: false,
         angular: 'error',
         react: 'error',
diff --git a/lib/rules/no-dom-import.ts b/lib/rules/no-dom-import.ts
@@ -18,7 +18,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Disallow importing from DOM Testing Library',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: false,
         angular: ['error', 'angular'],
         react: ['error', 'react'],
diff --git a/lib/rules/no-manual-cleanup.ts b/lib/rules/no-manual-cleanup.ts
@@ -28,7 +28,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Disallow the use of `cleanup`',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: false,
         angular: false,
         react: false,
diff --git a/lib/rules/no-node-access.ts b/lib/rules/no-node-access.ts
@@ -13,7 +13,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Disallow direct Node access',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: false,
         angular: 'error',
         react: 'error',
diff --git a/lib/rules/no-promise-in-fire-event.ts b/lib/rules/no-promise-in-fire-event.ts
@@ -20,7 +20,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
       description:
         'Disallow the use of promises passed to a `fireEvent` method',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: 'error',
         angular: 'error',
         react: 'error',
diff --git a/lib/rules/no-render-in-setup.ts b/lib/rules/no-render-in-setup.ts
@@ -50,7 +50,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
       description:
         'Disallow the use of `render` in testing frameworks setup functions',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: false,
         angular: false,
         react: false,
diff --git a/lib/rules/no-wait-for-empty-callback.ts b/lib/rules/no-wait-for-empty-callback.ts
@@ -18,7 +18,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
       description:
         "It's preferred to avoid empty callbacks in `waitFor` and `waitForElementToBeRemoved`",
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: 'error',
         angular: 'error',
         react: 'error',
diff --git a/lib/rules/no-wait-for-multiple-assertions.ts b/lib/rules/no-wait-for-multiple-assertions.ts
@@ -16,7 +16,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: "It's preferred to avoid multiple assertions in `waitFor`",
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: false,
         angular: false,
         react: false,
diff --git a/lib/rules/no-wait-for-side-effects.ts b/lib/rules/no-wait-for-side-effects.ts
@@ -16,7 +16,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: "It's preferred to avoid side effects in `waitFor`",
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: false,
         angular: false,
         react: false,
diff --git a/lib/rules/no-wait-for-snapshot.ts b/lib/rules/no-wait-for-snapshot.ts
@@ -19,7 +19,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
       description:
         'Ensures no snapshot is generated inside of a `waitFor` call',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: false,
         angular: false,
         react: false,
diff --git a/lib/rules/prefer-explicit-assert.ts b/lib/rules/prefer-explicit-assert.ts
@@ -25,7 +25,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
       description:
         'Suggest using explicit assertions rather than just `getBy*` queries',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: false,
         angular: false,
         react: false,
diff --git a/lib/rules/prefer-find-by.ts b/lib/rules/prefer-find-by.ts
@@ -56,7 +56,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
       description:
         'Suggest using `find*` query instead of `waitFor` + `get*` to wait for elements',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: 'error',
         angular: 'error',
         react: 'error',
diff --git a/lib/rules/prefer-presence-queries.ts b/lib/rules/prefer-presence-queries.ts
@@ -13,7 +13,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
       category: 'Best Practices',
       description:
         'Ensure appropriate get*/query* queries are used with their respective matchers',
-      recommended: {
+      recommendedConfig: {
         dom: false,
         angular: false,
         react: false,
diff --git a/lib/rules/prefer-screen-queries.ts b/lib/rules/prefer-screen-queries.ts
@@ -37,7 +37,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Suggest using screen while querying',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: 'error',
         angular: 'error',
         react: 'error',
diff --git a/lib/rules/prefer-user-event.ts b/lib/rules/prefer-user-event.ts
@@ -66,7 +66,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Suggest using userEvent over fireEvent',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: false,
         angular: false,
         react: false,
diff --git a/lib/rules/prefer-wait-for.ts b/lib/rules/prefer-wait-for.ts
@@ -26,7 +26,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Use `waitFor` instead of deprecated wait methods',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: false,
         angular: false,
         react: false,
diff --git a/lib/rules/render-result-naming-convention.ts b/lib/rules/render-result-naming-convention.ts
@@ -24,7 +24,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Enforce a valid naming for return value from `render`',
       category: 'Best Practices',
-      recommended: {
+      recommendedConfig: {
         dom: false,
         angular: 'error',
         react: 'error',
diff --git a/lib/utils/types.ts b/lib/utils/types.ts
@@ -10,7 +10,10 @@ type TestingLibraryRuleMetaDocs<TOptions extends readonly unknown[]> = Omit<
   TSESLint.RuleMetaDataDocs,
   'recommended' | 'url'
 > & {
-  recommended: Record<SupportedTestingFramework, RecommendedConfig<TOptions>>;
+  recommendedConfig: Record<
+    SupportedTestingFramework,
+    RecommendedConfig<TOptions>
+  >;
 };
 export type TestingLibraryRuleMeta<
   TMessageIds extends string,
diff --git a/tools/generate-configs/index.ts b/tools/generate-configs/index.ts
@@ -14,11 +14,14 @@ const getRecommendedRulesForTestingFramework = (
 ): LinterConfigRules =>
   Object.entries(rules)
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    .filter(([_, { meta: { docs } }]) => Boolean(docs.recommended[framework]))
+    .filter(([_, { meta: { docs } }]) =>
+      Boolean(docs.recommendedConfig[framework])
+    )
     .reduce(
       (allRules, [ruleName, { meta }]) => ({
         ...allRules,
-        [ruleName.split(RULE_NAME_PREFIX)[0]]: meta.docs.recommended[framework],
+        [ruleName.split(RULE_NAME_PREFIX)[0]]:
+          meta.docs.recommendedConfig[framework],
       }),
       {}
     );
