# eslint-config-wrld-react

> WRLD ESLint configuration for React projects.

Latest version **1.1.0** (published 2020-06-16) · See https://github.com/wrld3d/eslint-config-wrld-react/blob/master/LICENSE.md license · 0 weekly downloads

## Install

```sh
npm install eslint-config-wrld-react
pnpm add eslint-config-wrld-react
yarn add eslint-config-wrld-react
bun add eslint-config-wrld-react
```

## 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.0 |
| Published | 2020-06-16 |
| First published | 2020-02-27 |
| Weekly downloads | 0 |
| License | See https://github.com/wrld3d/eslint-config-wrld-react/blob/master/LICENSE.md |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | WRLD |
| Maintainers | wrld |

## Links

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

## Dependencies (2)

- [eslint-plugin-node](https://npm.io/package/eslint-plugin-node.md) 11.x.x
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) 7.x.x

## Recent versions

- 1.1.0 (latest) — 2020-06-16
- 1.0.1 — 2020-02-27
- 1.0.0 — 2020-02-27

## README

# ESlint Config WRLD React

This project is an ESLint plugin that contains shared code styling rules for WRLD React projects.

## Installation

Make sure you have `eslint` >= 6 and `react` >= 16 installed. They are required as a peer dependency, so you need to install them yourself.

Install the plugin:

    npm install eslint-config-wrld-react

or

    yarn add eslint-config-wrld-react

Then configure your `.eslintrc.json` as follows:

```json
{
    "extends": ["wrld-react"],
    "rules": {
        ...custom rules
    }
}
```

## Running lint

To run eslint execute this from the root of your project:

```sh
eslint --ext .js --ext .jsx path/to/src -c .eslintrc.json
```

This can be configured as an npm/yarn script in your `package.json`:

```json
{
  ...
  "scripts": {
    "lint": "eslint --ext .js --ext .jsx path/to/src -c .eslintrc.json"
  },
  ...
}
```

So that then you can just run:

```sh
npm run lint
```

or 

```sh
yarn run lint
```

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