https://github.com/editorconfig/editorconfig-maven-plugin

Maven plugin for .editorconfig enforcement
https://github.com/editorconfig/editorconfig-maven-plugin

Last synced: about 1 year ago
JSON representation

Maven plugin for .editorconfig enforcement

• Host: GitHub
• URL: https://github.com/editorconfig/editorconfig-maven-plugin
• Owner: editorconfig
• License: mit
• Created: 2024-10-12T19:41:39.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2025-06-02T17:06:21.000Z (about 1 year ago)
• Last Synced: 2025-06-03T07:12:23.781Z (about 1 year ago)
• Language: Java
• Size: 363 KB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# TL;DR

Official maven plugin for enforcement of rules defined in the `.editorconfig` files.

Example of plugin usage can be seen below. The configuration settings and plugin goal will be explained in the sections below:

```(xml)

    org.editorconfig

    editorconfig-maven-plugin

    1.0.0-alpha1

    

        

            

                check

            

            compile

        

        

            .editorconfig

        

    

```

The latest version of the plugin can be looked up in [Maven Central](https://mvnrepository.com/search?q=org.editorconfig)

## Available Goals

Currently, the plugin has the following Maven goals available:

| Goal  | Default Phase | Description                                                                                                                      |

|-------|---------------|----------------------------------------------------------------------------------------------------------------------------------|

| check | validate      | This goal checks (by default) all the files in the project for compliance with rules, defined in the appropriate `.editorconfig` |

## Configuration Parameters

The plugin has several configuration parameters

| Parameter                    | Description                                                                                                                                                                                                                                                                                                          | Default Value  |

|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|

| rootEditorConfigFileLocation | The location of the **root** `.editorconfig` from the **your projects Maven basedir**                                                                                                                                                                                                                                | No default     |

| strictMode                   | Whether or not to run the plugin execution in the _strict mode_. The "strict mode" means that error in the `.editorconfig` file (invalid options or their values, inlaid glob expressions etc) **will NOT** be ignored and the plugin execution **will fail** in case errors in `.editorconfig` file parsing are met | true           | 

## Supported pairs

This plugin supports **all** the key value pairs defined in the official [EditorConfig specification](https://spec.editorconfig.org/), except for the `spelling_language`. 

The reason for that is that this setting is mostly intended for the use of the code editors and IDEs, rather than the build plugins.