feat: add beet.contrib.strip_final_newlines

beet/contrib/strip_final_newlines.py

@@ -0,0 +1,50 @@
+"""Plugin that strips final newlines in text files."""
+
+
+__all__ = [
+    "StripFinalNewlinesSerializer",
+    "StripFinalNewlinesOptions",
+    "strip_final_newlines",
+]
+
+
+from dataclasses import dataclass
+from typing import Any, Callable
+
+from pydantic import BaseModel
+
+from beet import Context, ListOption, TextFileBase, configurable
+
+
+class StripFinalNewlinesOptions(BaseModel):
+    extensions: ListOption[str] = ListOption()
+
+
+def beet_default(ctx: Context):
+    ctx.require(strip_final_newlines)
+
+
+@dataclass
+class StripFinalNewlinesSerializer:
+    """Wrap existing serializer and strip final newline."""
+
+    serializer: Callable[[Any], str]
+
+    def __call__(self, content: Any) -> str:
+        raw = self.serializer(content)
+        if raw.endswith("\n"):
+            raw = raw[:-1]
+        return raw
+
+
+@configurable(validator=StripFinalNewlinesOptions)
+def strip_final_newlines(ctx: Context, opts: StripFinalNewlinesOptions):
+    """Plugin that strips final newlines in text files."""
+    for pack in ctx.packs:
+        for _, text_file in pack.list_files(
+            *opts.extensions.entries(),
+            extend=TextFileBase[Any],
+        ):
+            text_file.serializer = StripFinalNewlinesSerializer(text_file.serializer)
+            if isinstance(raw := text_file.get_content(), str) and raw.endswith("\n"):
+                text_file.text = raw[:-1]

examples/load_strip_final_newlines/beet.yml

@@ -0,0 +1,4 @@
+data_pack:
+  load: "src"
+pipeline:
+  - beet.contrib.strip_final_newlines

examples/load_strip_final_newlines/src/data/demo/functions/foo.mcfunction

@@ -0,0 +1 @@
+say hello

examples/load_strip_final_newlines/src/data/minecraft/tags/functions/tick.json

@@ -0,0 +1,3 @@
+{
+  "values": ["demo:foo"]
+}

tests/snapshots/examples__build_load_strip_final_newlines__0.data_pack/data/demo/functions/foo.mcfunction

@@ -0,0 +1 @@
+say hello

tests/snapshots/examples__build_load_strip_final_newlines__0.data_pack/data/minecraft/tags/functions/tick.json

@@ -0,0 +1,3 @@
+{
+  "values": ["demo:foo"]
+}

tests/snapshots/examples__build_load_strip_final_newlines__0.data_pack/pack.mcmeta

@@ -0,0 +1,6 @@
+{
+  "pack": {
+    "pack_format": 10,
+    "description": ""
+  }
+}

tests/snapshots/examples__build_load_strip_final_newlines__1.resource_pack/pack.mcmeta

@@ -0,0 +1,6 @@
+{
+  "pack": {
+    "pack_format": 9,
+    "description": ""
+  }
+}