# @eyesee/eslint-config

> EyeSee ESLint configuration

Latest version **1.2.3** (published 2023-07-10) · ISC license · 0 weekly downloads

## Install

```sh
npm install @eyesee/eslint-config
pnpm add @eyesee/eslint-config
yarn add @eyesee/eslint-config
bun add @eyesee/eslint-config
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.3 |
| Published | 2023-07-10 |
| First published | 2021-08-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 4.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | EyeSee |
| Maintainers | eyesee |
| Keywords | eslint, eslintconfig, eslint-config |

## Links

- npm: https://www.npmjs.com/package/@eyesee/eslint-config
- npm.io page: https://npm.io/package/@eyesee/eslint-config

## Dependencies (9)

- [eslint](https://npm.io/package/eslint.md) ^7.32.0
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.26.0
- [eslint-config-airbnb](https://npm.io/package/eslint-config-airbnb.md) ^18.2.1
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.27.4
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^8.3.0
- [eslint-plugin-jsx-a11y](https://npm.io/package/eslint-plugin-jsx-a11y.md) ^6.6.0
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) ^3.4.0
- [eslint-plugin-css-modules](https://npm.io/package/eslint-plugin-css-modules.md) ^2.11.0
- [eslint-plugin-react-hooks](https://npm.io/package/eslint-plugin-react-hooks.md) ^4.2.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 1.2.3 (latest) — 2023-07-10
- 1.2.2 — 2022-03-01
- 1.2.1 — 2022-01-10
- 1.2.0 — 2021-11-04
- 1.1.1 — 2021-11-04
- 1.1.0 — 2021-11-04
- 1.0.11 — 2021-11-03
- 1.0.10 — 2021-11-03
- 1.0.9 — 2021-11-03
- 1.0.8 — 2021-11-03
- 1.0.7 — 2021-11-03
- 1.0.6 — 2021-10-25
- 1.0.5 — 2021-10-25
- 1.0.4 — 2021-08-19
- 1.0.3 — 2021-08-19
- … 3 more at https://npm.io/package/@eyesee/eslint-config/versions

## README

### Usage

Install **ESLint** and **Prettier** in your VSCode.

Install as dev dependencies in your project

**npm i @eyesee/eslint-config husky lint-staged @commitlint/cli @commitlint/config-conventional -D**

#### package.json

Add following commands to the root of you package.json file.

```json
"lint-staged": {
  "*.+(js|jsx|ts|tsx|mdx)": [
    "eslint",
    "prettier --write",
    "git add"
  ]
}
```

#### .eslintrc

Create **.eslintrc** file in the root of your project and add the following.

```json
{
    "extends": "@eyesee/eslint-config"
}
```

### commitlint

Create commitlint.config.cjs file in the root of your project and add the following.

```
module.exports = {extends: ['@commitlint/config-conventional']}
```

### husky

Use this command npm install husky --save-dev to install husky.

Create .husky folder with commit-msg and pre-commit files with following content.

##### commit-msg
```
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx commitlint --edit $1
```

##### pre-commit
```
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx lint-staged
```

Thats it!

---
_Source: https://npm.io/package/@eyesee/eslint-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._