Whitespace after XML comments removed since 3.1.0 release

[Stephan202]

Following resolution of #206, the the 3.1.x releases drop whitespace in one more case, namely after XML comments.

To reproduce, run:

git clone git@github.com:PicnicSupermarket/oss-parent.git
cd oss-parent
git checkout origin/master
mvn com.github.ekryd.sortpom:sortpom-maven-plugin:3.0.1:sort
git commit -m 'Before' pom.xml
mvn com.github.ekryd.sortpom:sortpom-maven-plugin:3.1.2:sort
git diff

[Ekryd]

Hi! i will look into this

[Ekryd]

<!-- The test JVMs are short-running. By disabling certain
            expensive JIT optimizations we actually speed up most tests. -->
            -XX:TieredStopAtLevel=1

to

<!-- The test JVMs are short-running. By disabling certain
            expensive JIT optimizations we actually speed up most tests. -->-XX:TieredStopAtLevel=1

I see, need to dig a little deeper

[Ekryd]

WIth the new XML framework, text is always trimmed because it it placed within two elements.
In this case it is preceded by a comment, that always start at a new line.
This do create a strange mix of comments (that start on new lines) and text which is trimmed (so it stays on the same line).

Hmmm, how would we know that this text should be proceeded with a newline?

[Ekryd]

I have found a way to always place text nodes, which have siblings (such as a comment), on their own line.
The problem is that I don't know if this is going to cause other problems in other pom files.
This behaviour may perhaps be toggled with some sort of parameter.

[create-issue-branch]

Branch issue-209-Whitespace_after_XML_comments_removed_since_3_1_0_release created!

[Ekryd]

I have made an initial implementation in the branch. Feel free to play around with it and try to break it.

[Stephan202]

@Ekryd Tnx for jumping on this so quickly! I built the branch and tested it against another internal repo: the results look exactly as expected 🎉

[Ekryd]

Hi! Version 3.1.3 should solve your problem, try it and report how it works.

[Stephan202]

Tnx for the rapid new release! The upgrade build against our internal repository passes 🚀