Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Side by Side Diff: eslint-config-eyeo/README.md

Issue 29374555: Issue 3692 - Add base ESLint configuration (Closed)
Patch Set: Addressed Sebastian's feedback Created Feb. 10, 2017, 7:09 p.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « no previous file | eslint-config-eyeo/index.js » ('j') | eslint-config-eyeo/index.js » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 # eslint-config-eyeo
2
3 An [ESLint](http://eslint.org) configuration that checks for compliance with the
4 [Adblock Plus coding style guide](https://adblockplus.org/coding-style#javascrip t)
5 which is used for all eyeo projects.
6
7 ## Installation
8
9 npm install -g eslint eslint-config-eyeo
10
11 (As root, or using sudo.)
12
13 ## Usage
14
15 To lint a JavaScript file using ESLint you simply run the `eslint` command with
16 the file as an argument. For example:
17
18 eslint some-file.js
19
20 (For advanced usage see `eslint --help`.)
21
22 All of our projects which use much JavaScript should eventually have
23 their own ESLint configuration which inherits from this base
24 configuration. A minimal example:
25
26 {
27 "extends": "eslint-config-eyeo",
28 "root": true
29 }
30
31 In the mean time if you need to lint files inside projects which do
Sebastian Noack 2017/02/12 20:53:11 I don't like the duplication here. How about: I
kzar 2017/02/13 06:02:58 OK, I've had another go. What do you think?
32 not yet have an ESLint configuration you can create a personal
33 configuration in `~/.eslintrc.json` like so:
34
35 {
36 "extends": "eslint-config-eyeo"
37 }
OLDNEW
« no previous file with comments | « no previous file | eslint-config-eyeo/index.js » ('j') | eslint-config-eyeo/index.js » ('J')

Powered by Google App Engine
This is Rietveld