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

Unified Diff: eslint-config-eyeo/README.md

Issue 29374555: Issue 3692 - Add base ESLint configuration (Closed)
Patch Set: Turn no-shadow back on Created Feb. 13, 2017, 1 p.m.
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | eslint-config-eyeo/index.js » ('j') | eslint-config-eyeo/index.js » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: eslint-config-eyeo/README.md
diff --git a/eslint-config-eyeo/README.md b/eslint-config-eyeo/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..ab0b463c45babb5e44b13cfb5111525c44201860
--- /dev/null
+++ b/eslint-config-eyeo/README.md
@@ -0,0 +1,32 @@
+# eslint-config-eyeo
+
+An [ESLint](http://eslint.org) configuration that checks for compliance with the
+[Adblock Plus coding style guide](https://adblockplus.org/coding-style#javascript)
+which is used for all eyeo projects.
+
+## Installation
+
+ npm install -g eslint eslint-config-eyeo
+
+(As root, or using sudo.)
Wladimir Palant 2017/02/14 12:43:20 Nit: I'm not a big fan of having an entire sentenc
kzar 2017/02/15 05:24:22 (Done.)
+
+## Usage
+
+To lint a JavaScript file using ESLint you simply run the `eslint` command with
Wladimir Palant 2017/02/14 12:43:20 Nit: Please avoid using the word "simply" in instr
kzar 2017/02/15 05:24:22 Good point, Done.
+the file as an argument. For example:
+
+ eslint some-file.js
+
+(For advanced usage see `eslint --help`.)
Wladimir Palant 2017/02/14 12:43:20 Nit: Parentheses are unnecessary here.
kzar 2017/02/15 05:24:22 Done.
+
+In order to use eslint-config-eyeo your project's ESLint configuration
+should extend from it. A minimal example looks like this:
+
+ {
+ "extends": "eslint-config-eyeo",
+ "root": true
+ }
+
+(For projects without an ESLint configuration you can create your own
+personal configuration in `~/.eslintrc.json`, but take care to remove
+the `"root": true` section from the above example.)
Wladimir Palant 2017/02/14 12:43:20 Nit: Parentheses are unnecessary here.
kzar 2017/02/15 05:24:22 Done.
« 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