EditorConfig Maven Plugin Parent

See editorconfig-maven-plugin

License	Apache License, Version 2.0
Categories	Maven Build Tools config Application Layer Libs Configuration
GroupId	org.ec4j.maven
ArtifactId	editorconfig-maven-plugin-parent
Last Version	0.1.1
Release Date	Nov 27, 2020
Type	pom
Description	EditorConfig Maven Plugin Parent See editorconfig-maven-plugin
Project URL	https://github.com/ec4j/editorconfig-maven-plugin
Source Code Management	https://github.com/ec4j/editorconfig-maven-plugin

Download editorconfig-maven-plugin-parent

Filename	Size
editorconfig-maven-plugin-parent-0.1.1.pom	24 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.ec4j.maven/editorconfig-maven-plugin-parent/ -->
<dependency>
    <groupId>org.ec4j.maven</groupId>
    <artifactId>editorconfig-maven-plugin-parent</artifactId>
    <version>0.1.1</version>
    <type>pom</type>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.ec4j.maven/editorconfig-maven-plugin-parent/
implementation 'org.ec4j.maven:editorconfig-maven-plugin-parent:0.1.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.ec4j.maven/editorconfig-maven-plugin-parent/
implementation ("org.ec4j.maven:editorconfig-maven-plugin-parent:0.1.1")

Apache Buildr

'org.ec4j.maven:editorconfig-maven-plugin-parent:pom:0.1.1'

Apache Ivy

<dependency org="org.ec4j.maven" name="editorconfig-maven-plugin-parent" rev="0.1.1">
  <artifact name="editorconfig-maven-plugin-parent" type="pom" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.ec4j.maven', module='editorconfig-maven-plugin-parent', version='0.1.1')
)

Scala SBT

libraryDependencies += "org.ec4j.maven" % "editorconfig-maven-plugin-parent" % "0.1.1"

Leiningen

[org.ec4j.maven/editorconfig-maven-plugin-parent "0.1.1"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

• editorconfig-maven-plugin

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