1 # Pronto runner for ESLint (using eslint from npm)
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)
7 Pronto runner for [ESlint](http://eslint.org), pluggable linting utility for JavaScript and JSX. [What is Pronto?](https://github.com/mmozuras/pronto)
9 Uses official eslint executable installed by `npm` in contrast to [pronto-eslint][pronto-eslint].
11 [pronto-eslint]: https://github.com/mmozuras/pronto-eslint
15 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)).
17 [eslint-install]: http://eslint.org/docs/user-guide/getting-started
19 ## Configuration of ESLint
21 Configuring ESLint via [.eslintrc and consorts][eslintrc] and excludes via [.eslintignore][eslintignore] will work just fine with pronto-eslint-npm.
23 [eslintrc]: http://eslint.org/docs/user-guide/configuring#configuration-file-formats
25 [eslintignore]: http://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories
27 ## Configuration of ESLintNPM
29 pronto-eslint-npm can be configured by placing a `.pronto_eslint_npm.yml` inside the directory where pronto is run.
31 Following options are available:
33 | Option | Meaning | Default |
34 | ----------------- | ---------------------------------------------------------------------------------------- | ----------------------------------- |
35 | eslint_executable | ESLint executable to call. | `eslint` (calls `eslint` in `PATH`) |
36 | files_to_lint | What files to lint. Absolute path of offending file will be matched against this Regexp. | `(\.js|\.es6)$` |
37 | cmd_line_opts | Command line options to pass to eslint when running | '' |
39 Example configuration to call custom eslint executable and only lint files ending with `.my_custom_extension`:
42 # .pronto_eslint_npm.yml
43 eslint_executable: '/my/custom/node/path/.bin/eslint'
44 files_to_lint: '\.my_custom_extension$'
45 cmd_line_opts: '--ext .html,.js,.es6'