# @eigenspace/eslint-config-codestyle

> Includes eslint shareable configs.

Latest version **1.1.2** (published 2019-09-10) · MIT license · 0 weekly downloads

## Install

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

## 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.1.2 |
| Published | 2019-09-10 |
| First published | 2019-08-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 16.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | eigenspace |

## Links

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

## Dependencies (3)

- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) 7.14.3
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) 3.1.0
- [eslint-plugin-react-redux](https://npm.io/package/eslint-plugin-react-redux.md) 3.0.1

## Recent versions

- 1.1.2 (latest) — 2019-09-10
- 1.1.1 — 2019-08-29
- 1.1.0 — 2019-08-05
- 1.0.0 — 2019-08-05

## README

Includes eslint shareable configs. 

# Installation

1. Create `.eslintrc.js` in project root or choose already existing.
2. Add `@eigenspace/codestyle` as dev dependency.
3. Then add this below <sup>(1)</sup>:
    ```
    "@eigenspace/eslint-config-codestyle": "file:node_modules/@eigenspace/codestyle/packages/eslint"
    ``` 
4. `yarn install`
5. Extends configurations on `.eslintrc` file:
    ```
    extends: [
        '@eigenspace/codestyle/base',
        '@eigenspace/codestyle/react'
    ]
    ```
   
    Note: `react` is optional. Use it only if your project uses `React`.
6. In IDE settings turn on `eslint` and specify `eslint` path.   

<sup>(1)</sup> 
We are forced to load it from codestyle project as subpackage because of satisfaction of 
[requirement for naming shareable configs](https://eslint.org/docs/developer-guide/shareable-configs).
      
# Project structure

```
base.js - Base configuration and rules for eslint
react.js - Configuration includes codestyle React rules
redux.js - Configuration includes codestyle Redux rules
```

# Environmental requirements

* `react`: `16.x`

# Why do we have that dependencies?

* `eslint-plugin-prettier` - plugin for linting styles.
* `eslint-plugin-react` - React plugin for ESLint.
* `eslint-plugin-react-redux` - Redux plugin for ESLint.

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