@yudai-nkt/eslint-config

My shareable config for ESLint.

Installation

This package is available on the NPM registry. Install @yudai-nkt/eslint-config using your favortite package manager.

Note that npm v7 or later automatically installs peer dependencies that you might not want to install. Make sure to specify the --legacy-peer-deps option if that's the case.

Usage

Just add @yudai-nkt to extends in your ESLint configuration:

{
  "extends": ["@yudai-nkt"]
}

This will check your dependencies and automatically load the neccessary configurations.

Presets

While the usage mentioned above should work out of the box, you can manually load the presets listed below. To load these presets, @yudai-nkt/eslint-config/ needs to be prefixed with the name (e.g., @yudai-nkt/eslint-config/base).

| Preset name | Description | | ------- | ----------- | | base | Extends configurations recommended by the core ESLint team and eslint-plugin-unicorn, and configures some additional rules. | | jest | Extends configurations recommended by eslint-plugin-jest, and configures some additional rules for common test file patterns. | | prettier | Extends eslint-config-prettier. | | react | Extends configurations recommended by eslint-plugin-jsx-a11y, eslint-plugin-react, and eslint-plugin-react-hooks, and configures some additional rules. | | typescript | Specifies @typescript-eslint/parser as a parser to lint TypeScript source codes, extends configurations recommended by @typescript-eslint/eslint-plugin, and configures some additional rules. | | uvu | Enables all the rules defined by eslint-plugin-uvu for common test file patterns. |

License

This package is distributed under the MIT License. See LICENSE.md for details.