README.md

@react-hookz/eslint-config

eslint configuration files used in @react-hookz projects

Installation

This package does not install eslint, so you need to install them manually.

yarn add -D @react-hookz/eslint-config eslint

Usage

This config is expected to be used with ESLint 8.3+, as it utilizes flat config.

Import sub-configs you are interested in, spreading them into your config. All configs are guaranteed to be an array.

Some configs, like jest and vitest, require extra dependencies to be installed. You can find the required dependencies in the respective READMEs.

import baseConfig from '@react-hookz/eslint-config/base.js';
import reactConfig from '@react-hookz/eslint-config/react.js';
import vitestConfig from '@react-hookz/eslint-config/vitest.js';

export default [
	...baseConfig,
	...reactConfig,
	...vitestConfig,
	{
		rules: {
			// your own overrides
		},
	},
];