Add support for React (#193)

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

Author: azat-io

package.json

@@ -75,6 +75,7 @@
     "eslint-plugin-node": "~11.1.0",
     "eslint-plugin-prettier": "~4.2.1",
     "eslint-plugin-promise": "~6.1.1",
+    "eslint-plugin-react": "~7.32.2",
     "eslint-plugin-sonarjs": "~0.19.0",
     "eslint-plugin-spellcheck": "~0.0.20",
     "eslint-plugin-unicorn": "~46.0.0",

pnpm-lock.yaml

@@ -0,0 +1,23 @@
+diff --git a/src/rules/react/jsx-no-constructed-context-values.d.ts b/src/rules/react/jsx-no-constructed-context-values.d.ts
+index 410f060..e356693 100644
+--- a/src/rules/react/jsx-no-constructed-context-values.d.ts
++++ b/src/rules/react/jsx-no-constructed-context-values.d.ts
+@@ -1,17 +1,9 @@
+ import type { RuleConfig } from '../rule-config';
+ 
+-/**
+- * Option.
+- */
+-export interface JsxNoConstructedContextValuesOption {
+-  [k: string]: any;
+-}
+-
+ /**
+  * Options.
+  */
+-export type JsxNoConstructedContextValuesOptions =
+-  JsxNoConstructedContextValuesOption;
++export type JsxNoConstructedContextValuesOptions = [];
+ 
+ /**
+  * Disallows JSX context provider values from taking values that will cause needless rerenders.

scripts/generate-rule-files/diffs/rules/react/jsx-no-constructed-context-values.d.ts.diff

@@ -0,0 +1,13 @@
+diff --git a/src/rules/react/jsx-props-no-spreading.d.ts b/src/rules/react/jsx-props-no-spreading.d.ts
+index c1e0069..ba1e1bc 100644
+--- a/src/rules/react/jsx-props-no-spreading.d.ts
++++ b/src/rules/react/jsx-props-no-spreading.d.ts
+@@ -8,8 +8,6 @@ export type JsxPropsNoSpreadingOption = {
+   custom?: 'enforce' | 'ignore';
+   exceptions?: string[];
+   [k: string]: any;
+-} & {
+-  [k: string]: any;
+ };
+ 
+ /**

scripts/generate-rule-files/diffs/rules/react/jsx-props-no-spreading.d.ts.diff

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

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

@@ -0,0 +1,9 @@
+/**
+ * Eslint React extensions.
+ *
+ * @see [Eslint React extensions](https://github.com/jsx-eslint/eslint-plugin-react)
+ */
+export type ReactExtensions =
+  | 'plugin:react/all'
+  | 'plugin:react/jsx-runtime'
+  | 'plugin:react/recommended';

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

@@ -10,6 +10,7 @@ import type { NExtensions } from './eslint-plugin-n';
 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 { SonarjsExtensions } from './eslint-plugin-sonarjs';
 import type { UnicornExtensions } from './eslint-plugin-unicorn';
 import type { VitestExtensions } from './eslint-plugin-vitest';
@@ -34,6 +35,7 @@ export type KnownExtensions = LiteralUnion<
   | NodeExtensions
   | PrettierExtensions
   | PromiseExtensions
+  | ReactExtensions
   | SonarjsExtensions
   | TypescriptEslintExtensions
   | UnicornExtensions

src/config/extends/index.d.ts

@@ -11,6 +11,7 @@ export type Plugin = LiteralUnion<
   | 'mdx'
   | 'prettier'
   | 'promise'
+  | 'react'
   | 'sonarjs'
   | 'spellcheck'
   | 'unicorn'

src/config/plugin.d.ts

@@ -2,6 +2,7 @@ import type { ImportSettings } from './import';
 import type { JSDocSettings } from './jsdoc';
 import type { MdxSettings } from './mdx';
 import type { NodeSettings } from './node';
+import type { ReactSettings } from './react';
 
 /**
  * Settings.
@@ -11,4 +12,5 @@ export interface Settings
     JSDocSettings,
     MdxSettings,
     NodeSettings,
+    ReactSettings,
     Partial<Record<string, unknown>> {}

src/config/settings/index.d.ts

@@ -0,0 +1,101 @@
+import type { LiteralUnion } from '../../utility-types';
+
+/**
+ * React settings.
+ *
+ * @see [React settings](https://github.com/jsx-eslint/eslint-plugin-react)
+ */
+export interface ReactSettings extends Partial<Record<string, unknown>> {
+  react?: {
+    /**
+     * Regex for Component Factory to use.
+     *
+     * @default 'createReactClass'
+     */
+    createClass?: LiteralUnion<'createReactClass'>;
+
+    /**
+     * Pragma to use.
+     *
+     * @default 'React'
+     */
+    pragma?: LiteralUnion<'React'>;
+
+    /**
+     * Fragment to use (may be a property of <pragma>).
+     *
+     * @default 'Fragment'
+     */
+    fragment?: LiteralUnion<'Fragment'>;
+
+    /**
+     * React version. "detect" automatically picks the version you have installed.
+     *
+     * You can also use `16.0`, `16.3`, etc, if you want to override the detected value.
+     *
+     * It will default to "latest" and warn if missing, and to "detect" in the future.
+     *
+     * @default 'latest'
+     */
+    version?: LiteralUnion<'latest' | 'detect'>;
+
+    /**
+     * Flow version.
+     */
+    flowVersion?: string;
+  };
+
+  /**
+   * The names of any function used to wrap propTypes, e.g. `forbidExtraProps`.
+   *
+   * If this isn't set, any propTypes wrapped in a function will be skipped.
+   */
+  propWrapperFunctions?: Array<
+    | string
+    | {
+        property: string;
+        object?: string;
+        /**
+         * For rules that check exact prop wrappers.
+         */
+        exact?: boolean;
+        [k: string]: any;
+      }
+  >;
+
+  /**
+   * The name of any function used to wrap components, e.g. Mobx `observer` function.
+   *
+   * If this isn't set, components wrapped by these functions will be skipped.
+   */
+  componentWrapperFunctions?: Array<
+    | string
+    | {
+        property: string;
+        object?: string;
+        [k: string]: any;
+      }
+  >;
+
+  /**
+   * Components used as alternatives to <form> for forms, eg. <Form endpoint={ url } />.
+   */
+  formComponents?: Array<
+    | string
+    | {
+        name: string;
+        formAttribute: string;
+      }
+  >;
+
+  /**
+   * Components used as alternatives to <a> for linking, eg. <Link to={ url } />.
+   */
+  linkComponents?: Array<
+    | string
+    | {
+        name: string;
+        linkAttribute: string;
+      }
+  >;
+}