Contributing

Contributions are welcome!

To get started with the project, please follow our contributing guidelines.

Monorepo Structure

This section provides a reference to the repository structure and the relationships between different components.

Packages Summary

This section provides a summary of the packages in the monorepo.

Local Packages

• .pkgs/configs: Workspace config bases
• .pkgs/eff: JavaScript and TypeScript utilities
• .pkgs/samples: Sample fixtures and configs

Internal Packages

• Utilities
  • packages/ast: TSESTree AST utility module for static analysis
  • packages/var: TSESTree AST utility module for static analysis of variables
  • packages/jsx: TSESTree JSX utility module for static analysis of JSX patterns
• Core & Shared
  • packages/core: Utility module for static analysis of React core APIs and patterns
  • packages/eslint: ESLint types and utilities
  • packages/shared: Shared constants, types and functions

Public Packages

• Utilities
  • packages/kit: Utility module for building custom React rules with JavaScript functions
• ESLint Plugins
  • plugins/eslint-plugin-react-x: Core React rules
  • plugins/eslint-plugin-react-jsx: React Flavored JSX rules
  • plugins/eslint-plugin-react-rsc: React Server Components rules
  • plugins/eslint-plugin-react-dom: React DOM rules
  • plugins/eslint-plugin-react-web-api: Web API interaction rules
  • plugins/eslint-plugin-react-naming-convention: Naming convention rules
  • plugins/eslint-plugin-react-debug: Debugging rules for inspecting React patterns in code
  • plugins/eslint-plugin (npm: @eslint-react/eslint-plugin): A unified plugin that combines all individual plugins into one

Examples

• examples/next: Next.js example
• examples/preact: Preact example
• examples/preact-compat: Preact compat example
• examples/react-dom: React DOM example
• examples/react-dom-js: React DOM JS example
• examples/react-dom-with-custom-rules: React DOM with custom rules example

Documentation

• apps/website: Documentation website
• apps/playground: Interactive playground (placeholder)