Skip to content

Commit cc963ca

Browse files
committed
update eslint documentation
1 parent 652dd22 commit cc963ca

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

Diff for: docs/tools/eslint.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,9 @@ ESLint will run on files with the following extensions:
2525

2626
## Configuration
2727

28-
CodeRabbit reads your ESLint configuration and uses it as is. Please ensure that all ESLint dependencies are defined in your `package.json` file(s). CodeRabbit supports Yarn and PNPM workspaces in your monorepo. CodeRabbit doesn't support private ESLint plugins or configurations at the moment.
28+
- ESLint configuration is read from the repository and is used as is. No additional configuration is required.
29+
- Please ensure that all ESLint dependencies are defined in your `package.json` file(s).
30+
- Yarn and PNPM workspaces are supported.
31+
- Private ESLint plugins or configurations are not supported at the moment. Please reach out to us on Discord if you would like us to add support for this.
32+
- For `@typescript-eslint`, linting with type information at the moment. The [type checking rules](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/disable-type-checked.ts) are disabled.
33+
- For `eslint-plugin-import`, the `import/no-unresolved` rule is disabled.

0 commit comments

Comments
 (0)