Files
ESLint will run onpackage.json and files with the following extensions: .js, .ts, .cjs, .mjs, .d.cts, .d.mts, .jsx, .tsx, .css, .vue, .svelte, .astro, .graphql, .gql, .mdx
Configuration
boolean
default:true
Enable ESLint
string
Optional path to an ESLint configuration file relative to the repository. When set, this configuration is used for every file instead of discovering ESLint configurations recursively.
object
@e18e/eslint-plugin modernization, performance, and dependency replacement checks.
- .coderabbit.yaml
- Web UI
.coderabbit.yaml
e18e.enabled setting controls CodeRabbit-managed @e18e/eslint-plugin checks. The managed overlay is temporarily disabled at runtime while an installation hotfix is active, so changing this setting currently has no effect. When the overlay is active, the Chill profile reports its recommended rules and e18e/ban-dependencies as warnings, while the Assertive profile uses the recommended severities and reports e18e/ban-dependencies as an error. CodeRabbit does not add the managed overlay when your ESLint configuration already references e18e.
- ESLint configuration is read from the repository and is used as is. If no applicable ESLint configuration file is found for a changed file, CodeRabbit skips ESLint for that file.
-
Please ensure that all ESLint dependencies are defined in your
package.jsonfile(s). - Yarn and PNPM workspaces are supported.
- Private ESLint plugins or configurations are not supported at the moment. Please reach out to support if you would like us to add support for this.
-
For
@typescript-eslint, linting with type information is not supported at the moment. The type checking rules are disabled. -
For
eslint-plugin-import, the following rules are disabled:import/no-unresolved
-
For the
eslint-plugin-n, the following rules are disabled:n/no-missing-importn/no-missing-require
-
For the
eslint-plugin-node, the following rules are disabled:node/no-missing-importnode/no-missing-require
Configuration file discovery
CodeRabbit searches the repository recursively for ESLint configuration files. It supports both flat-config and legacy-config filenames:- Flat config:
eslint.config.js,eslint.config.mjs,eslint.config.cjs,eslint.config.ts,eslint.config.mts, andeslint.config.cts - Legacy config:
.eslintrc,.eslintrc.js,.eslintrc.cjs,.eslintrc.json,.eslintrc.yml, and.eslintrc.yaml
foo/bar/.eslintrc.js is automatically used for files under foo/bar/ and its subdirectories, but not for files outside foo/bar/.
CodeRabbit does not use an eslintConfig field in package.json as a configuration source. Use one of the supported configuration files instead.
Setting config_file replaces this discovery. CodeRabbit rejects URLs, absolute paths, paths containing .., and paths that do not exist.
Security policy and restrictions
ESLint runs in a sandbox. CodeRabbit scans ESLint config files before anynpm/yarn/pnpm installs and only permits a curated allow-list of plugins.
- CodeRabbit extracts referenced plugins from configs (the
pluginsarray,extends: "plugin:...",eslint-plugin-...mentions). - If any plugin outside the allow-list is referenced, CodeRabbit skips ESLint for the run.
- CodeRabbit does not install or execute arbitrary third-party plugins from the repository.
When CodeRabbit skips ESLint
CodeRabbit will skip running ESLint when:- The config references a plugin not in the allow-list.
- The config can’t be parsed or is otherwise unsafe.
config_fileis not a repository-relative path or does not exist.- No
package.jsonexists at the repository root. - No relevant
package.jsondeclares ESLint as a dependency or development dependency. - No applicable ESLint configuration is found for a changed file.
- Required dependencies cannot be installed or resolved in the sandbox.
Ignored rules
CodeRabbit filters out findings for the following rule IDs, including rule IDs with a namespace that end with the same value:camelcasecomma-danglecomma-spacingfunc-styleindentlinebreak-styleno-trailing-spacesno-use-before-defineno-varquote-propsquotesretayl/no-hardcoded-colorsts/no-unsafe-callvars-on-top
What’s next
All supported tools
Browse the complete list of linters, security analyzers, and CI/CD integrations available in CodeRabbit.
Tools reference
Explore detailed specifications and capabilities of all available CodeRabbit tools.
Configuration reference
Full reference for all available options, including how to enable, disable, and tune individual tools.