Skip to content

Commit

Permalink
docs(eslint): List enabled plugins, rules
Browse files Browse the repository at this point in the history
  • Loading branch information
lachlancollins committed Jun 29, 2024
1 parent 7b4624d commit 6415623
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/eslint.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

0 comments on commit 6415623

Please sign in to comment.