# eslint-config-vizzuality

> This package provides Vizzuality's .eslintrc as an extensible shared config.

Latest version **1.3.0** (published 2019-01-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-config-vizzuality
pnpm add eslint-config-vizzuality
yarn add eslint-config-vizzuality
bun add eslint-config-vizzuality
```

## 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.3.0 |
| Published | 2019-01-09 |
| First published | 2017-02-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 55.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | David Inga |
| Maintainers | andres.gonzalez, clementprdhomme, davidsingal, edbrett, mbarrenechea, pablopareja, sorodrigo |
| Keywords | eslint, vizzuality |

## Links

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

## 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.3.0 (latest) — 2019-01-09
- 1.2.0 — 2018-10-15
- 1.1.7 — 2018-07-31
- 1.1.6 — 2018-07-27
- 1.1.5 — 2018-07-27
- 1.0.14 — 2018-02-16
- 1.0.13 — 2018-02-15
- 1.0.12 — 2018-02-15
- 1.0.11 — 2018-02-15
- 1.0.10 — 2018-02-15
- 1.0.9 — 2017-12-28
- 1.0.8 — 2017-12-28
- 1.0.7 — 2017-09-21
- 1.0.6 — 2017-08-14
- 1.0.5 — 2017-05-23
- … 2 more at https://npm.io/package/eslint-config-vizzuality/versions

## README

# eslint-config-vizzuality

This package provides Vizzuality's .eslintrc as an extensible shared config.

## Usage

We export three ESLint configurations for your usage.

## Install

Unsing npm:

```bash
npx install-peerdeps --dev eslint-config-vizzuality
npm install --save-dev eslint-config-vizzuality
```

Using yarn:

```bash
yarn add eslint@5.7.0 \
  eslint-config-airbnb@17.1.0 \
  eslint-plugin-import@2.14.0 \
  eslint-plugin-jsx-a11y@6.1.1 \
  eslint-plugin-react@7.11.0 \
  eslint-config-vizzuality@latest \
  --dev
```

Add `"extends": "vizzuality"` to your .eslintrc

Example of `.eslintrc.json`:

```json
{
  "env": {
    "browser": true,
    "node": true,
    "es6": true
  },
  "extends": [
    "vizzuality"
  ]
}
```

Add script to in your `package.json`:

```json
{
  "scripts": {
    ...
    "lint": "eslint --ext .js --ext .jsx ."
  }
}
```

And execute eslint running:

```bash
yarn lint
```

## Recommendations

### Pre-commit hooks

As a good practice running eslint only in git staged files using (lint-staged)[https://github.com/okonet/lint-staged] will have quicker analysis and ensure quality in each commit.

And it is as easy as install the dependency:

```bash
npm install lint-staged
```

or

```bash
yarn add lint-staged
```

And add the following code to the `package.json`:

```json
  "scripts": {
    "precommit": "lint-staged"
  },
  "lint-staged": {
    "**/*.js": [
      "eslint --quiet --fix",
      "git add"
    ]
  },
```

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