fix: minor fixes & improvements example eslint configs (#1065)

Author: Rel1cx

README.md

@@ -75,21 +75,31 @@ import tseslint from "typescript-eslint";
 
 export default tseslint.config({
   files: ["**/*.ts", "**/*.tsx"],
+
+  // Extend recommended rule sets from:
+  // 1. ESLint JS's recommended rules
+  // 2. TypeScript ESLint recommended rules
+  // 3. ESLint React's recommended-typescript rules
   extends: [
     eslintJs.configs.recommended,
     tseslint.configs.recommended,
     eslintReact.configs["recommended-typescript"],
   ],
+
+  // Configure language/parsing options
   languageOptions: {
+    // Use TypeScript ESLint parser for TypeScript files
     parser: tseslint.parser,
     parserOptions: {
+      // Enable project service for better TypeScript integration
       projectService: true,
       tsconfigRootDir: import.meta.dirname,
     },
   },
+
+  // Custom rule overrides (modify rule levels or disable rules)
   rules: {
-    // Put rules you want to override here
-    "@eslint-react/no-class-component": "error",
+    "@eslint-react/no-missing-key": "warn",
   },
 });
 ```

apps/website/content/docs/configuration/using-custom-parsers/babel-eslint-parser.mdx

@@ -38,9 +38,9 @@ export default [
   },
   {
     files: ["**/*.js", "**/*.jsx"],
+    // Custom rule overrides (modify rule levels or disable rules)
     rules: {
-      // Put rules you want to override here
-      "@eslint-react/no-class-component": "error",
+      "@eslint-react/no-missing-key": "warn",
     },
   },
 ];

apps/website/content/docs/configuration/using-custom-parsers/ts-blank-eslint-parser.mdx

@@ -32,7 +32,6 @@ import globals from "globals";
 const GLOB_TS = ["**/*.ts", "**/*.tsx"];
 
 export default [
-  // base configuration for browser environment source files
   {
     files: GLOB_TS,
     languageOptions: {
@@ -45,7 +44,6 @@ export default [
       ...eslintJs.configs.recommended.rules,
     },
   },
-  // React configuration
   {
     files: GLOB_TS,
     ...eslintReact.configs["recommended-typescript"],

apps/website/content/docs/getting-started/javascript.mdx

@@ -59,7 +59,7 @@ export default defineConfig([
 
     // Custom rule overrides (modify rule levels or disable rules)
     rules: {
-      "@eslint-react/no-class-component": "error",
+      "@eslint-react/no-missing-key": "warn",
     },
   },
 ]);
@@ -92,9 +92,9 @@ export default [
 {
   "compilerOptions": {
     // ...other options
-    "jsx": "react-jsx",
+    "jsx": "react-jsx"
   },
-  "include": ["**/*.js", "**/*.jsx"],
+  "include": ["**/*.js", "**/*.jsx"]
 }
 ```
 

apps/website/content/docs/getting-started/typescript.mdx

@@ -42,7 +42,11 @@ export default tseslint.config({
   // 1. ESLint JS's recommended rules
   // 2. TypeScript ESLint recommended rules
   // 3. ESLint React's recommended-typescript rules
-  extends: [eslintJs.configs.recommended, tseslint.configs.recommended, eslintReact.configs["recommended-typescript"]],
+  extends: [
+    eslintJs.configs.recommended,
+    tseslint.configs.recommended,
+    eslintReact.configs["recommended-typescript"],
+  ],
 
   // Configure language/parsing options
   languageOptions: {
@@ -51,12 +55,13 @@ export default tseslint.config({
     parserOptions: {
       // Enable project service for better TypeScript integration
       projectService: true,
+      tsconfigRootDir: import.meta.dirname,
     },
   },
 
   // Custom rule overrides (modify rule levels or disable rules)
   rules: {
-    "@eslint-react/no-class-component": "error",
+    "@eslint-react/no-missing-key": "warn",
   },
 });
 ```
@@ -88,9 +93,9 @@ export default [
 {
   "compilerOptions": {
     // ...other options
-    "jsx": "react-jsx",
+    "jsx": "react-jsx"
   },
-  "include": ["**/*.ts", "**/*.tsx"],
+  "include": ["**/*.ts", "**/*.tsx"]
 }
 ```
 

packages/plugins/eslint-plugin/README.md

@@ -75,21 +75,31 @@ import tseslint from "typescript-eslint";
 
 export default tseslint.config({
   files: ["**/*.ts", "**/*.tsx"],
+
+  // Extend recommended rule sets from:
+  // 1. ESLint JS's recommended rules
+  // 2. TypeScript ESLint recommended rules
+  // 3. ESLint React's recommended-typescript rules
   extends: [
     eslintJs.configs.recommended,
     tseslint.configs.recommended,
     eslintReact.configs["recommended-typescript"],
   ],
+
+  // Configure language/parsing options
   languageOptions: {
+    // Use TypeScript ESLint parser for TypeScript files
     parser: tseslint.parser,
     parserOptions: {
+      // Enable project service for better TypeScript integration
       projectService: true,
       tsconfigRootDir: import.meta.dirname,
     },
   },
+
+  // Custom rule overrides (modify rule levels or disable rules)
   rules: {
-    // Put rules you want to override here
-    "@eslint-react/no-class-component": "error",
+    "@eslint-react/no-missing-key": "warn",
   },
 });
 ```

packages/plugins/eslint-plugin/src/configs/all.ts

@@ -38,10 +38,13 @@ export const rules = {
   "@eslint-react/no-duplicate-key": "warn",
   "@eslint-react/no-forward-ref": "warn",
   "@eslint-react/no-implicit-key": "warn",
+  // "@eslint-react/no-leaked-conditional-rendering": "warn",
   "@eslint-react/no-missing-component-display-name": "warn",
   "@eslint-react/no-missing-context-display-name": "warn",
   "@eslint-react/no-missing-key": "error",
+  "@eslint-react/no-misused-capture-owner-stack": "error",
   "@eslint-react/no-nested-component-definitions": "error",
+  "@eslint-react/no-nested-lazy-component-declarations": "warn",
   "@eslint-react/no-prop-types": "error",
   "@eslint-react/no-redundant-should-component-update": "error",
   "@eslint-react/no-set-state-in-component-did-mount": "warn",
@@ -59,6 +62,8 @@ export const rules = {
   "@eslint-react/no-useless-forward-ref": "warn",
   "@eslint-react/no-useless-fragment": "warn",
   "@eslint-react/prefer-destructuring-assignment": "warn",
+  "@eslint-react/prefer-react-namespace-import": "warn",
+  // "@eslint-react/prefer-read-only-props": "warn",
   "@eslint-react/prefer-shorthand-boolean": "off",
   "@eslint-react/prefer-shorthand-fragment": "off",
 

packages/plugins/eslint-plugin/src/configs/debug.ts

@@ -7,6 +7,7 @@ export const rules = {
   "@eslint-react/debug/function-component": "warn",
   "@eslint-react/debug/hook": "warn",
   "@eslint-react/debug/is-from-react": "warn",
+  "@eslint-react/debug/jsx": "warn",
 } as const;
 
 export const plugins = {