Maven plugin that helps the user sort pom.xml.
Clone or download
Björn Ekryd
Latest commit 2705642 Nov 25, 2018

README.md

Sortpom Maven Plugin Icon

Build Status Coverage Status Maven Central SonarQube

Maven plugin that helps the user sort pom.xml by formatting the XML and organizing XML sections in a predefined order. The main advantages to have standardized sorted poms are that they become more readable and that comparisons between different module poms becomes much easier.

Goals Overview

The SortPom Plugin has two goals.

  • mvn sortpom:sort sorts the current pom.xml file. This goal will always sort the pom.xml file.

  • mvn sortpom:verify only sorts the current pom.xml file if the xml elements are unsorted. This goal ignores text formatting (such as indentation and line breaks) when it verifies if the pom is sorted or not.

Icon

Usage

The Sortpom plugin will reorder the pom elements and format the xml structure in the pom-file. The plugin can be configured to sort by by different standards or by custom format. By default a backup file will be created, so that you can check how the pom-file has changed.

Sortpom works best if it is run every time during Maven compilation. Configure it once and then forget about it. If you want to perform a simple test what the plugin does then open a command prompt in your project home and enter

mvn com.github.ekryd.sortpom:sortpom-maven-plugin:sort -Dsort.keepBlankLines -Dsort.predefinedSortOrder=custom_1

For a example how the plugin can be configured to run every time you build your project see recommended configuration wiki page

The plugin will not change how your Maven project is compiled (Exception)

News

  • 2018-10-10: Released version 2.10.0. Eclipse users will not get 'Plugin execution not covered by lifecycle configuration' error anymore. Thanks Andrea for your pull request!
  • 2018-09-20: Released version 2.9.0. Updated the default order to match Maven xsd. The parent element will get artifactId and groupId switched
  • 2017-04-02: Released version 2.8.0 that adds support to sort modules. Thanks Monica for your pull request!
  • 2017-03-29: Released version 2.7.0 that adds support to write to a separate violation file when verifying.
  • 2017-03-18: Released version 2.6.0 that adds support to force sorting if only line breaks differ. Thanks again Benoit Guerin for your pull requests!
  • 2017-02-18: Benoit Guerin supplied Maven invoker tests to the plugin. Thank you!
  • 2016-12-24: Renewed Open Source Licence for IntelliJ Ultimate. Once again, thank you JetBrains!!
  • 2016-05-06: Received an Open Source license for JProfiler. Thank you ej-technologies!
  • 2015-11-21: Released version 2.5.0. The plugin now uses Java 8, as some dependant plugins demand Java 8. Users of previous versions of Java will have to use version 2.4.0.
  • 2015-04-06: Released version 2.4.0 with new github location and updated libraries.
  • 2015-03-31: Moved the SortPom plugin to GitHub.
  • 2015-02-04: Received an Open Source license for Structure101. Thank you Structure101!
  • 2013-11-23: Hurrah! Got a donation. Thank you Bastian!
  • 2013-10-01: Hurrah! Got an donation. Thank you Khalid!
  • 2012-11-05: Hurrah! Got an donation. Thank you Michael!
  • 2012-06-12: Hurrah! Got an donation. Thank you Reuben!

Versions

https://github.com/Ekryd/sortpom/wiki/Versions

Plugin parameters

https://github.com/Ekryd/sortpom/wiki/Parameters

Download

The plugin is hosted i Maven Central and will be downloaded automatically if you include it as a plugin in your pom file.

Donations

If you use it, then please consider some encouragement. ⭐️ Star it in GitHub!