Skip to content

Commit 6415623

Browse files
docs(eslint): List enabled plugins, rules
1 parent 7b4624d commit 6415623

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/eslint.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ id: eslint
33
title: ESLint
44
---
55

6+
## Purpose
7+
8+
This package unifies the shared ESLint config used across all TanStack projects. It is designed to be framework-agnostic, and does not include any framework-specific plugins.
9+
610
## Setup
711

812
### package.json
@@ -22,3 +26,14 @@ export default [
2226
},
2327
]
2428
```
29+
30+
## Plugins
31+
32+
- [@eslint/js](https://github.com/eslint/eslint) - The core ESLint rules
33+
- [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint) - Enables TypeScript support
34+
- [eslint-plugin-import-x](https://github.com/un-ts/eslint-plugin-import-x) - Lints imports and exports
35+
- [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn) - Miscellaneous useful rules
36+
37+
## Rules
38+
39+
You can inspect the enabled rules by running `pnpm dlx @eslint/config-inspector`, or by browsing the source [here](https://github.com/TanStack/config/tree/main/src/eslint). Each rule has a comment explaining why it is included in the shared config.

0 commit comments

Comments
 (0)