chore: update contributing docs

Author: Rel1cx

.github/CONTRIBUTING.md

@@ -21,6 +21,94 @@ Thank you for your interest in contributing to ESLint React! This guide will hel
 - **Bug Fixes** - Include `(fix: #xxxx)` in your PR title and detailed description
 - **Documentation Changes** - Include `(docs: #xxxx)` in your PR title and detailed description
 
+## Development Commands
+
+### Build Commands
+
+```bash
+# Build packages in packages directory (core, shared, utilities, plugins)
+pnpm run build
+
+# Build packages in .pkgs directory (local configs)
+pnpm run build:pkgs
+
+# Build documentation for all packages
+pnpm run build:docs
+
+# Build website
+pnpm run build:website
+```
+
+### Testing
+
+```bash
+# Run all tests with Vitest
+pnpm run test
+
+# Run a single test file
+pnpm vitest packages/plugins/eslint-plugin-react-x/src/rules/[rule-name].spec.ts
+```
+
+### Linting & Formatting
+
+```bash
+# Full lint check (deps, publish, TypeScript, ESLint, examples)
+pnpm run lint
+
+# Individual lint commands
+pnpm run lint:deps      # Check dependency cycles with skott
+pnpm run lint:ts        # TypeScript check across packages
+pnpm run lint:es        # ESLint check
+pnpm run lint:publish   # Check package.json publishing config
+pnpm run lint:spell     # Spell check with cspell
+
+# Format code
+pnpm run format:write   # Format with dprint
+pnpm run format:check   # Check formatting
+```
+
+### Development Utilities
+
+```bash
+# Update project metadata
+pnpm run update:all        # Update version, README, and website
+pnpm run update:version    # Update version across packages
+pnpm run update:readme     # Update README with generated content
+# pnpm run update:website    # Update website content
+
+# Package management
+pnpm run sort:package-json # Sort package.json files consistently
+
+# Inspection tools
+pnpm run inspect:deps           # Visualize dependency graph
+pnpm run inspect:eslint-config  # Launch ESLint config inspector
+```
+
+## Development Workflow
+
+### Testing
+
+- Test files located alongside source: `src/rules/[rule-name].spec.ts`
+- Uses TypeScript ESLint Rule Tester with custom configurations
+- Separate test setups for type-checked and non-type-checked rules
+- Test fixtures support multiple TypeScript configurations (JSX variants)
+- Helper functions in `test/` directory for common test utilities
+
+### Working with Rules
+
+When developing new ESLint rules:
+
+1. Open an issue to discuss the rule's purpose and design if no existing issue exists
+2. Add rule implementation in appropriate plugin's `src/rules/` directory
+3. Create corresponding test file using rule tester setup
+4. Export rule from plugin's main index file
+5. Add rule documentation with summary and examples
+6. Update presets/configs if rule should be included by default
+7. Update the unified plugin to include the new rule
+8. Update the website documentation with the new rule details
+9. Run the build and test commands to ensure everything works as expected
+10. Submit a pull request with clear description of the changes and any relevant issue links
+
 ## References
 
 - [Monorepo Structure](https://eslint-react.xyz/docs/contributing#monorepo-structure)

.github/instructions/nx.instructions.md

@@ -1,5 +1,5 @@
 ---
-applyTo: '**'
+applyTo: "**"
 ---
 
 // This file is automatically generated by Nx Console
@@ -9,12 +9,14 @@ You are in an nx workspace using Nx 21.4.0 and pnpm as the package manager.
 You have access to the Nx MCP server and the tools it provides. Use them. Follow these guidelines in order to best help the user:
 
 # General Guidelines
+
 - When answering questions, use the nx_workspace tool first to gain an understanding of the workspace architecture
 - For questions around nx configuration, best practices or if you're unsure, use the nx_docs tool to get relevant, up-to-date docs!! Always use this instead of assuming things about nx configuration
 - If the user needs help with an Nx configuration or project graph error, use the 'nx_workspace' tool to get any errors
 - To help answer questions about the workspace structure or simply help with demonstrating how tasks depend on each other, use the 'nx_visualize_graph' tool
 
 # Generation Guidelines
+
 If the user wants to generate something, use the following flow:
 
 - learn about the nx workspace and any specifics the user needs by using the 'nx_workspace' tool and the 'nx_project_details' tool if applicable
@@ -29,12 +31,11 @@ If the user wants to generate something, use the following flow:
 - use the information provided in the log file to answer the user's question or continue with what they were doing
 
 # Running Tasks Guidelines
+
 If the user wants help with tasks or commands (which include keywords like "test", "build", "lint", or other similar actions), use the following flow:
+
 - Use the 'nx_current_running_tasks_details' tool to get the list of tasks (this can include tasks that were completed, stopped or failed).
 - If there are any tasks, ask the user if they would like help with a specific task then use the 'nx_current_running_task_output' tool to get the terminal output for that task/command
 - Use the terminal output from 'nx_current_running_task_output' to see what's wrong and help the user fix their problem. Use the appropriate tools if necessary
 - If the user would like to rerun the task or command, always use `nx run <taskId>` to rerun in the terminal. This will ensure that the task will run in the nx context and will be run the same way it originally executed
-- If the task was marked as "continuous" do not offer to rerun the task. This task is already running and the user can see the output in the terminal. You can use 'nx_current_running_task_output' to get the output of the task to verify the output. 
-
-
-
+- If the task was marked as "continuous" do not offer to rerun the task. This task is already running and the user can see the output in the terminal. You can use 'nx_current_running_task_output' to get the output of the task to verify the output.

apps/website/package.json

@@ -29,7 +29,7 @@
     "next-view-transitions": "^0.3.4",
     "react": "^19.1.1",
     "react-dom": "^19.1.1",
-    "shiki": "^3.9.2",
+    "shiki": "^3.10.0",
     "tailwind-merge": "^3.3.1",
     "twoslash": "^0.3.4"
   },

examples/vite-react-dom-app-v1/package.json

@@ -23,13 +23,13 @@
     "@tsconfig/vite-react": "^7.0.0",
     "@types/react": "^19.1.10",
     "@types/react-dom": "^19.1.7",
-    "@vitejs/plugin-react": "^5.0.0",
+    "@vitejs/plugin-react": "^5.0.1",
     "eslint": "^9.33.0",
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-react-refresh": "^0.4.20",
     "typescript": "^5.9.2",
     "typescript-eslint": "^8.40.0",
-    "vite": "^7.1.2"
+    "vite": "^7.1.3"
   },
   "engines": {
     "node": ">=20.19.0"

examples/vite-react-dom-app/package.json

@@ -23,13 +23,13 @@
     "@tsconfig/vite-react": "^7.0.0",
     "@types/react": "^19.1.10",
     "@types/react-dom": "^19.1.7",
-    "@vitejs/plugin-react": "^5.0.0",
+    "@vitejs/plugin-react": "^5.0.1",
     "eslint": "^9.33.0",
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-react-refresh": "^0.4.20",
     "typescript": "^5.9.2",
     "typescript-eslint": "^8.40.0",
-    "vite": "^7.1.2"
+    "vite": "^7.1.3"
   },
   "engines": {
     "node": ">=20.19.0"

examples/vite-react-dom-js-app/package.json

@@ -20,12 +20,12 @@
     "@eslint/js": "^9.33.0",
     "@types/react": "^19.1.10",
     "@types/react-dom": "^19.1.7",
-    "@vitejs/plugin-react": "^5.0.0",
+    "@vitejs/plugin-react": "^5.0.1",
     "eslint": "^9.33.0",
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-react-refresh": "^0.4.20",
     "globals": "^16.3.0",
-    "vite": "^7.1.2"
+    "vite": "^7.1.3"
   },
   "engines": {
     "node": ">=20.19.0"

examples/vite-react-dom-js-with-babel-eslint-parser-app/package.json

@@ -25,7 +25,7 @@
     "@types/babel__preset-env": "~7.10.0",
     "@types/react": "^19.1.10",
     "@types/react-dom": "^19.1.7",
-    "@vitejs/plugin-react": "^5.0.0",
+    "@vitejs/plugin-react": "^5.0.1",
     "eslint": "^9.33.0",
     "eslint-plugin-react-debug": "workspace:*",
     "eslint-plugin-react-dom": "workspace:*",
@@ -35,7 +35,7 @@
     "eslint-plugin-react-web-api": "workspace:*",
     "eslint-plugin-react-x": "workspace:*",
     "globals": "^16.3.0",
-    "vite": "^7.1.2"
+    "vite": "^7.1.3"
   },
   "engines": {
     "node": ">=20.19.0"

examples/vite-react-dom-with-ts-blank-eslint-parser-app/package.json

@@ -25,15 +25,15 @@
     "@tsconfig/vite-react": "^7.0.0",
     "@types/react": "^19.1.10",
     "@types/react-dom": "^19.1.7",
-    "@vitejs/plugin-react": "^5.0.0",
+    "@vitejs/plugin-react": "^5.0.1",
     "eslint": "^9.33.0",
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-react-refresh": "^0.4.20",
     "globals": "^16.3.0",
     "ts-blank-eslint-parser": "^0.4.3",
     "typescript": "^5.9.2",
     "typescript-eslint": "^8.40.0",
-    "vite": "^7.1.2"
+    "vite": "^7.1.3"
   },
   "engines": {
     "node": ">=20.19.0"