Glossary
A collection of terms and concepts used in ESLint React
P
Project Config
A configuration file that specifies a project's root files and compiler options.
For TypeScript and JavaScript files, the Project Config is typically a tsconfig.json or jsconfig.json file located in the project root.
For MDX files, the Project Config is specified by the "mdx" property in a tsconfig.json or jsconfig.json file.
ESLint React uses the Project Config to obtain information about the code being linted, such as the JSX Transform.
Project Rules
Custom ESLint rules built with @eslint-react/kit to enforce project-specific conventions and requirements. Unlike built-in rules, they are owned and maintained by your team.
Project Rules are functions that return rule implementations and are registered using the eslintReactKit().use() builder API. A rule's name is automatically derived from its function name (e.g., functionComponentDefinition → @eslint-react/kit/function-component-definition).
See Configure Project Rules for setup instructions and Recipes for ready-to-use examples.
R
Recipe
Ready-to-use definitions for Project Rules, built with @eslint-react/kit. Recipes are not shipped as built-in rules; they are designed to be copied and pasted directly into your project, allowing you to customize the implementation to match your team's conventions.
See Recipes for available recipes.