eslint-plugin-react-naming-convention

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

  • Types
  • ESM
License
MIT
Install Size
9.4 kB(8.3 MB)
Vulns
0
Published

Get started

$npm install eslint-plugin-react-naming-convention
$pnpm add eslint-plugin-react-naming-convention
$yarn add eslint-plugin-react-naming-convention
$bun add eslint-plugin-react-naming-convention
$deno add npm:eslint-plugin-react-naming-convention
$vlt install eslint-plugin-react-naming-convention
$vp add eslint-plugin-react-naming-convention
# Usually installed as a dev dependency
$npm install -D eslint-plugin-react-naming-convention
$pnpm add -D eslint-plugin-react-naming-convention
$yarn add -D eslint-plugin-react-naming-convention
$bun add -d eslint-plugin-react-naming-convention
$deno add -D npm:eslint-plugin-react-naming-convention
$vlt install -D eslint-plugin-react-naming-convention
$vp add -D eslint-plugin-react-naming-convention

Readme

eslint-plugin-react-naming-convention

Naming convention rules.

Install

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

Setup

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/overview#naming-convention-rules