https://github.com/react-hookz/eslint-config

eslint configuration files used in @react-hookz projects
https://github.com/react-hookz/eslint-config

Last synced: 7 months ago
JSON representation

eslint configuration files used in @react-hookz projects

• Host: GitHub
• URL: https://github.com/react-hookz/eslint-config
• Owner: react-hookz
• License: mit
• Created: 2022-01-11T11:33:13.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-12T01:01:17.000Z (almost 2 years ago)
• Last Synced: 2024-04-12T11:21:30.612Z (almost 2 years ago)
• Language: JavaScript
• Homepage:
• Size: 2.82 MB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
> [!CAUTION]

> __PACKAGE IS DEPRECATED AND WILL BE DETED SOON__  

> USE [@ver0/eslint-config](https://github.com/ver0-project/eslint-config) instead



# @react-hookz/eslint-config

eslint configuration files used in @react-hookz projects

[![NPM Version](https://flat.badgen.net/npm/v/@react-hookz/eslint-config)](https://www.npmjs.com/package/@react-hookz/eslint-config)

[![NPM Downloads](https://flat.badgen.net/npm/dm/@react-hookz/eslint-config)](https://www.npmjs.com/package/@react-hookz/eslint-config)

[![NPM Dependents](https://flat.badgen.net/npm/dependents/@react-hookz/eslint-config)](https://www.npmjs.com/package/@react-hookz/eslint-config)

[![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)



## Installation

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

```shell

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.

```js

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

		},

	},

];

```