DOCSEARCHbyAlgolia
Submit Docs

formatter-maven-plugin

repository·main·Indexed 43 days ago

https://github.com/revelc/formatter-maven-plugin

A Maven plugin that automates code formatting and verification using the Eclipse code formatter to ensure consistent style across a project. Supports JDK 8 (v2.16.x), JDK 11 (v2.17.x+), and JDK 17 (v2.24.x+).

Tokens
286
Snippets
0
Records
4
Agent score
5%

What's inside formatter-maven-plugin

  1. Overview of formatter-maven-plugin

    main
    The formatter-maven-plugin provides a mechanism to automatically (re)format your Maven project during a build or to verify its formatting. Its primary goal is to ensure consistent code style across a project, regardless of individual developer preferences or IDE settings. It uses the Eclipse code formatter for Java and supports formatting for other file types.

  2. Correlate plugin versions with Eclipse versions

    main
    If you need to ensure your plugin version matches a specific Eclipse version used by your team, you can check the compatibility list on the project website to see which plugin versions correspond to which Eclipse versions.

  3. How to use formatter-maven-plugin

    main

    To use the plugin in your Maven project, refer to the official Maven plugin documentation for the latest release to see configuration options and goal usage.

    For Eclipse users looking to integrate this with their IDE, there is a companion project called formatter-m2e-configurator.

  4. Check JDK requirements for formatter-maven-plugin

    main

    The required JDK version depends on the version of the plugin you are using, as it is tied to the requirements of the Eclipse binaries it utilizes:

    • 2.16.x: requires JDK 8
    • 2.17.x and later: requires JDK 11
    • 2.24.x and later: requires JDK 17