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

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

Issue 29704603: Issue 5945 - Removed sudo suggestion from node module READMEs (Closed) Base URL: https://hg.adblockplus.org/codingtools
Patch Set: Created Feb. 21, 2018, 4:36 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 | stylelint-config-eyeo/README.md » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 # eslint-config-eyeo 1 # eslint-config-eyeo
2 2
3 An [ESLint](http://eslint.org) configuration that checks for compliance with the 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) 4 [Adblock Plus coding style guide](https://adblockplus.org/coding-style#javascrip t)
5 which is used for all eyeo projects. 5 which is used for all eyeo projects.
6 6
7 ## Installation 7 ## Installation
8 8
9 npm install -g eslint eslint-config-eyeo 9 npm install -g eslint eslint-config-eyeo
10 10
11 This command requires administrator privileges so you might need to use `sudo`.
12
13 ## Usage 11 ## Usage
14 12
15 To lint a JavaScript file using ESLint you run the `eslint` command with the 13 To lint a JavaScript file using ESLint you run the `eslint` command with the
16 file as an argument. For example: 14 file as an argument. For example:
17 15
18 eslint some-file.js 16 eslint some-file.js
19 17
20 For advanced usage see `eslint --help`. 18 For advanced usage see `eslint --help`.
21 19
22 In order to use eslint-config-eyeo your project's ESLint configuration 20 In order to use eslint-config-eyeo your project's ESLint configuration
23 should extend from it. A minimal example looks like this: 21 should extend from it. A minimal example looks like this:
24 22
25 { 23 {
26 "extends": "eslint-config-eyeo", 24 "extends": "eslint-config-eyeo",
27 "root": true 25 "root": true
28 } 26 }
29 27
30 For projects without an ESLint configuration you can create your own 28 For projects without an ESLint configuration you can create your own
31 personal configuration in `~/.eslintrc.json`, but take care to remove 29 personal configuration in `~/.eslintrc.json`, but take care to remove
32 the `"root": true` section from the above example. 30 the `"root": true` section from the above example.
OLDNEW
« no previous file with comments | « no previous file | stylelint-config-eyeo/README.md » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld