eslint-plugin-react-naming-convention/README.md

ESLint React's ESLint plugin for naming convention related rules.

# eslint-plugin-react-naming-convention

Naming convention rules.

## Install

```sh
# npm
npm install --save-dev eslint-plugin-react-naming-convention
```

## Setup

```ts
import js from "@eslint/js";
import reactNamingConvention from "eslint-plugin-react-naming-convention";
import { defineConfig } from "eslint/config";
import tseslint from "typescript-eslint";

export default defineConfig(
  {
    files: ["**/*.{ts,tsx}"],
    extends: [
      js.configs.recommended,
      tseslint.configs.recommended,
      // Add configs from eslint-plugin-react-naming-convention
      reactNamingConvention.configs.recommended,
    ],
    rules: {
      // Put rules you want to override here
      "react-naming-convention/context-name": "warn",
    },
  },
);
```

## Rules

<https://eslint-react.xyz/docs/rules#naming-convention-rules>