Skip to content
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.

Sign up for GitHub

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

[headerType] Newline on the end for slashstar_style #629

Closed
wants to merge 1 commit into from
Closed

[headerType] Newline on the end for slashstar_style #629

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion license-maven-plugin/src/main/java/com/mycila/maven/plugin/license/header/HeaderType.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public enum HeaderType {
APOSTROPHE_STYLE("'", "' ", "'EOL", "", null, "'.*$", "'.*$", false, false, false),
EXCLAMATION_STYLE("!", "! ", "!EOL", "", null, "!.*$", "!.*$", false, false, false),
DOUBLEDASHES_STYLE("--", "-- ", "--EOL", "", null, "--.*$", "--.*$", false, false, false),
SLASHSTAR_STYLE("/*", " * ", " */", "", null, "(\\s|\\t)*/\\*.*$", ".*\\*/(\\s|\\t)*$", false, true, false),
SLASHSTAR_STYLE("/*", " * ", " */EOL", "", null, "(\\s|\\t)*/\\*.*$", ".*\\*/(\\s|\\t)*$", false, true, false),
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with you, but this change will break the current behaviour for existing users so this is not acceptable the way it is implemented right now.

Also, what you say might also be true for other header styles, not just java.

So we would need to find a more global solution for that, which is backward compatible also.

Copy link
Contributor Author

@uyw4687 uyw4687 Sep 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, it seems this issue #78 is related.
We might need to override the number of EOLs before and after the license in (maybe) HeaderType setting. cc @minwoox

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how about easier modification on the properties(changing only one property) instead of having to describe all other properties even though they don't need to be updated?
And application of EOL as a different issue?
since when EOL is applied, current behavior is adding that header even if there is a blank line at the beginning of the file.(though this is not a problem caused by plugin but it might be better to apply it in this way, since onHeaderNotFound when header is detected, header is removed. And when that header is removed, trailing blank lines are removed. It is not exactly the same case but I guess this might look natural though this is also a breaking change T.T

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your suggestions are good yes. In HeaderType, we can extract in a boolean endWithEOL state whether the style finished with EOL or not. If yes, EOL will be appended when building the header style. This new property could have a default value of false when parsed from properties or XML and this way this would be backward compatible and also won't be a bug refactoring.

Unit tests will need to be added too.

BRACESSTAR_STYLE("{*", " * ", " *}", "", null, "(\\s|\\t)*\\{\\*.*$", ".*\\*\\}(\\s|\\t)*$", false, true, false),
SHARPSTAR_STYLE("#*", " * ", " *#", "", null, "(\\s|\\t)*#\\*.*$", ".*\\*#(\\s|\\t)*$", false, true, false),
DOUBLETILDE_STYLE("~~", "~~ ", "~~EOL", "", null, "~~.*$", "~~.*$", false, false, false),
Expand Down