Merge pull request #554 from fsfe/feature/apache-velocity-comments

Apache Velocity template language comment style
fsfe · Oct 12, 2022 · 94a609a · 94a609a
2 parents 3450858 + 5b6f7bd
commit 94a609a
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -45,6 +45,10 @@ The versions follow [semantic versioning](https://semver.org).
   - Android Interface Definition Language (`.aidl`)
   - Certificate files (`.pem`)
 
+- Added comment style:
+
+  - Apache Velocity Template (Extensions: `.vm`, `.vtl`)
+
 ### Changed
 
 - Updated PyPI development status to 'production/stable' (#381)

diff --git a/src/reuse/_comment.py b/src/reuse/_comment.py
@@ -448,6 +448,15 @@ class UncommentableCommentStyle(EmptyCommentStyle):
     """
 
 
+class VelocityCommentStyle(CommentStyle):
+    """Apache Velocity Template Language comment style."""
+
+    _shorthand = "vst"
+
+    # TODO: SINGLE_LINE requires refactor to support trailing `**`.
+    MULTI_LINE = MultiLineSegments("#*", "  ", "*#")
+
+
 class VimCommentStyle(CommentStyle):
     """Vim(Script|Config) style."""
 
@@ -639,7 +648,9 @@ class VimCommentStyle(CommentStyle):
     ".v": CCommentStyle,  # V-Lang source code
     ".vala": CCommentStyle,
     ".vim": VimCommentStyle,
+    ".vm": VelocityCommentStyle,
     ".vsh": CCommentStyle,  # V-Lang script
+    ".vtl": VelocityCommentStyle,
     ".vue": HtmlCommentStyle,
     ".xls": UncommentableCommentStyle,
     ".xlsx": UncommentableCommentStyle,