# @endouble.com/eslint-config-endouble

> Endouble's Javascript ESLint configuration

Latest version **2.2.1** (published 2020-01-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @endouble.com/eslint-config-endouble
pnpm add @endouble.com/eslint-config-endouble
yarn add @endouble.com/eslint-config-endouble
bun add @endouble.com/eslint-config-endouble
```

## 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 | 2.2.1 |
| Published | 2020-01-15 |
| First published | 2017-04-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 8.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Endouble.com |
| Maintainers | endouble, koenknol, renancouto |

## Links

- npm: https://www.npmjs.com/package/@endouble.com/eslint-config-endouble
- Repository: https://github.com/Endouble/eslint-config
- Homepage: https://github.com/Endouble/eslint-config#readme
- Issues: https://github.com/Endouble/eslint-config/issues
- npm.io page: https://npm.io/package/@endouble.com/eslint-config-endouble

## Dependencies (8)

- [eslint](https://npm.io/package/eslint.md) ^5.7.0
- [babel-eslint](https://npm.io/package/babel-eslint.md) ^10.0.0
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.11.1
- [eslint-config-airbnb](https://npm.io/package/eslint-config-airbnb.md) ^17.1.0
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.14.0
- [eslint-plugin-cypress](https://npm.io/package/eslint-plugin-cypress.md) ^2.8.1
- [eslint-plugin-jsx-a11y](https://npm.io/package/eslint-plugin-jsx-a11y.md) ^6.1.2
- [eslint-plugin-react-hooks](https://npm.io/package/eslint-plugin-react-hooks.md) ^1.6.0

## Recent versions

- 2.2.1 (latest) — 2020-01-15
- 2.2.0 — 2020-01-14
- 2.1.3 — 2019-09-24
- 2.1.2 — 2019-09-03
- 2.1.1 — 2019-06-18
- 2.1.0 — 2019-04-03
- 2.0.0 — 2018-11-13
- 1.2.1 — 2018-07-06
- 1.1.0 — 2017-10-31
- 1.0.0 — 2017-10-30
- 0.6.0 — 2017-04-25
- 0.5.0 — 2017-04-25
- 0.4.1 — 2017-04-25
- 0.4.0 — 2017-04-25
- 0.3.0 — 2017-04-19
- … 2 more at https://npm.io/package/@endouble.com/eslint-config-endouble/versions

## README

# eslint-config-endouble
> Endouble's Javascript ESLint configuration, based on [AirBnB's](https://github.com/airbnb/javascript)

## Install and Usage

### 1. Installing
Make sure you have Node (>=6) installed

```bash
yarn add --dev @endouble.com/eslint-config-endouble
```

### 2. Using
Create an `.eslintrc.json` file at the root of your project and add the following configuration:

#### 2.1. Simple setup
> For vanilla Javascript code

```json
{
    "extends": "@endouble.com/eslint-config-endouble"
}
```

#### 2.2. React setup
> For React based apps

```json
{
    "extends": "@endouble.com/eslint-config-endouble/react"
}
```

#### 2.3. CSB setup
> For CSB websites

```json
{
    "extends": "@endouble.com/eslint-config-endouble/csb"
}
```

### 3. Extra configuration
Add to `package.json` a script to lint your desired files:

```json
{
    "scripts": {
        "lint": "eslint js/*.js"
    }
}
```

## Rules
Please refer to [AirBnB's Styleguide](https://github.com/airbnb/javascript) for more information about the linter's
rules.

### Custom rules
> This rules overwrite the ones inherited from AirBnB Styleguide

| setup | rule | setting |
|-------|------|---------|
| all | indent | 4 spaces, { SwitchCase: 1 } |
| all | max-len | 120 characters |
| all | object-curly-newline | error, { consistent: true } |
| react | react/jsx-indent | 4 spaces |
| react | react/jsx-indent-props | 4 spaces |
| react | react/jsx-filename-extension | off |
| react | react-hooks/rules-of-hooks | error |
| react | react-hooks/exhaustive-deps | warn |
| react | jsx-a11y/href-no-hash | off |
| react | jsx-a11y/label-has-for | error, { allowChildren: true } |
| react | jsx-a11y/anchor-is-valid | error, { specialLink: ['to'] } |
| react | import/no-extraneous-dependencies | error, { devDependencies: true } |
| react | import/no-unresolved | error, { commonjs: true, amd: true } |

## Tests
```bash
yarn test
```

## Maintainers
[Renan Couto](https://github.com/renancouto)

## License
MIT

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