Configuration

ESLint React provides the following configurations:

Settings

importSource

(type: string, default: "react")

The source where React is imported from.
This allows to specify a custom import location for React when not using the official distribution (e.g. @pika/react, etc).

jsxPragma

(type: string, default: "createElement")

The identifier that’s used for JSX Element creation.
This should not be a member expression (i.e. use "createElement" instead of "React.createElement").

jsxPragmaFrag

(type: string, default: "Fragment")

The identifier that’s used for JSX fragment elements.
This should not be a member expression (i.e. use "Fragment" instead of "React.Fragment").

version

(type: string, default: "detect")

React version to use, "detect" means auto detect React version from the project’s dependencies.
If importSource is specified, an equivalent version of React should be provided here.

polymorphicPropName

(type: string)

You can optionally use the polymorphicPropName setting to define the prop your code uses to create polymorphic components. This setting will be used determine the element type in rules that require semantic context.

For example, if you set the polymorphicPropName setting to as then this element:

<Box as="h3">Configurations </Box>

will be evaluated as an h3. If no polymorphicPropName is set, then the component will be evaluated as Box.

additionalHooks

(type: [key: string]: string[])

A object of aliases for React built-in hooks. ESLint React will recognize these aliases as equivalent to the built-in hooks in all its rules.

(e.g. { useLayoutEffect: ["useIsomorphicLayoutEffect"] }).

additionalComponents

(type: { name: string; as: string; attributes: { name: string; as?: string; defaultValue?: string }[] }[])

An array of user-defined components, used to inform the ESLint React plugins how to treat these components during checks.

Examples

import react from "@eslint-react/eslint-plugin";
 
export default [
  // ...
  {
    files: ["**/*.{ts,tsx}"],
    ...react.configs.recommended,
    settings: {
      "react-x": {
        importSource: "react",
        jsxPragma: "createElement",
        jsxPragmaFrag: "Fragment",
        additionalHooks: {
          useLayoutEffect: ["useIsomorphicLayoutEffect"],
        },
        additionalComponents: [
          {
            name: "Link",
            as: "a",
            attributes: [
              { name: "to", as: "href" },
              { name: "rel", defaultValue: "noopener noreferrer" },
            ],
          },
        ],
        version: "detect",
      },
    },
  },
];

module.exports = {
  // ...
  settings: {
    "react-x": {
      importSource: "react",
      jsxPragma: "createElement",
      jsxPragmaFrag: "Fragment",
      additionalHooks: {
        useLayoutEffect: ["useIsomorphicLayoutEffect"],
      },
      additionalComponents: [
        {
          name: "Link",
          as: "a",
          attributes: [
            { name: "to", as: "href" },
            { name: "rel", defaultValue: "noopener noreferrer" },
          ],
        },
      ],
      version: "detect",
    },
  },
};