Contributing

Contributions are welcome!

This project does not have contributing guidelines. Explore the repository to learn how to contribute.

Monorepo StructureCopy Anchor Link

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

Packages SummaryCopy Anchor Link

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

Local PackagesCopy Anchor Link

• .pkgs/eff: JavaScript and TypeScript utilities
• .pkgs/configs: Workspace config bases
• .pkgs/samples: Sample custom rule implementations used by examples and documentation
• .pkgs/testkit: Shared test construction kit for unit tests and rule tests

Utility PackagesCopy Anchor Link

These packages are published to npm as dependencies of the ESLint plugins, but they are intended as internal building blocks rather than standalone public APIs.

• 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 PackagesCopy Anchor Link

• 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

ExamplesCopy Anchor Link

• 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-oxlint: React DOM with Oxlint example
• examples/react-dom-with-custom-rules: React DOM with custom rules example
• examples/tanstack-redact: TanStack Redact example
• examples/tanstack-start: TanStack Start example

DocumentationCopy Anchor Link

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