Repository files navigation

codeclimate-eslint is a Code Climate engine that wrapsESLint. You can runit on your command line using the Code Climate CLI, or on our hosted analysisplatform.

ESLint is a tool for identifying and reporting on patterns found inECMAScript/JavaScript code. It can be configured using aconfigurationfile.

There are a few major versions of ESLint out there. The latest major versionis 4. This engine provides a fewchannels for major versions of ESLint.

This branch is for thelatest (i.e. default) channel and provides ESLint 3support.

For ESLint 4, please seechannel/eslint-4 branch.

1. If you haven't already,install the Code Climate CLI

2. Runcodeclimate engines:enable eslint. This command both installs theengine and enables it in your.codeclimate.yml file

3. You're ready to analyze! Browse into your project's folder and runcodeclimate analyze

By default, this engine will emit both ESLint errors and warnings as CodeClimate issues. If you prefer, you can ignore warning-level violations bysetting theignore_warnings configuration option:

eslint:enabled:trueconfig:ignore_warnings:true

If you're using a plugin likeeslint-plugin-json oreslint-plugin-html, youwill want to set this value to make sure the appropriate files are included:

eslint:enabled:trueconfig:extensions:    -.js    -.html

By default, this engine will skip files that appear to be minified (average linelength over 100). This feature can be disabled to include all files foranalysis.

eslint:enabled:trueconfig:sanitize_batch:false

For help with ESLint,check out their documentation.

If you're running into a Code Climate issue, first look over this project'sGitHub Issues, as your question may have already been covered. If not,go ahead and open a support ticket with us.