https://github.com/axross/eslint-config
A hand-picked configuration set for ESLint.
https://github.com/axross/eslint-config
eslint eslint-config
Last synced: 3 months ago
JSON representation
A hand-picked configuration set for ESLint.
- Host: GitHub
- URL: https://github.com/axross/eslint-config
- Owner: axross
- License: mit
- Created: 2023-07-18T18:18:00.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-08T00:55:24.000Z (10 months ago)
- Last Synced: 2025-03-14T22:28:07.082Z (7 months ago)
- Topics: eslint, eslint-config
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@axross/eslint-config
- Size: 407 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @axross/eslint-config
A hand-crafted [ESLint](https://eslint.org/) configuration set.
[](https://badge.fury.io/js/@axross%2Feslint-config) [](LICENSE)
## Installation
As the minimal setup, you can install 📦 `@axross/eslint-config` along with ESLint:
```
npm i -D @axross/eslint-config eslint
```
And create/update **eslint.config.cjs** as the following:
```js
/* global __dirname:readonly */
module.exports = [
...require("./src/config.cjs")({ tsconfigRootDir: __dirname }),
];
```
For further better setups, please see [Recommended Setup](#recommended-setup) section.
## Supported Plugins
This config detects the installed plugins in your project and automatically opts in the respective configurations. Currently this config supports the following plugins:
- [`@eslint/js`](https://github.com/eslint/eslint/tree/main/packages/js)
- [`typescript-eslint`](https://typescript-eslint.io/)
- [`eslint-plugin-unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn)
- [`eslint-plugin-compat`](https://github.com/amilajack/eslint-plugin-compat)
- [`eslint-plugin-import`](https://github.com/import-js/eslint-plugin-import)
- When you're using TypeScript, you need to install [`typescript-eslint`](https://typescript-eslint.io/) and [`eslint-import-resolver-typescript`](https://github.com/import-js/eslint-import-resolver-typescript) as well
- [`@stylistic/eslint-plugin`](https://eslint.style/)
- [`eslint-plugin-perfectionist`](https://perfectionist.dev/)
- [`eslint-plugin-react`](https://github.com/jsx-eslint/eslint-plugin-react)
- [`eslint-plugin-react-hooks`](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks)
- [`eslint-plugin-jsx-a11y`](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)
- [`eslint-plugin-next`](https://github.com/vercel/next.js/tree/canary/packages/eslint-plugin-next) (normally comes with [`next`](https://nextjs.org/))
- [`@react-native/eslint-plugin`](https://github.com/facebook/react-native/tree/main/packages/eslint-plugin-react-native)
- [`eslint-plugin-jest`](https://github.com/jest-community/eslint-plugin-jest)
- [`eslint-plugin-jest-dom`](https://github.com/testing-library/eslint-plugin-jest-dom)
- [`eslint-plugin-jest-formatting`](https://github.com/dangreenisrael/eslint-plugin-jest-formatting)
- [`eslint-plugin-testing-library`](https://github.com/testing-library/eslint-plugin-testing-library)
- [`eslint-plugin-storybook`](https://github.com/storybookjs/eslint-plugin-storybook)
- [`eslint-plugin-tailwindcss`](https://github.com/francoismassart/eslint-plugin-tailwindcss)
- [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier)
## Recommended Setup
### React + Next.js
```
npm i -D \
@axross/eslint-config \
eslint \
@eslint/js \
typescript-eslint \
eslint-plugin-unicorn \
eslint-plugin-compat \
eslint-plugin-import \
eslint-plugin-perfectionist \
eslint-plugin-react \
eslint-plugin-react-hooks \
eslint-plugin-jsx-a11y \
eslint-plugin-next \
eslint-plugin-jest \
eslint-plugin-jest-dom \
eslint-plugin-jest-formatting \
eslint-plugin-testing-library \
eslint-plugin-storybook
```
### React Native + Expo
```
npm i -D \
@axross/eslint-config \
eslint \
@eslint/js \
typescript-eslint \
eslint-plugin-unicorn \
eslint-plugin-compat \
eslint-plugin-import \
eslint-plugin-perfectionist \
eslint-plugin-react \
eslint-plugin-react-hooks \
eslint-plugin-jsx-a11y \
@react-native/eslint-plugin
```
## License
[MIT](/LICENSE)