Add support for Testing library (#195)

Co-authored-by: Shinigami92 <[email protected]>

Author: azat-io

package.json

@@ -80,6 +80,7 @@
     "eslint-plugin-react-hooks": "~4.6.0",
     "eslint-plugin-sonarjs": "~0.19.0",
     "eslint-plugin-spellcheck": "~0.0.20",
+    "eslint-plugin-testing-library": "~5.10.3",
     "eslint-plugin-unicorn": "~46.0.0",
     "eslint-plugin-vitest": "~0.1.4",
     "eslint-plugin-vue": "~9.11.0",

pnpm-lock.yaml

@@ -76,6 +76,10 @@ export const PLUGIN_REGISTRY: Readonly<Record<string, Plugin>> = {
     name: 'Spellcheck',
     module: 'eslint-plugin-spellcheck',
   },
+  'testing-library': {
+    name: 'TestingLibrary',
+    module: 'eslint-plugin-testing-library',
+  },
   unicorn: {
     name: 'Unicorn',
     module: 'eslint-plugin-unicorn',

scripts/generate-rule-files/src/plugins-map.ts

@@ -0,0 +1,11 @@
+/**
+ * Eslint TestingLibrary extensions.
+ *
+ * @see [Eslint TestingLibrary extensions](https://github.com/testing-library/eslint-plugin-testing-library)
+ */
+export type TestingLibraryExtensions =
+  | 'plugin:testing-library/angular'
+  | 'plugin:testing-library/dom'
+  | 'plugin:testing-library/marko'
+  | 'plugin:testing-library/react'
+  | 'plugin:testing-library/vue';

src/config/extends/eslint-plugin-testing-library.d.ts

@@ -13,6 +13,7 @@ import type { PromiseExtensions } from './eslint-plugin-promise';
 import type { ReactExtensions } from './eslint-plugin-react';
 import type { ReactHooksExtensions } from './eslint-plugin-react-hooks';
 import type { SonarjsExtensions } from './eslint-plugin-sonarjs';
+import type { TestingLibraryExtensions } from './eslint-plugin-testing-library';
 import type { UnicornExtensions } from './eslint-plugin-unicorn';
 import type { VitestExtensions } from './eslint-plugin-vitest';
 import type { VueExtensions } from './eslint-plugin-vue';
@@ -39,6 +40,7 @@ export type KnownExtensions = LiteralUnion<
   | ReactExtensions
   | ReactHooksExtensions
   | SonarjsExtensions
+  | TestingLibraryExtensions
   | TypescriptEslintExtensions
   | UnicornExtensions
   | VitestExtensions

src/config/extends/index.d.ts

@@ -16,6 +16,7 @@ export type Plugin = LiteralUnion<
   | 'react'
   | 'sonarjs'
   | 'spellcheck'
+  | 'testing-library'
   | 'unicorn'
   | 'vitest'
   | 'vue'

src/config/plugin.d.ts

@@ -0,0 +1,24 @@
+import type { LiteralUnion } from '../../utility-types';
+
+/**
+ * Testing Library settings.
+ *
+ * @see [Testing Library settings](https://github.com/testing-library/eslint-plugin-testing-library)
+ */
+export interface TestingLibrarySettings
+  extends Partial<Record<string, unknown>> {
+  /**
+   * @see [testing-library/custom-queries](https://github.com/testing-library/eslint-plugin-testing-library#testing-librarycustom-queries)
+   */
+  'testing-library/custom-queries'?: 'off' | string[];
+
+  /**
+   * @see [testing-library/custom-renders](https://github.com/testing-library/eslint-plugin-testing-library#testing-librarycustom-renders)
+   */
+  'testing-library/custom-renders'?: 'off' | string[];
+
+  /**
+   * @see [testing-library/utils-module](https://github.com/testing-library/eslint-plugin-testing-library#testing-libraryutils-module)
+   */
+  'testing-library/utils-module'?: LiteralUnion<'off'>;
+}

src/config/settings/testing-library.d.ts

@@ -14,6 +14,7 @@ import type { ReactHooksRules } from './react-hooks';
 import type { RuleConfig } from './rule-config';
 import type { SonarJSRules } from './sonarjs';
 import type { SpellcheckRules } from './spellcheck';
+import type { TestingLibraryRules } from './testing-library';
 import type { TypeScriptRules } from './typescript-eslint';
 import type { UnicornRules } from './unicorn';
 import type { VitestRules } from './vitest';
@@ -42,6 +43,7 @@ export type Rules = Partial<
     ReactRules &
     SonarJSRules &
     SpellcheckRules &
+    TestingLibraryRules &
     TypeScriptRules &
     UnicornRules &
     VitestRules &

src/rules/index.d.ts

@@ -0,0 +1,22 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ * Enforce promises from async queries to be handled.
+ *
+ * @see [await-async-query](https://github.com/testing-library/eslint-plugin-testing-library/tree/main/docs/rules/await-async-query.md)
+ */
+export type AwaitAsyncQueryRuleConfig = RuleConfig<[]>;
+
+/**
+ * Enforce promises from async queries to be handled.
+ *
+ * @see [await-async-query](https://github.com/testing-library/eslint-plugin-testing-library/tree/main/docs/rules/await-async-query.md)
+ */
+export interface AwaitAsyncQueryRule {
+  /**
+   * Enforce promises from async queries to be handled.
+   *
+   * @see [await-async-query](https://github.com/testing-library/eslint-plugin-testing-library/tree/main/docs/rules/await-async-query.md)
+   */
+  'testing-library/await-async-query': AwaitAsyncQueryRuleConfig;
+}

src/rules/testing-library/await-async-query.d.ts

@@ -0,0 +1,22 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ * Enforce promises from async utils to be awaited properly.
+ *
+ * @see [await-async-utils](https://github.com/testing-library/eslint-plugin-testing-library/tree/main/docs/rules/await-async-utils.md)
+ */
+export type AwaitAsyncUtilsRuleConfig = RuleConfig<[]>;
+
+/**
+ * Enforce promises from async utils to be awaited properly.
+ *
+ * @see [await-async-utils](https://github.com/testing-library/eslint-plugin-testing-library/tree/main/docs/rules/await-async-utils.md)
+ */
+export interface AwaitAsyncUtilsRule {
+  /**
+   * Enforce promises from async utils to be awaited properly.
+   *
+   * @see [await-async-utils](https://github.com/testing-library/eslint-plugin-testing-library/tree/main/docs/rules/await-async-utils.md)
+   */
+  'testing-library/await-async-utils': AwaitAsyncUtilsRuleConfig;
+}