editorconfig-maven-plugin is a Maven plugin for checking whether project files comply with format rules
.editorconfig files and eventually also for fixing the violations.
editorconfig-maven-plugin requires Java 7+ and Maven 3.3.1+.
To make the build fail if any of your source files does not comply with
.editorconfig rules, add the following to your project:
<plugin> <groupId>org.ec4j.maven</groupId> <artifactId>editorconfig-maven-plugin</artifactId> <version><!-- check the latest on http://central.maven.org/maven2/org/ec4j/maven/editorconfig-maven-plugin/ --></version> <executions> <execution> <id>check</id> <phase>verify</phase> <goals> <goal>check</goal> </goals> </execution> </executions> <configuration> <!-- See http://ec4j.github.io/editorconfig-maven-plugin/ for full configuration reference --> <excludes> <!-- Note that maven submodule directories and many non-source file patterns are excluded by default --> <!-- - see https://github.com/ec4j/editorconfig-maven-plugin/blob/master/ec4j-lint-api/src/main/java/org/ec4j/maven/lint/api/Constants.java#L37 <!-- You can exclude further files from processing: --> <exclude>src/main/**/*.whatever</exclude> </excludes> <!-- All files are included by default: <includes> <include>**</include> </includes> --> </configuration> </plugin>
In case any violations are detected, you may want to fix them automagically by running
How it works
editorconfig-maven-plugin is designed around the Linter interface.
is a processor specialized for some particular file format (such as YAML or XML) for which it can detect whether some
.editorconfig properties are satisfied and eventually propose a
fix that can
be applied automatically.
|Class name||Default includes||Default excludes||Supported
Contributions of further Linters are highly welcome! Please open an issue when you start working on something to avoid duplicate work.
How to build
Optionally Maven 3.5.0+, unless you want to use
mvnw.batdelivered by the project
The most common build with unit tests:
./mvnw clean install
.\mvnw.cmd clean install
All code and contributions are under Apache License
Issues and Discussions: https://github.com/ec4j/editorconfig-maven-plugin/issues