eslint-config

wakamsha's ESLint rules as an extensible shared config.

Warning

As of now, it does not work with eslint 9 as most plugins haven't updated yet. Please stay with eslint 8.57.0!

Usage

Important

Only ESM and ESLint FlatConfig

1. Install dependencies (and peer dependencies)

npm install --save-dev @wakamsha/eslint-config eslint

2. Configure ESLint

Within your ESLint config file (eslint.config.js):

import { essentials } from '@wakamsha/eslint-config';

export default [...essentials];

If you need TypeScript Support:

-import { essentials } from '@wakamsha/eslint-config';
+import { essentials, typescript } from '@wakamsha/eslint-config';

 export default [
   ...essentials,
+  ...typescript,
 ];

Must be added after essentials.

We also provide various other rule sets that you can configure to suit your project.

import {
  essentials,
  jsdoc,
  node,
  react,
  storybook,
  test,
  typescript,
} from '@wakamsha/eslint-config';

export default [
  ...essentials,
  ...jsdoc,
  ...node,
  ...react,
  ...storybook,
  ...test.react,
  ...typescript,
];

Rule set	Summary	Dependencies
essentials	Contains basic, import, and promise recommended rules	eslint eslint-plugin-promise eslint-plugin-import eslint-plugin-unicorn
jsdoc	Contains JSDoc recommended rules	eslint-plugin-jsdoc
node	Contains Node.js recommended rules	eslint-plugin-n
react	Contains React and jsx-a11y recommended rules	eslint-plugin-jsx-a11y eslint-plugin-react-hooks eslint-plugin-react
storybook	Contains Storybook recommended rules	eslint-plugin-storybook
test.react	Contains Vitest and React Testing Library rules	eslint-plugin-vitest eslint-plugin-jest-dom eslint-plugin-testing-library
typescript	Contains TypeScript recommended rules	@eslint-typescript/eslint-plugin @eslint-typescript/parser

Using Prettier

If you use Prettier to format your code, you must disable any rules in @wakamsha/eslint-config/essentials that conflict with Prettier.

1. Install dependencies

npm install --save-dev eslint-config-prettier

2. Configure ESLint

Within your ESLint config file:

 import { essentials, typescript } from '@wakamsha/eslint-config';
+import prettier from 'eslint-config-prettier';


 export default [
   ...essentials,
   ...typescript,
+  prettier,
 ];

By adding the prettier configuration to extends in the ESLint configuration, you can disable all rules in essentials that conflict with Prettier.

Migrate from an existing configuration

@wakamsha/eslint-config contains various plugins related to different rule sets. Therefore, users don't need to install them separately. If you have installed them in your existing configuration, we recommend uninstalling them.

npm uninstall eslint-plugin-promise eslint-plugin-import eslint-plugin-unicorn \
  eslint-plugin-jsdoc \
  eslint-plugin-n \
  eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks \
  eslint-plugin-storybook \
  eslint-plugin-vitest eslint-plugin-jest-dom eslint-plugin-testing-library \
  @eslint-typescript/eslint-plugin @eslint-typescript/parser

Versioning

• Increment major version: Changed error rules.
• Increment minor version: Changed warn rules.
• Increment patch version: Not changed error and warn rules.

License

Open source licensed as MIT.