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/eslint-plugin-local
: Internal workspace ESLint plugin
Internal Packages
- Utilities
packages/utilities/eff
: JavaScript and TypeScript utilities (previously some re-exports of theeffect
library)packages/utilities/ast
: TSESTree AST utility module for static analysispackages/utilities/var
: TSESTree AST utility module for static analysis of variablespackages/utilities/jsx
: TSESTree AST utility module for static analysis of JSXpackages/utilities/kit
: ESLint React's Plugin Kit for building plugins and rules
- Core & Shared
packages/core
: Utility module for static analysis of React core APIs and patternspackages/shared
: Shared constants, types and functions
Public Packages
- ESLint Plugins
packages/plugins/eslint-plugin-react-x
: Core React rulespackages/plugins/eslint-plugin-react-dom
: React DOM rulespackages/plugins/eslint-plugin-react-web-api
: Web API interaction rulespackages/plugins/eslint-plugin-react-hooks-extra
: Extra React Hooks rulespackages/plugins/eslint-plugin-react-naming-convention
: Naming convention rulespackages/plugins/eslint-plugin-react-debug
: Debugging rules for inspecting React patterns in codepackages/plugins/eslint-plugin
: Main plugin combining all rules and presets from the above packages
Documentation
apps/website
: Documentation websiteapps/playground
: Interactive playground (WIP)