@axross/eslint-config

A hand-crafted and adaptive ESLint configuration set.

Installation

As the minimal setup, you can install 📦 @axross/eslint-config along with ESLint:

npm i -D @axross/eslint-config

And create/update eslint.config.cjs as the following:

module.exports = [
  ...require("@axross/eslint-config")({ tsconfigRootDir: __dirname }),
];

For further more refinement, please see Recommended Setup section.

Supported Plugins

This config detects the installed plugins in your project and automatically opts in only the respective configurations. Currently this config supports the following plugins:

• @eslint/js
• typescript-eslint
• eslint-plugin-unicorn
• eslint-plugin-compat
• eslint-plugin-import-x
  • When you're using TypeScript, you need to install eslint-import-resolver-typescript as well
• @stylistic/eslint-plugin
• eslint-plugin-perfectionist
• eslint-plugin-react
• eslint-plugin-react-hooks
• eslint-plugin-jsx-a11y
• eslint-plugin-next (normally comes with next)
• @react-native/eslint-plugin
• eslint-plugin-testing-library
• eslint-plugin-storybook
• eslint-plugin-tailwindcss
• eslint-config-prettier

If you want any suggested plugin to support in this config, please create an issue.

Recommended Setup

Here is several recommended setup based on your application arch-type. You can copy-and-paste the following list of plugins to your terminal (PLEASE CHECK BEFORE RUN!) to set up your eslint environment.

React + Next.js

npm i -D @axross/eslint-config eslint @eslint/js typescript-eslint eslint-plugin-unicorn eslint-plugin-compat eslint-plugin-import-x eslint-plugin-perfectionist eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-jsx-a11y eslint-plugin-next

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