Add support for react-hooks (#194)

Co-authored-by: Shinigami92 <chrissi92@hotmail.de>

package.json

@@ -76,6 +76,7 @@
     "eslint-plugin-prettier": "~4.2.1",
     "eslint-plugin-promise": "~6.1.1",
     "eslint-plugin-react": "~7.32.2",
+    "eslint-plugin-react-hooks": "~4.6.0",
     "eslint-plugin-sonarjs": "~0.19.0",
     "eslint-plugin-spellcheck": "~0.0.20",
     "eslint-plugin-unicorn": "~46.0.0",

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

@@ -59,6 +59,10 @@ export const PLUGIN_REGISTRY: Readonly<Record<string, Plugin>> = {
     name: 'React',
     module: 'eslint-plugin-react',
   },
+  'react-hooks': {
+    name: 'ReactHooks',
+    module: 'eslint-plugin-react-hooks',
+  },
   sonarjs: {
     name: 'SonarJS',
     prefix: 'sonarjs',

src/config/extends/eslint-plugin-react-hooks.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Eslint ReactHooks extensions.
+ *
+ * @see [Eslint ReactHooks extensions](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks)
+ */
+export type ReactHooksExtensions = 'plugin:react-hooks/recommended';

src/config/extends/index.d.ts

@@ -11,6 +11,7 @@ import type { NodeExtensions } from './eslint-plugin-node';
 import type { PrettierExtensions } from './eslint-plugin-prettier';
 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 { UnicornExtensions } from './eslint-plugin-unicorn';
 import type { VitestExtensions } from './eslint-plugin-vitest';
@@ -36,6 +37,7 @@ export type KnownExtensions = LiteralUnion<
   | PrettierExtensions
   | PromiseExtensions
   | ReactExtensions
+  | ReactHooksExtensions
   | SonarjsExtensions
   | TypescriptEslintExtensions
   | UnicornExtensions

src/rules/index.d.ts

@@ -9,6 +9,7 @@ import type { NRules } from './n';
 import type { NodeRules } from './node';
 import type { PromiseRules } from './promise';
 import type { ReactRules } from './react';
+import type { ReactHooksRules } from './react-hooks';
 import type { RuleConfig } from './rule-config';
 import type { SonarJSRules } from './sonarjs';
 import type { SpellcheckRules } from './spellcheck';
@@ -35,6 +36,7 @@ export type Rules = Partial<
     NodeRules &
     NRules &
     PromiseRules &
+    ReactHooksRules &
     ReactRules &
     SonarJSRules &
     SpellcheckRules &

src/rules/react-hooks/exhaustive-deps.d.ts

@@ -0,0 +1,35 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ * Option.
+ */
+export interface ExhaustiveDepsOption {
+  additionalHooks?: string;
+  enableDangerousAutofixThisMayCauseInfiniteLoops?: boolean;
+}
+
+/**
+ * Options.
+ */
+export type ExhaustiveDepsOptions = [ExhaustiveDepsOption?];
+
+/**
+ * Verifies the list of dependencies for Hooks like useEffect and similar.
+ *
+ * @see [exhaustive-deps](https://github.com/facebook/react/issues/14920)
+ */
+export type ExhaustiveDepsRuleConfig = RuleConfig<ExhaustiveDepsOptions>;
+
+/**
+ * Verifies the list of dependencies for Hooks like useEffect and similar.
+ *
+ * @see [exhaustive-deps](https://github.com/facebook/react/issues/14920)
+ */
+export interface ExhaustiveDepsRule {
+  /**
+   * Verifies the list of dependencies for Hooks like useEffect and similar.
+   *
+   * @see [exhaustive-deps](https://github.com/facebook/react/issues/14920)
+   */
+  'react-hooks/exhaustive-deps': ExhaustiveDepsRuleConfig;
+}

src/rules/react-hooks/index.d.ts

@@ -0,0 +1,7 @@
+import type { ExhaustiveDepsRule } from './exhaustive-deps';
+import type { RulesOfHooksRule } from './rules-of-hooks';
+
+/**
+ * All ReactHooks rules.
+ */
+export type ReactHooksRules = RulesOfHooksRule & ExhaustiveDepsRule;

src/rules/react-hooks/rules-of-hooks.d.ts

@@ -0,0 +1,22 @@
+import type { RuleConfig } from '../rule-config';
+
+/**
+ * Enforces the Rules of Hooks.
+ *
+ * @see [rules-of-hooks](https://reactjs.org/docs/hooks-rules.html)
+ */
+export type RulesOfHooksRuleConfig = RuleConfig<[]>;
+
+/**
+ * Enforces the Rules of Hooks.
+ *
+ * @see [rules-of-hooks](https://reactjs.org/docs/hooks-rules.html)
+ */
+export interface RulesOfHooksRule {
+  /**
+   * Enforces the Rules of Hooks.
+   *
+   * @see [rules-of-hooks](https://reactjs.org/docs/hooks-rules.html)
+   */
+  'react-hooks/rules-of-hooks': RulesOfHooksRuleConfig;
+}