EditorConfig

Checks: 5
Categories: Style
EditorConfig version: 0.13.2 (newer versions available using beta channel)

EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs. The Code Climate EditorConfig plugin will validate your project files with your .editorconfig configuration.

Enable the Plugin

To enable EditorConfig analysis, add the following to your .codeclimate.yml configuration file:

plugins:
  editorconfig:
    enabled: true

By default, we'll use our stable version of EditorConfig, which runs EditorConfig 0.13.2. To enable a newer version (EditorConfig 1.0.1), you'll need to specify the beta channel in your .codeclimate.yml.

plugins:
  editorconfig:
    enabled: true
    channel: beta

More information about the CLI is available in the README here: https://github.com/codeclimate/codeclimate

Configure the Plugin

You can customize the EditorConfig configuration file name, under the engine's config in your .codeclimate.yml file:

plugins:
  editorconfig:
    enabled: true
    channel: beta
    config:
      editorconfig: .editorconfig

Understand the Plugin

Consult the official EditorConfig documentation for more information about the EditorConfig tool.