fix: make rules comply with TestingLibraryRuleMeta

MichaelDeBoey · MichaelDeBoey · commit 66fc3804fbfc · 2021-04-27T19:42:18.000+02:00
diff --git a/lib/create-testing-library-rule/index.ts b/lib/create-testing-library-rule/index.ts
@@ -19,7 +19,7 @@ export function createTestingLibraryRule<
   ...remainingConfig
 }: Readonly<{
   name: string;
-  meta: TestingLibraryRuleMeta<TMessageIds>;
+  meta: TestingLibraryRuleMeta<TMessageIds, TOptions>;
   defaultOptions: Readonly<TOptions>;
   detectionOptions?: Partial<DetectionOptions>;
   create: EnhancedRuleCreate<TOptions, TMessageIds, TRuleListener>;
diff --git a/lib/rules/await-async-query.ts b/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',
+      recommended: {
+        dom: 'error',
+        angular: 'error',
+        react: 'error',
+        vue: 'error',
+      },
     },
     messages: {
       awaitAsyncQuery: 'promise returned from {{ name }} query must be handled',
diff --git a/lib/rules/await-async-utils.ts b/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',
+      recommended: {
+        dom: 'error',
+        angular: 'error',
+        react: 'error',
+        vue: 'error',
+      },
     },
     messages: {
       awaitAsyncUtil: 'Promise returned from `{{ name }}` must be handled',
diff --git a/lib/rules/await-fire-event.ts b/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,
+      recommended: {
+        dom: false,
+        angular: false,
+        react: false,
+        vue: 'error',
+      },
     },
     messages: {
       awaitFireEvent:
diff --git a/lib/rules/consistent-data-testid.ts b/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,
+      recommended: {
+        dom: false,
+        angular: false,
+        react: false,
+        vue: false,
+      },
     },
     messages: {
       consistentDataTestId: '`{{attr}}` "{{value}}" should match `{{regex}}`',
diff --git a/lib/rules/index.ts b/lib/rules/index.ts
@@ -6,7 +6,7 @@ import { TSESLint } from '@typescript-eslint/experimental-utils';
 import { importDefault, TestingLibraryRuleMeta } from '../utils';
 
 type RuleModule = TSESLint.RuleModule<string, unknown[]> & {
-  meta: TestingLibraryRuleMeta<string>;
+  meta: TestingLibraryRuleMeta<string, unknown[]>;
 };
 
 const rulesDir = __dirname;
diff --git a/lib/rules/no-await-sync-events.ts b/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',
+      recommended: {
+        dom: false,
+        angular: false,
+        react: false,
+        vue: false,
+      },
     },
     messages: {
       noAwaitSyncEvents:
diff --git a/lib/rules/no-await-sync-query.ts b/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',
+      recommended: {
+        dom: 'error',
+        angular: 'error',
+        react: 'error',
+        vue: 'error',
+      },
     },
     messages: {
       noAwaitSyncQuery:
diff --git a/lib/rules/no-container.ts b/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',
+      recommended: {
+        dom: false,
+        angular: 'error',
+        react: 'error',
+        vue: 'error',
+      },
     },
     messages: {
       noContainer:
diff --git a/lib/rules/no-debug.ts b/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',
+      recommended: {
+        dom: false,
+        angular: 'error',
+        react: 'error',
+        vue: 'error',
+      },
     },
     messages: {
       noDebug: 'Unexpected debug statement',
diff --git a/lib/rules/no-dom-import.ts b/lib/rules/no-dom-import.ts
@@ -18,7 +18,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Disallow importing from DOM Testing Library',
       category: 'Best Practices',
-      recommended: false,
+      recommended: {
+        dom: false,
+        angular: ['error', 'angular'],
+        react: ['error', 'react'],
+        vue: ['error', 'vue'],
+      },
     },
     messages: {
       noDomImport:
diff --git a/lib/rules/no-manual-cleanup.ts b/lib/rules/no-manual-cleanup.ts
@@ -28,7 +28,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Disallow the use of `cleanup`',
       category: 'Best Practices',
-      recommended: false,
+      recommended: {
+        dom: false,
+        angular: false,
+        react: false,
+        vue: false,
+      },
     },
     messages: {
       noManualCleanup:
diff --git a/lib/rules/no-node-access.ts b/lib/rules/no-node-access.ts
@@ -13,7 +13,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Disallow direct Node access',
       category: 'Best Practices',
-      recommended: 'error',
+      recommended: {
+        dom: false,
+        angular: 'error',
+        react: 'error',
+        vue: 'error',
+      },
     },
     messages: {
       noNodeAccess:
diff --git a/lib/rules/no-promise-in-fire-event.ts b/lib/rules/no-promise-in-fire-event.ts
@@ -20,7 +20,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
       description:
         'Disallow the use of promises passed to a `fireEvent` method',
       category: 'Best Practices',
-      recommended: false,
+      recommended: {
+        dom: 'error',
+        angular: 'error',
+        react: 'error',
+        vue: 'error',
+      },
     },
     messages: {
       noPromiseInFireEvent:
diff --git a/lib/rules/no-render-in-setup.ts b/lib/rules/no-render-in-setup.ts
@@ -50,7 +50,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
       description:
         'Disallow the use of `render` in testing frameworks setup functions',
       category: 'Best Practices',
-      recommended: false,
+      recommended: {
+        dom: false,
+        angular: false,
+        react: false,
+        vue: false,
+      },
     },
     messages: {
       noRenderInSetup:
diff --git a/lib/rules/no-wait-for-empty-callback.ts b/lib/rules/no-wait-for-empty-callback.ts
@@ -18,7 +18,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
       description:
         "It's preferred to avoid empty callbacks in `waitFor` and `waitForElementToBeRemoved`",
       category: 'Best Practices',
-      recommended: 'error',
+      recommended: {
+        dom: 'error',
+        angular: 'error',
+        react: 'error',
+        vue: 'error',
+      },
     },
     messages: {
       noWaitForEmptyCallback:
diff --git a/lib/rules/no-wait-for-multiple-assertions.ts b/lib/rules/no-wait-for-multiple-assertions.ts
@@ -16,7 +16,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: "It's preferred to avoid multiple assertions in `waitFor`",
       category: 'Best Practices',
-      recommended: false,
+      recommended: {
+        dom: false,
+        angular: false,
+        react: false,
+        vue: false,
+      },
     },
     messages: {
       noWaitForMultipleAssertion:
diff --git a/lib/rules/no-wait-for-side-effects.ts b/lib/rules/no-wait-for-side-effects.ts
@@ -16,7 +16,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: "It's preferred to avoid side effects in `waitFor`",
       category: 'Best Practices',
-      recommended: false,
+      recommended: {
+        dom: false,
+        angular: false,
+        react: false,
+        vue: false,
+      },
     },
     messages: {
       noSideEffectsWaitFor:
diff --git a/lib/rules/no-wait-for-snapshot.ts b/lib/rules/no-wait-for-snapshot.ts
@@ -19,7 +19,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
       description:
         'Ensures no snapshot is generated inside of a `waitFor` call',
       category: 'Best Practices',
-      recommended: 'warn',
+      recommended: {
+        dom: false,
+        angular: false,
+        react: false,
+        vue: false,
+      },
     },
     messages: {
       noWaitForSnapshot:
diff --git a/lib/rules/prefer-explicit-assert.ts b/lib/rules/prefer-explicit-assert.ts
@@ -25,7 +25,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
       description:
         'Suggest using explicit assertions rather than just `getBy*` queries',
       category: 'Best Practices',
-      recommended: false,
+      recommended: {
+        dom: false,
+        angular: false,
+        react: false,
+        vue: false,
+      },
     },
     messages: {
       preferExplicitAssert:
diff --git a/lib/rules/prefer-find-by.ts b/lib/rules/prefer-find-by.ts
@@ -56,7 +56,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
       description:
         'Suggest using `find*` query instead of `waitFor` + `get*` to wait for elements',
       category: 'Best Practices',
-      recommended: 'warn',
+      recommended: {
+        dom: 'error',
+        angular: 'error',
+        react: 'error',
+        vue: 'error',
+      },
     },
     messages: {
       preferFindBy:
diff --git a/lib/rules/prefer-presence-queries.ts b/lib/rules/prefer-presence-queries.ts
@@ -13,7 +13,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
       category: 'Best Practices',
       description:
         'Ensure appropriate get*/query* queries are used with their respective matchers',
-      recommended: 'error',
+      recommended: {
+        dom: false,
+        angular: false,
+        react: false,
+        vue: false,
+      },
     },
     messages: {
       wrongPresenceQuery:
diff --git a/lib/rules/prefer-screen-queries.ts b/lib/rules/prefer-screen-queries.ts
@@ -37,7 +37,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Suggest using screen while querying',
       category: 'Best Practices',
-      recommended: 'error',
+      recommended: {
+        dom: 'error',
+        angular: 'error',
+        react: 'error',
+        vue: 'error',
+      },
     },
     messages: {
       preferScreenQueries:
diff --git a/lib/rules/prefer-user-event.ts b/lib/rules/prefer-user-event.ts
@@ -66,7 +66,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Suggest using userEvent over fireEvent',
       category: 'Best Practices',
-      recommended: 'warn',
+      recommended: {
+        dom: false,
+        angular: false,
+        react: false,
+        vue: false,
+      },
     },
     messages: {
       preferUserEvent:
diff --git a/lib/rules/prefer-wait-for.ts b/lib/rules/prefer-wait-for.ts
@@ -26,7 +26,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Use `waitFor` instead of deprecated wait methods',
       category: 'Best Practices',
-      recommended: false,
+      recommended: {
+        dom: false,
+        angular: false,
+        react: false,
+        vue: false,
+      },
     },
     messages: {
       preferWaitForMethod:
diff --git a/lib/rules/render-result-naming-convention.ts b/lib/rules/render-result-naming-convention.ts
@@ -24,7 +24,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
     docs: {
       description: 'Enforce a valid naming for return value from `render`',
       category: 'Best Practices',
-      recommended: false,
+      recommended: {
+        dom: false,
+        angular: 'error',
+        react: 'error',
+        vue: 'error',
+      },
     },
     messages: {
       renderResultNamingConvention: `\`{{ renderResultName }}\` is not a recommended name for \`render\` returned value. Instead, you should destructure it, or name it using one of: ${ALLOWED_VAR_NAMES_TEXT}`,
diff --git a/lib/utils/types.ts b/lib/utils/types.ts
@@ -1,18 +1,22 @@
 import type { TSESLint } from '@typescript-eslint/experimental-utils';
 
+type RecommendedConfig<TOptions extends readonly unknown[]> =
+  | TSESLint.RuleMetaDataDocs['recommended']
+  | [TSESLint.RuleMetaDataDocs['recommended'], ...TOptions];
+
 // These 2 types are copied from @typescript-eslint/experimental-utils' CreateRuleMeta
 // and modified to our needs
-type TestingLibraryRuleMetaDocs = Omit<
+type TestingLibraryRuleMetaDocs<TOptions extends readonly unknown[]> = Omit<
   TSESLint.RuleMetaDataDocs,
   'recommended' | 'url'
 > & {
-  recommended: Record<
-    SupportedTestingFramework,
-    TSESLint.RuleMetaDataDocs['recommended']
-  >;
+  recommended: Record<SupportedTestingFramework, RecommendedConfig<TOptions>>;
 };
-export type TestingLibraryRuleMeta<TMessageIds extends string> = {
-  docs: TestingLibraryRuleMetaDocs;
+export type TestingLibraryRuleMeta<
+  TMessageIds extends string,
+  TOptions extends readonly unknown[]
+> = {
+  docs: TestingLibraryRuleMetaDocs<TOptions>;
 } & Omit<TSESLint.RuleMetaData<TMessageIds>, 'docs'>;
 
 export const SUPPORTED_TESTING_FRAMEWORKS = [
