EditorConfig Maven Plugin

A Maven plugin for checking whether project files comply with format rules defined in .editorconfig files and eventually also for fixing the violations

License	Apache License, Version 2.0
Categories	Maven Build Tools config Application Layer Libs Configuration
GroupId	org.ec4j.maven
ArtifactId	editorconfig-maven-plugin
Last Version	0.1.1
Release Date	Nov 27, 2020
Type	takari-maven-plugin
Description	EditorConfig Maven Plugin A Maven plugin for checking whether project files comply with format rules defined in .editorconfig files and eventually also for fixing the violations

Download editorconfig-maven-plugin

Filename	Size
editorconfig-maven-plugin-0.1.1.pom
editorconfig-maven-plugin-0.1.1.jar	16 KB
editorconfig-maven-plugin-0.1.1-sources.jar	8 KB

Dependencies

compile (2)

Group / Artifact	Type	Version
org.ec4j.linters : editorconfig-lint-api	jar
org.ec4j.linters : editorconfig-linters	jar

provided (4)

Group / Artifact	Type	Version
org.apache.maven : maven-plugin-api	jar	3.3.9
org.apache.maven : maven-project	jar	3.0-alpha-2
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.5
org.slf4j : slf4j-api	jar	1.7.5

test (3)

Group / Artifact	Type	Version
io.takari.maven.plugins : takari-plugin-testing	jar	2.9.2
io.takari.maven.plugins : takari-plugin-integration-testing	pom	2.9.2
junit : junit	jar	4.12

Project Modules

There are no modules declared in this project.

editorconfig-maven-plugin

editorconfig-maven-plugin is a Maven plugin for checking whether project files comply with format rules defined in .editorconfig files and eventually also for fixing the violations.

⚠️	editorconfig-maven-plugin is new. Expect issues of all kinds which is not to say that you should not report them :)

Basic usage

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-linters/blob/master/editorconfig-lint-api/src/main/java/org/ec4j/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

mvn editorconfig:format

Configuration

See editorconfig:check and editorconfig:format.

How it works

editorconfig-maven-plugin is designed around the Linter interface. Linter is a processor specialized for some particular file format (such as YAML or XML) for which it can detect whether some particular .editorconfig properties are satisfied and eventually propose a fix that can be applied automatically.

editorconfig-maven-plugin Table 1. Linters available in

Class name	Default includes	Default excludes	Supported .editorconfig properties
TextLinter	**/*		end_of_line, trim_trailing_whitespace, insert_final_newline
XmlLinter	**/*.xml, **/*.xsl		indent_style, indent_size

Contributions of further Linters are highly welcome! Please open an issue when you start working on something to avoid duplicate work.

How to build

Prerequisites:

• Java 7+

• Optionally Maven 3.5.0+, unless you want to use ./mvnw or mvnw.bat delivered by the project

The most common build with unit tests:

./mvnw clean install

On Windows:

.\mvnw.cmd clean install

Misc.

• All code and contributions are under Apache License

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

EditorConfig tools for Java

Versions

Version
0.1.1 Nov 27, 2020
0.1.0 May 8, 2020
0.0.11 Dec 23, 2019
0.0.10 Dec 22, 2018
0.0.9 Dec 7, 2018
0.0.8 Nov 6, 2018
0.0.7 Oct 28, 2018
0.0.6 Oct 3, 2018
0.0.5 Feb 6, 2018
0.0.4 Jan 28, 2018
0.0.3 Jan 21, 2018
0.0.2 Jan 11, 2018
0.0.1 Jan 3, 2018