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

Internal Packages

• Utilities
  • packages/utilities/ast: TSESTree AST utility module for static analysis
  • packages/utilities/var: TSESTree AST utility module for static analysis of variables
  • packages/utilities/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/shared: Shared constants, types and functions

Public Packages

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

Documentation

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