# eslint-config-ivweb

[![npm package](https://img.shields.io/npm/v/eslint-config-ivweb.svg?style=flat-square)](https://www.npmjs.org/package/eslint-config-ivweb)
[![NPM downloads](http://img.shields.io/npm/dt/eslint-config-ivweb.svg?style=flat-square)](https://npmjs.org/package/eslint-config-ivweb)

ESLint shareable config for the IVWEB JavaScript style guide.

[中文 README](README-zh_CN.md)

## Installation

```
$ npm install --save-dev eslint eslint-plugin-react eslint-config-ivweb
```

## Documents
* Introduction: [eslint-standard.md](docs/eslint-standard.md)
* Rules explanation: [RULES.md](docs/RULE.md)

## Usage

Once the `eslint-config-ivweb` package is installed, you can use it by specifying `ivweb` in the [`extends`](http://eslint.org/docs/user-guide/configuring#extending-configuration-files) section of your [ESLint configuration](http://eslint.org/docs/user-guide/configuring).

```js
{
  "extends": "ivweb",
  "rules": {
    // Additional, per-project rules...
  }
}
```

### Using the `ivweb` config with `eslint:recommended`

There are several rules in the [`eslint:recommended` ruleset](http://eslint.org/docs/rules/) that IVWEB style is not opinionated about that you might want to enforce in your project.

To use IVWEB style in conjunction with ESLint's recommended rule set, extend them both, making sure to list `ivweb` last:

```js
{
  "extends": ["eslint:recommended", "plugin:react/recommended", "ivweb"],
  "rules": {
    // Additional, per-project rules...
  }
}
```

To see how the `ivweb` config compares with `eslint:recommended`, refer to the [source code of `index.js`](https://github.com/iv-web/eslint-config-ivweb/blob/master/index.js), which lists every ESLint rule along with whether (and how) it is enforced by the `ivweb` config.

## Contributing

1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
2. Fork [the repository](https://github.com/iv-web/eslint-config-ivweb)_ on GitHub to start making your changes to the **master** branch (or branch off of it).
3. Write a test which shows that the bug was fixed or that the feature works as expected.
4. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to [AUTHORS_](AUTHORS).

## License

Apache-2 © IVWEB