Glossary

P

Project Config

The configuration file specifies the root files and the compiler options required to compile the project.

For TypeScript or JavaScript files, the Project Config is typically named tsconfig.json or jsconfig.json and is located in the root of a project.

For MDX files, the Project Config is the "mdx" property in the tsconfig.json or jsconfig.json file.

ESLint React uses the Project Config to provide information (e.g., JSX Transform) about the code it is linting.

Project Rules

Custom ESLint rules built with @eslint-react/kit to enforce project-specific conventions and requirements. Unlike built-in rules, Project Rules are owned by your team and can be tailored to match your specific coding standards.

Project Rules are defined as functions that return a rule implementation, and are registered using the eslintReactKit().use() builder API. The rule name is automatically derived from the 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 custom ESLint rule definitions built with @eslint-react/kit. Recipes 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.