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.

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

Apache Velocity template language comment style #554

Merged
merged 2 commits into from Oct 12, 2022

Conversation

nicorikken
Copy link
Member

Adds comment style VelocityCommentStyle for the template files of the
Apache Velocity project https://velocity.apache.org/ Most typical file
formats .vst and .vm for these files are assigned for this comment
style.

This PR relates to issue #553

The single line comments requires a more elaborate code change to
support trailing **, so this change only contains the multi-line
format.

Signed-off-by: Nico Rikken nico.rikken@alliander.com

@nicorikken nicorikken added the comment-styles Request for a new comment style, or fixing a bug with these label Jul 4, 2022
@nicorikken nicorikken force-pushed the feature/apache-velocity-comments branch from a084a52 to 1bf9a6b Compare July 5, 2022 07:23
@nicorikken
Copy link
Member Author

One thing i noticed, is that because I used " " for indentation of the lines within the comment block, the default newline between the SPDX-FileCopyrightText and the SPDX-License-Identifier results in trailing whitespace. Of course I can lean this up afterwards, but it would be nice if no trailing whitespace would be introduced. But perhaps that is something that needs a separate issue and pull request.

@nicorikken nicorikken force-pushed the feature/apache-velocity-comments branch from 1bf9a6b to 2f0287d Compare July 6, 2022 05:22
@mxmehl mxmehl added this to the v1.1.0 milestone Aug 31, 2022
@carmenbianca
Copy link
Member

This will break after #593 is merged.

@linozen
Copy link
Member

linozen commented Oct 5, 2022

After #593 is merged, we'd need to use the MultiLineSegments class to fix this issue.

nicorikken and others added 2 commits October 12, 2022 21:04
Adds comment style VelocityCommentStyle for the template files of the
Apache Velocity project https://velocity.apache.org/ Most typical file
formats `.vst` and `.vm` for these files are assigned for this comment
style.

This PR relates to issue #553

The single line comments requires a more elaborate code change to
support trailing ` **`, so this change only contains the multi-line
format.

Signed-off-by: Carmen Bianca Bakker <carmenbianca@fsfe.org>
Signed-off-by: Carmen Bianca Bakker <carmenbianca@fsfe.org>
@carmenbianca carmenbianca force-pushed the feature/apache-velocity-comments branch from 2f0287d to 5b6f7bd Compare October 12, 2022 19:10
@carmenbianca carmenbianca merged commit 94a609a into main Oct 12, 2022
@carmenbianca carmenbianca deleted the feature/apache-velocity-comments branch February 10, 2023 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comment-styles Request for a new comment style, or fixing a bug with these
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants