# @wpquark/eslint-config

> Shared ESLint config used within WPQuark

Latest version **3.2.0** (published 2019-02-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @wpquark/eslint-config
pnpm add @wpquark/eslint-config
yarn add @wpquark/eslint-config
bun add @wpquark/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 | 3.2.0 |
| Published | 2019-02-07 |
| First published | 2018-05-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 21.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Swashata Ghosh |
| Maintainers | swashata |

## Links

- npm: https://www.npmjs.com/package/@wpquark/eslint-config
- Repository: git@github.com:WPQuark/eslint-config
- npm.io page: https://npm.io/package/@wpquark/eslint-config

## Dependencies (9)

- [babel-eslint](https://npm.io/package/babel-eslint.md) ^10.0.1
- [eslint-plugin-jest](https://npm.io/package/eslint-plugin-jest.md) ^22.2.2
- [eslint-plugin-babel](https://npm.io/package/eslint-plugin-babel.md) ^5.3.0
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.12.4
- [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.16.0
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^4.0.0
- [eslint-plugin-jsx-a11y](https://npm.io/package/eslint-plugin-jsx-a11y.md) ^6.2.1
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) ^3.0.1

## Recent versions

- 3.2.0 (latest) — 2019-02-07
- 3.1.0 — 2019-02-07
- 3.0.0 — 2018-09-17
- 2.0.1 — 2018-08-03
- 2.0.0 — 2018-08-03
- 1.0.1 — 2018-05-26
- 1.0.0 — 2018-05-26
- 0.0.1 — 2018-05-26

## README

<p align="center">
	<img src="https://raw.githubusercontent.com/WPQuark/eslint-config/master/logo-circular-512x512.png" alt="WPQuark Logo" height="128" width="128" />
</p>
<h1 align="center">WPQuark Eslint Config</h1>

[![npm version](https://badge.fury.io/js/%40wpquark%2Feslint-config.svg)](https://badge.fury.io/js/%40wpquark%2Feslint-config)

A shared eslint config for WPQuark projects. It uses both eslint and prettier
for auto-fixable codes along with linting.

## Installation

Add to project's `devDependency`.

```bash
yarn add @wpquark/eslint-config eslint prettier --dev
```

### ESLint Config

Now create a `.eslintrc` file in the root of your project and put the code.

```json
{
	"extends": "@wpquark"
}
```

You can also extend upon the rules.

### Prettier Config

Create a `prettier.config.js` file in the root of your project and put the code.

```js
const config = require('@wpquark/eslint-config/prettier.config.js');
module.exports = config;
```

Now you are ready to go.

## VSCode Integration

Install the [eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
plugin for VSCode. Enable autoFormat for `javascript` and `javascriptreact` files.

-   Go to Code > Preference [File > Preference for Windows & Linux].
-   Edit the WorkSpace Settings (Recommended).

```json
{
	"eslint.autoFixOnSave": true,
	"[javascript]": {
		"editor.formatOnSave": false
	},
	"[javascriptreact]": {
		"editor.formatOnSave": false
	}
}
```

## Changelog

### `v3.2.0`

-   Upgrade dependencies to latest.
-   Add eslint-plugin-babel to the mix.

### `v3.0.0`

-   Upgrade dependencies to latest.
-   Now airbnb eslint config supports eslint `^5.3.0`.

### `v2.0.1`

-   Breaking: prettier is now a peerDependency.
-   Upgrade `babel-eslint` parser to `9.x-beta`.
-   Upgrade other packages to latest stable.

### `v1.0.1`

-   Initial Release.

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