From 64156238feb6f48c40bedb21d114593223734b05 Mon Sep 17 00:00:00 2001
From: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com>
Date: Sat, 29 Jun 2024 16:35:54 +1000
Subject: [PATCH] docs(eslint): List enabled plugins, rules

---
 docs/eslint.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/docs/eslint.md b/docs/eslint.md
index e0f8237..2f3d528 100644
--- a/docs/eslint.md
+++ b/docs/eslint.md
@@ -3,6 +3,10 @@ id: eslint
 title: ESLint
 ---
 
+## Purpose
+
+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.
+
 ## Setup
 
 ### package.json
@@ -22,3 +26,14 @@ export default [
   },
 ]
 ```
+
+## Plugins
+
+- [@eslint/js](https://github.com/eslint/eslint) - The core ESLint rules
+- [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint) - Enables TypeScript support
+- [eslint-plugin-import-x](https://github.com/un-ts/eslint-plugin-import-x) - Lints imports and exports
+- [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn) - Miscellaneous useful rules
+
+## Rules
+
+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.