editorconfig-gradle-plugin is a Gradle plugin for checking whether project files comply with format rulesdefined in.editorconfig files and eventually also for fixing the violations.

editorconfig-gradle-plugin requires Java 8+ and Gradle 4.1+.

To apply the plugin, add the following to your project:

After that, you can check whether your source files comply with.editorconfig rules:

In case any violations are detected, you may want to fix them automagically by running

You also may want to bind theeditorconfigCheck to some other task existing in your project. E.g. if you havejavaplugin in your project, binding tocheck task is quite natural:

There iseditorconfig extension object. Its properties are documented in theEditorconfigExtensionclass.

editorconfig-gradle-plugin is using the same libraries as its siblingeditorconfig-maven-plugin:org.ec4j.maven:ec4j-lint-api andorg.ec4j.maven:ec4j-linters. They are designed around the Linter interface.Linteris a processor specialized for some particular file format (such as YAML or XML) for which it can detect whether someparticular.editorconfig properties are satisfied and eventually propose afix that canbe applied automatically.

Contributions of further Linters are highly welcome! Pleaseopen an issue when you start working on something to avoidduplicate work.

Prerequisites:

• Java 8+

The most common build with unit tests:

On Windows:

• All code and contributions are underApache License

• Issues and Discussions:https://github.com/ec4j/editorconfig-gradle-plugin/issues