feat: add beet.contrib.format_json plugin

beet/contrib/format_json.py

@@ -0,0 +1,55 @@
+"""Plugin that formats json files."""
+
+
+__all__ = [
+    "format_json",
+]
+
+
+import json
+from typing import Any, Callable, cast
+
+from beet import Context, JsonFileBase, Plugin
+from beet.core.utils import JsonDict
+
+
+def beet_default(ctx: Context):
+    config = ctx.meta.get("format_json", cast(JsonDict, {}))
+
+    ensure_ascii = config.get("ensure_ascii", True)
+    allow_nan = config.get("allow_nan", True)
+    indent = config.get("indent", 2)
+    separators = config.get("separators")
+    sort_keys = config.get("sort_keys", False)
+    final_newline = config.get("final_newline", True)
+
+    if separators:
+        separators = (separators[0], separators[1])
+
+    suffix = "\n" if final_newline else ""
+
+    ctx.require(
+        format_json(
+            lambda content: json.dumps(
+                content,
+                ensure_ascii=ensure_ascii,
+                allow_nan=allow_nan,
+                indent=indent,
+                separators=separators,
+                sort_keys=sort_keys,
+            )
+            + suffix
+        )
+    )
+
+
+def format_json(formatter: Callable[[Any], str]) -> Plugin:
+    """Return a plugin that formats json files with the given formatter."""
+
+    def plugin(ctx: Context):
+        for pack in ctx.packs:
+            for _, json_file in pack.list_files(extend=JsonFileBase[Any]):
+                json_file.serializer = formatter
+                json_file.text = formatter(json_file.data)
+
+    return plugin

beet/contrib/minify_json.py

@@ -2,12 +2,10 @@
 
 
 import json
-from typing import Any
 
-from beet import Context, JsonFileBase
+from beet import Context
+from beet.contrib.format_json import format_json
 
 
 def beet_default(ctx: Context):
-    for pack in ctx.packs:
-        for _, json_file in pack.list_files(extend=JsonFileBase[Any]):
-            json_file.text = json.dumps(json_file.data, separators=(",", ":"))
+    ctx.require(format_json(lambda content: json.dumps(content, separators=(",", ":"))))

examples/code_minify_json/beet.json

@@ -0,0 +1,3 @@
+{
+  "pipeline": ["demo", "beet.contrib.minify_json"]
+}

examples/code_minify_json/demo.py

@@ -0,0 +1,5 @@
+from beet import Context, Function
+
+
+def beet_default(ctx: Context):
+    ctx.data["demo:foo"] = Function(["say hello"], tags=["minecraft:load"])

examples/load_format_json/beet.json

@@ -0,0 +1,12 @@
+{
+  "resource_pack": {
+    "load": ["src"]
+  },
+  "pipeline": ["beet.contrib.format_json"],
+  "meta": {
+    "format_json": {
+      "indent": 4,
+      "sort_keys": true
+    }
+  }
+}

examples/load_format_json/src/assets/minecraft/lang/en_us.json

@@ -0,0 +1,6 @@
+{
+  "zzz": "0",
+  "something": "A",
+  "cool": "B",
+  "other": "C"
+}

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

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

tests/snapshots/examples__build_code_minify_json__0.data_pack/data/minecraft/tags/functions/load.json

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

tests/snapshots/examples__build_code_minify_json__0.data_pack/pack.mcmeta

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

tests/snapshots/examples__build_code_minify_json__1.resource_pack/pack.mcmeta

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

tests/snapshots/examples__build_load_format_json__0.data_pack/pack.mcmeta

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

tests/snapshots/examples__build_load_format_json__1.resource_pack/assets/minecraft/lang/en_us.json

@@ -0,0 +1,6 @@
+{
+    "cool": "B",
+    "other": "C",
+    "something": "A",
+    "zzz": "0"
+}

tests/snapshots/examples__build_load_format_json__1.resource_pack/pack.mcmeta

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