Code Climate ESLint Engine
codeclimate-eslint is a Code Climate engine that wraps ESLint. You can run
it on your command line using the Code Climate CLI, or on our hosted analysis
There are a few major versions of ESLint out there. The latest major version is 4. This engine provides a few channels for major versions of ESLint.
This branch is for the
latest (i.e. default) channel and provides ESLint 3
For ESLint 4, please see
If you haven't already, install the Code Climate CLI
codeclimate engines:enable eslint. This command both installs the engine and enables it in your
You're ready to analyze! Browse into your project's folder and run
By default, this engine will emit both ESLint errors and warnings as Code
Climate issues. If you prefer, you can ignore warning-level violations by
ignore_warnings configuration option:
eslint: enabled: true config: ignore_warnings: true
If you're using a plugin like
will want to set this value to make sure the appropriate files are included:
eslint: enabled: true config: extensions: - .js - .html
By default, this engine will skip files that appear to be minified (average line length over 100). This feature can be disabled to include all files for analysis.
eslint: enabled: true config: sanitize_batch: false
For help with ESLint, check out their documentation.