aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorMarkus Doits <markus.doits@stellenticket.de>2016-09-11 15:26:57 +0200
committerMarkus Doits <markus.doits@stellenticket.de>2016-09-11 15:37:20 +0200
commitcf6aab4b07d51f2d5f83609ab7112ee9ed5bd1b2 (patch)
tree6ac6f214322e3c311aaa832727ab70ed7db758eb
parent1845f2e31adc6f9b1513b779f44e3bd347d6fd11 (diff)
downloadpronto-hlint-cf6aab4b07d51f2d5f83609ab7112ee9ed5bd1b2.tar.gz
pronto-hlint-cf6aab4b07d51f2d5f83609ab7112ee9ed5bd1b2.tar.zst
pronto-hlint-cf6aab4b07d51f2d5f83609ab7112ee9ed5bd1b2.zip
small readme formatting and wording [CI SKIP]
-rw-r--r--README.md19
1 files changed, 9 insertions, 10 deletions
diff --git a/README.md b/README.md
index 9ee2e19..5e53859 100644
--- a/README.md
+++ b/README.md
@@ -7,19 +7,19 @@
7 7
8Pronto runner for [ESlint](http://eslint.org), pluggable linting utility for JavaScript and JSX. [What is Pronto?](https://github.com/mmozuras/pronto) 8Pronto runner for [ESlint](http://eslint.org), pluggable linting utility for JavaScript and JSX. [What is Pronto?](https://github.com/mmozuras/pronto)
9 9
10Uses system wide installed eslint in contrast to [pronto-eslint][pronto-eslint]. 10Uses official eslint executable installed by `npm` in contrast to [pronto-eslint][pronto-eslint].
11 11
12[pronto-eslint]: https://github.com/mmozuras/pronto-eslint 12[pronto-eslint]: https://github.com/mmozuras/pronto-eslint
13 13
14## Prerequisites 14## Prerequisites
15 15
16You'll need to install [eslint by yourself with npm][eslint-install]. 16You'll need to install [eslint by yourself with npm][eslint-install]. If `eslint` is in your `PATH`, everything will simply work, otherwise you have to provide pronto-eslint-npm your custom executable path (see [below](#configuration-of-eslintnpm)).
17 17
18[eslint-install]: http://eslint.org/docs/user-guide/getting-started 18[eslint-install]: http://eslint.org/docs/user-guide/getting-started
19 19
20## Configuration of ESLint 20## Configuration of ESLint
21 21
22Configuring ESLint via [.eslintrc and consorts][eslintrc] and excludes via [.eslintignore][eslintignore] will work just fine with pronto-eslint. 22Configuring ESLint via [.eslintrc and consorts][eslintrc] and excludes via [.eslintignore][eslintignore] will work just fine with pronto-eslint-npm.
23 23
24[eslintrc]: http://eslint.org/docs/user-guide/configuring#configuration-file-formats 24[eslintrc]: http://eslint.org/docs/user-guide/configuring#configuration-file-formats
25 25
@@ -27,20 +27,19 @@ Configuring ESLint via [.eslintrc and consorts][eslintrc] and excludes via [.esl
27 27
28## Configuration of ESLintNPM 28## Configuration of ESLintNPM
29 29
30Pronto::ESLintNPM can be configured by placing a `.pronto_eslint_npm.yml` inside the directory 30pronto-eslint-npm can be configured by placing a `.pronto_eslint_npm.yml` inside the directory where pronto is run.
31where pronto is run.
32 31
33Following options are available: 32Following options are available:
34 33
35| Option | Meaning | Default | 34| Option | Meaning | Default |
36| ----------------- | --------------------------------------------------------------------------------- | ----------------------------------- | 35| ----------------- | ---------------------------------------------------------------------------------------- | ----------------------------------- |
37| eslint_executable | ESLint executable to call | `eslint` (calls `eslint` in `PATH`) | 36| eslint_executable | ESLint executable to call. | `eslint` (calls `eslint` in `PATH`) |
38| files_to_lint | What files to lint. Absolute path of the file will be matched against this regexp | `(\.js|\.es6)$` | 37| files_to_lint | What files to lint. Absolute path of offending file will be matched against this Regexp. | `(\.js|\.es6)$` |
39 38
40Example configuration to call custom eslint executable and only lint files ending with `.my_custom_extension`: 39Example configuration to call custom eslint executable and only lint files ending with `.my_custom_extension`:
41 40
42```yaml 41```yaml
43# .pronto_eslint_npm.yaml 42# .pronto_eslint_npm.yaml
44eslint_executable: '/my/cusom/node/path/.bin/eslint' 43eslint_executable: '/my/custom/node/path/.bin/eslint'
45files_to_lint: '\.my_custom_extension$' 44files_to_lint: '\.my_custom_extension$'
46``` 45```