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 platform.

ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. It can be configured using a configuration file.

Installation

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

2. Run codeclimate engines:enable eslint. This command both installs the engine and enables it in your .codeclimate.yml file

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

Configuration

ignore_warnings

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 setting the ignore_warnings configuration option:

eslint:
  enabled: true
  config:
    ignore_warnings: true

Need help?

For help with ESLint, check out their documentation.

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