feat: ignore overlays that exist before the plugin runs

Author: BPR02

beet_observer/data_pack.py

@@ -4,7 +4,9 @@
 from beet import Context, NamespaceProxy
 
 
-def gen_dp_overlays(ctx: Context, ctx_overlay: Context, overlay_dir: str) -> None:
+def gen_dp_overlays(
+    ctx: Context, ctx_overlay: Context, overlay_dir: str, ignore: list[str]
+) -> None:
     """
     Generates overlays between two datapacks.
 
@@ -118,6 +120,8 @@ def gen_dp_overlays(ctx: Context, ctx_overlay: Context, overlay_dir: str) -> Non
 
     # add overlays to pack.mcmeta
     for overlay in ctx.data.overlays:
+        if overlay in ignore:
+            continue
         # check if it's the top-level overlay
         if overlay == ctx.meta["observer"]["default_dir_dp"]:
             # delete pack.mcmeta from overlay (required for tests)

beet_observer/plugin.py

@@ -24,6 +24,10 @@ def beet_default(ctx: Context):
         ctx.meta["observer"]["default_dir_rp"] = ctx.meta["observer"]["default_dir"][
             "rp"
         ]
+    # save current overlays
+    save: list[str] = []
+    for overlay in ctx.data.overlays:
+        save.append(overlay)
     # loop through all overlays
     for overlay in ctx.meta["observer"]["overlays"]:
         # create relative path
@@ -40,5 +44,5 @@ def beet_default(ctx: Context):
                 dp_dir = overlay["directory"]
                 rp_dir = overlay["directory"]
             # compare build pack and overlay pack
-            gen_dp_overlays(ctx, ctx_overlay, dp_dir)
-            gen_rp_overlays(ctx, ctx_overlay, rp_dir)
+            gen_dp_overlays(ctx, ctx_overlay, dp_dir, save)
+            gen_rp_overlays(ctx, ctx_overlay, rp_dir, save)

beet_observer/resource_pack.py

@@ -3,7 +3,9 @@
 from beet import Context, NamespaceProxy
 
 
-def gen_rp_overlays(ctx: Context, ctx_overlay: Context, overlay_dir: str) -> None:
+def gen_rp_overlays(
+    ctx: Context, ctx_overlay: Context, overlay_dir: str, ignore: list[str]
+) -> None:
     """
     Generates overlays between two resource packs.
 
@@ -46,6 +48,8 @@ def gen_rp_overlays(ctx: Context, ctx_overlay: Context, overlay_dir: str) -> Non
 
     # add overlays to pack.mcmeta
     for overlay in ctx.assets.overlays:
+        if overlay in ignore:
+            continue
         # check if it's the top-level overlay
         if overlay == ctx.meta["observer"]["default_dir_rp"]:
             # delete pack.mcmeta from overlay (required for tests)

examples/existing_overlay1/beet.yaml

@@ -0,0 +1,17 @@
+data_pack:
+  load: src
+  pack_format: 57
+  supported_formats: [48,57]
+  overlays:
+    - formats:
+        min_inclusive: 47
+        max_inclusive: 47
+      directory: overlay_47
+
+pipeline:
+  - beet_observer
+
+meta:
+  observer:
+    overlays:
+      - process: proc

examples/existing_overlay1/proc/data/demo/function/demo.mcfunction

@@ -0,0 +1 @@
+say this only exists in the overlay

examples/existing_overlay1/proc/data/demo/function/foo.mcfunction

@@ -0,0 +1 @@
+say this is the same in both

examples/existing_overlay1/proc/pack.mcmeta

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

examples/existing_overlay1/src/data/demo/function/foo.mcfunction

@@ -0,0 +1 @@
+say this is the same in both

examples/existing_overlay1/src/overlay_47/data/demo/function/foo.mcfunction

@@ -0,0 +1 @@
+say this is in an overlay that exists already

tests/snapshots/examples__build_existing_overlay1__0.pack.md

@@ -0,0 +1,67 @@
+# Lectern snapshot
+
+## Data pack
+
+`@data_pack pack.mcmeta`
+
+```json
+{
+  "pack": {
+    "pack_format": 57,
+    "description": "",
+    "supported_formats": [
+      48,
+      57
+    ]
+  },
+  "overlays": {
+    "entries": [
+      {
+        "formats": 48,
+        "directory": "overlay_48"
+      },
+      {
+        "formats": {
+          "min_inclusive": 47,
+          "max_inclusive": 47
+        },
+        "directory": "overlay_47"
+      }
+    ]
+  }
+}
+```
+
+### demo
+
+`@function demo:foo`
+
+```mcfunction
+say this is the same in both
+```
+
+## Overlay `overlay_47`
+
+`@overlay overlay_47`
+
+### demo
+
+`@function demo:foo`
+
+```mcfunction
+say this is in an overlay that exists already
+```
+
+## Overlay `overlay_48`
+
+`@overlay overlay_48`
+
+### demo
+
+`@function demo:demo`
+
+```mcfunction
+say this only exists in the overlay
+```
+
+`@endoverlay`