feat(BEAM): Add support for Erlang, Elixir, and Gleam comments

AUTHORS.rst

@@ -144,3 +144,4 @@ Contributors
 - Skyler Grey <[email protected]>
 - Emil Velikov <[email protected]>
 - Linnea Gräf <[email protected]>
+- Kiko Fernandez-Reyes <[email protected]>

changelog.d/added/erlang-elixir-gleam.md

@@ -0,0 +1,3 @@
+- Added comment support for Erlang (`.erl` and `.hrl`), Erlang's leex and yecc
+  lexer and parser generators (`.xrl` and `.yrl`), Elixir (`.ex` and `.exs`),
+  and Gleam (`.gleam`). (#1117)

src/reuse/comment.py

@@ -18,6 +18,7 @@
 # SPDX-FileCopyrightText: 2023 Shun Sakai <[email protected]>
 # SPDX-FileCopyrightText: 2024 Rivos Inc.
 # SPDX-FileCopyrightText: 2024 Anthony Loiseau <[email protected]>
+# SPDX-FileCopyrightText: 2024 Kiko Fernandez-Reyes <[email protected]>
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 
@@ -392,6 +393,26 @@ class ModernFortranCommentStyle(CommentStyle):
     INDENT_AFTER_SINGLE = " "
 
 
+class ErlangCommentStyle(CommentStyle):
+    """Erlang comment style."""
+
+    SHORTHAND = "erlang"
+
+    SINGLE_LINE = "%"
+    INDENT_AFTER_SINGLE = " "
+    SHEBANGS = ["#!"]
+
+
+class ElixirCommentStyle(CommentStyle):
+    """Elixir comment style."""
+
+    SHORTHAND = "elixir"
+
+    SINGLE_LINE = "#"
+    INDENT_AFTER_SINGLE = " "
+    SHEBANGS = ["#!"]
+
+
 class FtlCommentStyle(CommentStyle):
     """FreeMarker Template Language comment style."""
 
@@ -400,6 +421,16 @@ class FtlCommentStyle(CommentStyle):
     MULTI_LINE = MultiLineSegments("<#--", "", "-->")
 
 
+class GleamCommentStyle(CommentStyle):
+    """Gleam comment style."""
+
+    SHORTHAND = "gleam"
+
+    SINGLE_LINE = "//"
+    INDENT_AFTER_SINGLE = " "
+    SHEBANGS = ["#!"]
+
+
 class HandlebarsCommentStyle(CommentStyle):
     """Handlebars comment style."""
 
@@ -632,9 +663,10 @@ class XQueryCommentStyle(CommentStyle):
     ".dts": CppCommentStyle,
     ".dtsi": CppCommentStyle,
     ".el": LispCommentStyle,
-    ".erl": TexCommentStyle,
-    ".ex": PythonCommentStyle,
-    ".exs": PythonCommentStyle,
+    ".erl": ErlangCommentStyle,
+    ".escript": ErlangCommentStyle,
+    ".ex": ElixirCommentStyle,
+    ".exs": ElixirCommentStyle,
     ".f": FortranCommentStyle,
     ".fsproj": HtmlCommentStyle,
     ".f03": ModernFortranCommentStyle,
@@ -653,6 +685,7 @@ class XQueryCommentStyle(CommentStyle):
     ".fsx": CppCommentStyle,
     ".ftl": FtlCommentStyle,
     ".gemspec": PythonCommentStyle,
+    ".gleam": GleamCommentStyle,
     ".go": CppCommentStyle,
     ".gradle": CppCommentStyle,
     ".graphql": PythonCommentStyle,
@@ -666,7 +699,7 @@ class XQueryCommentStyle(CommentStyle):
     ".hh": CppCommentStyle,
     ".hjson": CppCommentStyle,
     ".hpp": CppCommentStyle,
-    ".hrl": TexCommentStyle,
+    ".hrl": ErlangCommentStyle,
     ".hs": HaskellCommentStyle,
     ".html": HtmlCommentStyle,
     ".hx": CppCommentStyle,
@@ -824,11 +857,13 @@ class XQueryCommentStyle(CommentStyle):
     ".xqm": XQueryCommentStyle,
     ".xqy": XQueryCommentStyle,
     ".xquery": XQueryCommentStyle,
+    ".xrl": ErlangCommentStyle,
     ".xsd": HtmlCommentStyle,
     ".xsh": PythonCommentStyle,
     ".xsl": HtmlCommentStyle,
     ".yaml": PythonCommentStyle,
     ".yml": PythonCommentStyle,
+    ".yrl": ErlangCommentStyle,
     ".zig": CppSingleCommentStyle,
     ".zsh": PythonCommentStyle,
 }