]>
Commit | Line | Data |
---|---|---|
5001cb27 | 1 | # Pronto runner for ESLint (using eslint from npm) |
ce89f9ed | 2 | |
126fe1e2 MD |
3 | [![Code Climate](https://codeclimate.com/github/doits/pronto-eslint_npm.svg)](https://codeclimate.com/github/doits/pronto-eslint_npm) |
4 | [![Build Status](https://travis-ci.org/doits/pronto-eslint_npm.svg?branch=master)](https://travis-ci.org/doits/pronto-eslint_npm) | |
5 | [![Gem Version](https://badge.fury.io/rb/pronto-eslint_npm.svg)](http://badge.fury.io/rb/pronto-eslint_npm) | |
6 | [![Dependency Status](https://gemnasium.com/doits/pronto-eslint_npm.svg)](https://gemnasium.com/doits/pronto-eslint_npm) | |
ce89f9ed MM |
7 | |
8 | Pronto runner for [ESlint](http://eslint.org), pluggable linting utility for JavaScript and JSX. [What is Pronto?](https://github.com/mmozuras/pronto) | |
9 | ||
cf6aab4b | 10 | Uses official eslint executable installed by `npm` in contrast to [pronto-eslint][pronto-eslint]. |
5001cb27 | 11 | |
1d19d52c | 12 | [pronto-eslint]: https://github.com/mmozuras/pronto-eslint |
5001cb27 | 13 | |
ce89f9ed MM |
14 | ## Prerequisites |
15 | ||
cf6aab4b | 16 | You'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)). |
c2307793 MD |
17 | |
18 | [eslint-install]: http://eslint.org/docs/user-guide/getting-started | |
ce89f9ed | 19 | |
1845f2e3 | 20 | ## Configuration of ESLint |
ce89f9ed | 21 | |
cf6aab4b | 22 | Configuring ESLint via [.eslintrc and consorts][eslintrc] and excludes via [.eslintignore][eslintignore] will work just fine with pronto-eslint-npm. |
676cea90 | 23 | |
c2307793 | 24 | [eslintrc]: http://eslint.org/docs/user-guide/configuring#configuration-file-formats |
1845f2e3 | 25 | |
676cea90 | 26 | [eslintignore]: http://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories |
1845f2e3 MD |
27 | |
28 | ## Configuration of ESLintNPM | |
29 | ||
cf6aab4b | 30 | pronto-eslint-npm can be configured by placing a `.pronto_eslint_npm.yml` inside the directory where pronto is run. |
1845f2e3 MD |
31 | |
32 | Following options are available: | |
33 | ||
cf6aab4b MD |
34 | | Option | Meaning | Default | |
35 | | ----------------- | ---------------------------------------------------------------------------------------- | ----------------------------------- | | |
36 | | eslint_executable | ESLint executable to call. | `eslint` (calls `eslint` in `PATH`) | | |
37 | | files_to_lint | What files to lint. Absolute path of offending file will be matched against this Regexp. | `(\.js|\.es6)$` | | |
1845f2e3 MD |
38 | |
39 | Example configuration to call custom eslint executable and only lint files ending with `.my_custom_extension`: | |
40 | ||
41 | ```yaml | |
42 | # .pronto_eslint_npm.yaml | |
cf6aab4b | 43 | eslint_executable: '/my/custom/node/path/.bin/eslint' |
1845f2e3 MD |
44 | files_to_lint: '\.my_custom_extension$' |
45 | ``` |