-
-
Notifications
You must be signed in to change notification settings - Fork 175
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Revisit schema location indent choice #413
Comments
There is a historical reason for the indentation, I couldn't get rid of the + 1 space character from the XML framework that I was using. This was some time ago and I can give it another try 👀 I see that you have a PR already, let me check it out during next weekend |
Thanks. I hope you like it. If you determine a new parameter is needed, in order to maintain complete backward compatibility, I'm willing to contribute that. |
Wonderful! I agree that the 2 * indent makes so much more sense. I'll merge this directly. |
In a strict semantic versioning sense, I would say yes. As-is there's not even a config to keep the extra space, except say with the Spotless plugin. For what it's worth, I did notice between 3.3.x and 3.4.0 there was a binary-incompatible change in the sorter due to a changing method signature, which prevented upgrading for me until the next version of Spotless is released. But that signature change wasn't incompatible for the Sortpom plugin itself. All in all, without any backward compatibility mitigations, I think there's a good argument for incrementing major version if you abide by semantic versioning with users' expectations in mind. |
Sounds reasonable. Btw what do you use the sorter for? I have some future plans to merge the three SortPom maven modules into one, but if developers are using just the sorter, that might be a bad idea. |
On the other hand, I've used formatters like google-java-format and prettier that don't increment the major version, but rather the minor version, when the only the output changes. Notably both of these formatters are more opinionated and less configurable than SortPom. For these two formatters, the major version changes tend to be reserved for changing the minimum Java version, removing deprecations, removing formatters from core, etc. I'm just one user, but I plan to upgrade to the latest version whether it's a major or minor version upgrade.
I'm using it indirectly by way of Spotless. Spotless' Gradle and Maven plugins support formatting Maven POMs. Actually, I added the Gradle support which has not been released yet. SortPomFormatterFunc has a direct dependency on your sorter. |
Released new version |
Thanks and congrats! I already submitted a PR to Spotless to update to 4.0.0. |
I really appreciate your contributions. I’ll check out the PR |
I was finally able to use sortpom-sorter 4.0.0 with spotless-maven-plugin 2.44.0.BETA1 and remove all my indentation workarounds. Thanks again |
That is great to hear. Please enjoy!! |
First, allow me to say thank you for SortPom.
The conscious choice of
2 * indent + 1 space
as a continuation indent seems to me an unusual one. In practice, I've only ever seen2 * indent
or1 * indent
continuation indents, no matter whether the indents are spaces or tabs. For that reason, how do you feel about standardizing on2 * indent
as the continuation indent? Considering there's necessarily always a line separator before any continuation indent, that line separator alone substitutes for space as the obligatory whitespace between attributes, even when the indent is 0.The text was updated successfully, but these errors were encountered: