feat: improve typings of configs, add readme, improve exports

Author: xobotyi

README.md

@@ -10,3 +10,37 @@ eslint configuration files used in @react-hookz projects
 [![Build](https://img.shields.io/github/actions/workflow/status/react-hookz/eslint-config/CI.yml?branch=master&style=flat-square)](https://github.com/react-hookz/eslint-config/actions)
 
 </div>
+
+## Installation
+
+This package does not install `eslint`, `prettier`, or `eslint-plugin-prettier`, so you need to
+install them manually.
+
+```shell
+yarn install -D @react-hookz/eslint-config eslint eslint-plugin-prettier prettier
+```
+
+## Usage
+
+This config is expected to be used with ESLint 8.3+, as it utilizes flat config.
+
+Import the package directly and use the sub-configs you are interested in, spreading them into your
+config.
+
+Some configs, like `jest` and `vitest`, require extra dependencies to be installed. You can find the
+required dependencies in the respective READMEs.
+
+```js
+import { config } from '@react-hookz/eslint-config';
+
+export default [
+	...config.base,
+	...config.react,
+	...config.vitest,
+	{
+		rules: {
+			// your own overrides
+		},
+	},
+];
+```

configs/base.js

@@ -6,6 +6,9 @@ import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended'
 import pluginPromise from 'eslint-plugin-promise';
 import eslintPluginUnicorn from 'eslint-plugin-unicorn';
 
+/** @typedef {import('eslint').Linter} Linter */
+
+/** @type {Linter.Config[]} */
 const baseConfig = [
 	js.configs.recommended,
 

configs/jest.js

@@ -1,4 +1,5 @@
 import jest from 'eslint-plugin-jest';
 
+/** @type {Linter.Config[]} */
 const jestConfig = [jest.configs['flat/recommended']];
 export default jestConfig;

configs/md.js

@@ -1,6 +1,7 @@
 import * as mdx from 'eslint-plugin-mdx';
 import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
 
+/** @type {Linter.Config[]} */
 const mdConfig = [
 	{
 		...mdx.flat,
@@ -19,6 +20,8 @@ const mdConfig = [
 			// If you want to override some rules for code blocks
 			'no-var': 'error',
 			'prefer-const': 'error',
+			'import/no-unresolved': 'off',
+			'import/no-anonymous-default-export': 'off',
 		},
 	},
 	eslintPluginPrettierRecommended,

configs/node.js

@@ -1,5 +1,6 @@
 import nodePlugin from 'eslint-plugin-n';
 
+/** @type {Linter.Config[]} */
 const nodeConfig = [
 	nodePlugin.configs['flat/recommended-module'],
 	{

configs/react.js

@@ -1,6 +1,7 @@
 import pluginReact from 'eslint-plugin-react';
 import pluginReactHooks from 'eslint-plugin-react-hooks';
 
+/** @var {Linter.Config[]} config */
 const reactConfig = [
 	pluginReact.configs.flat.recommended,
 	pluginReactHooks.configs.recommended,

configs/typescript-unsafe.js

@@ -1,5 +1,6 @@
 import typescriptConfig from './typescript.js';
 
+/** @var {Linter.Config[]} config */
 const typescriptUnsafeConfig = [
 	...typescriptConfig,
 	{

configs/typescript.js

@@ -2,6 +2,7 @@ import xoTypescript from 'eslint-config-xo-typescript';
 import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
 import baseConfig from './base.js';
 
+/** @var {Linter.Config[]} config */
 const typescriptConfig = [
 	...baseConfig,
 

configs/vitest.js

@@ -1,4 +1,11 @@
 import vitest from '@vitest/eslint-plugin';
 
-const vitestConfig = [vitest.configs.flat.recommended];
+/** @var {Linter.Config[]} config */
+const vitestConfig = [
+	{
+		files: ['*.test.{js,jsx,ts,tsx}', '*.suite.{js,jsx,ts,tsx}'],
+		plugins: { vitest },
+		rules: vitest.configs.recommended.rules,
+	},
+];
 export default vitestConfig;

eslint.config.js

@@ -1,5 +1,7 @@
 import baseConfig from './configs/base.js';
 import mdConfig from './configs/md.js';
 
+/** @typedef {import('eslint').Linter} Linter */
+/** @type {Linter.Config[]} */
 const config = [{ ignores: ['CHANGELOG.md', '.idea', 'node_modules'] }, ...baseConfig, ...mdConfig];
 export default config;