update eslint documentation

harjotgill · harjotgill · commit cc963ca37166 · 2024-11-11T15:54:41.000+05:30
diff --git a/docs/tools/eslint.md b/docs/tools/eslint.md
@@ -25,4 +25,9 @@ ESLint will run on files with the following extensions:
 
 ## Configuration
 
-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.
+- ESLint configuration is read from the repository and is used as is. No additional configuration is required.
+- Please ensure that all ESLint dependencies are defined in your `package.json` file(s).
+- Yarn and PNPM workspaces are supported.
+- 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.
+- 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.
+- For `eslint-plugin-import`, the `import/no-unresolved` rule is disabled.
