# ESLint Pre-Commit Hook

> Pre-commit hook for ESLint

[![npm (scoped)](https://img.shields.io/npm/v/eslint-pre-commit-hook.svg)](https://npmjs.com/package/eslint-pre-commit-hook)
[![install size](https://packagephobia.now.sh/badge?p=eslint-pre-commit-hook)](https://packagephobia.now.sh/result?p=eslint-pre-commit-hook)
[![downloads](https://img.shields.io/npm/dt/eslint-pre-commit-hook.svg)](https://npmjs.com/package/eslint-pre-commit-hook) <br>
[![license](https://img.shields.io/github/license/mirismaili/eslint-pre-commit-hook.svg)](https://github.com/mirismaili/eslint-pre-commit-hook/blob/master/LICENSE)
[![Forks](https://img.shields.io/github/forks/mirismaili/eslint-pre-commit-hook.svg?style=social)](https://github.com/mirismaili/eslint-pre-commit-hook/fork)
[![Stars](https://img.shields.io/github/stars/mirismaili/eslint-pre-commit-hook.svg?style=social)](https://github.com/mirismaili/eslint-pre-commit-hook)

```bash
npm i eslint-pre-commit-hook -D
```

or:

```bash
yarn add eslint-pre-commit-hook -D
```

## Usage

**There is no further requirements after installation.** It automatically sets `pre-commit` hook after installation.
Check `.git/hooks/pre-commit` to sure. Also, make sure it's executable.

You can customize its default behaviour by setting `breakOnWarningsToo`
field in your `package.json` file:

```json
  "eslintPreCommit": {
    "breakOnWarningsToo": true
  }
```

Then it'll be failed on both errors and warnings (no errors or warnings allowed).