1 | # eslint-config-dollarshaveclub [![Build Status](https://travis-ci.org/dollarshaveclub/eslint-config-dollarshaveclub.svg?branch=master)](https://travis-ci.org/dollarshaveclub/eslint-config-dollarshaveclub) [![Greenkeeper badge](https://badges.greenkeeper.io/dollarshaveclub/eslint-config-dollarshaveclub.svg)](https://greenkeeper.io/)
|
2 |
|
3 | > ESLint [shareable config](http://eslint.org/docs/developer-guide/shareable-configs.html) for Dollar Shave Club.
|
4 |
|
5 |
|
6 | ## Installation
|
7 |
|
8 | ```
|
9 | $ npm install --save-dev eslint@3 eslint-config-dollarshaveclub
|
10 | ```
|
11 |
|
12 |
|
13 | ## Usage
|
14 |
|
15 | Once the `eslint-config-dollarshaveclub` package is installed, you can use it by specifying `dollarshaveclub`, `dollarshaveclub/ember`, or `dollarshaveclub/react` 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).
|
16 |
|
17 | For frameworkless JS modules:
|
18 |
|
19 | ```js
|
20 | {
|
21 | "extends": "dollarshaveclub",
|
22 | "rules": {
|
23 | // Additional, per-project rules...
|
24 | }
|
25 | }
|
26 | ```
|
27 |
|
28 | For Ember projects:
|
29 |
|
30 | ```js
|
31 | {
|
32 | "extends": "dollarshaveclub/ember"
|
33 | }
|
34 | ```
|
35 |
|
36 | For React projects:
|
37 |
|
38 | ```js
|
39 | {
|
40 | "extends": "dollarshaveclub/react"
|
41 | }
|
42 | ```
|
43 |
|
44 | ## License
|
45 |
|
46 | MIT
|