fix: separate normalized project id into its own context attribute

beet/contrib/lantern_load.py

@@ -16,7 +16,7 @@ def beet_default(ctx: Context):
     # The id defaults to the project name and the version to the project version.
     config = ctx.meta.get("lantern_load", cast(JsonDict, {}))
 
-    id = config.get("id", ctx.project_name)
+    id = config.get("id", ctx.project_id)
     version = config.get("version", ctx.project_version)
     dependencies = config.get("dependencies", cast(JsonDict, {}))
 

beet/toolchain/config.py

@@ -64,6 +64,7 @@ def with_defaults(self, other: "PackConfig") -> "PackConfig":
 class ProjectConfig(BaseModel):
     """Beet project configuration."""
 
+    id: str = ""
     name: str = ""
     description: TextComponent = ""
     author: str = ""
@@ -115,6 +116,7 @@ def resolve(self, directory: FileSystemPath) -> "ProjectConfig":
     def with_defaults(self, other: "ProjectConfig") -> "ProjectConfig":
         """Combine the current project config with another one."""
         return ProjectConfig(
+            id=self.id or other.id,
             name=self.name or other.name,
             description=self.description or other.description,
             author=self.author or other.author,

beet/toolchain/context.py

@@ -79,6 +79,7 @@ def flush(self):
 class Context:
     """The build context."""
 
+    project_id: str
     project_name: str
     project_description: TextComponent
     project_author: str

beet/toolchain/generator.py

@@ -78,15 +78,15 @@ def get_prefix(self, separator: str = ".") -> str:
 
     def get_increment(self, *key: Any) -> int:
         """Return the current value for the given key and increment it."""
-        key = (self.ctx.project_name, *self.scope, *key)
+        key = (self.ctx.project_id, *self.scope, *key)
         count = self.registry[key]
         self.registry[key] += 1
         return count
 
     def format(self, fmt: str, hash: Any = None) -> str:
         """Generate a unique key depending on the given template."""
         env = {
-            "namespace": self.ctx.meta.get("generate_namespace", self.ctx.project_name),
+            "namespace": self.ctx.meta.get("generate_namespace", self.ctx.project_id),
             "path": LazyFormat(lambda: self.get_prefix("/")),
             "scope": LazyFormat(lambda: self.get_prefix()),
             "incr": LazyFormat(lambda: self.get_increment(fmt)),

beet/toolchain/helpers.py

@@ -55,6 +55,7 @@ def sandbox(*specs: PluginSpec) -> Plugin:
 
     def plugin(ctx: Context):
         child_ctx = Context(
+            project_id=ctx.project_id,
             project_name=ctx.project_name,
             project_description=ctx.project_description,
             project_author=ctx.project_author,

beet/toolchain/project.py

@@ -231,13 +231,12 @@ def __init__(self, project: Project):
 
     def build(self) -> Context:
         """Create the context, run the pipeline, and return the context."""
-
         name = self.config.name or self.project.directory.stem
-        normalized_name = normalize_string(name)
 
         with self.project.worker_pool.handle() as worker_pool_handle:
             ctx = Context(
-                project_name=normalized_name,
+                project_id=self.config.id or normalize_string(name),
+                project_name=name,
                 project_description=self.config.description,
                 project_author=self.config.author,
                 project_version=self.config.version,
@@ -308,7 +307,7 @@ def bootstrap(self, ctx: Context):
             )
 
         for config, suffix, pack in zip(pack_configs, pack_suffixes, ctx.packs):
-            default_name = ctx.project_name
+            default_name = ctx.project_id
             if ctx.project_version:
                 default_name += "_" + ctx.project_version
             default_name += suffix

beet/toolchain/template.py

@@ -55,6 +55,7 @@ def resolve_or_missing(self, key: str) -> Any:
                 return manager.globals[key]
 
             if key in [
+                "project_id",
                 "project_name",
                 "project_description",
                 "project_author",

examples/code_description/demo.py

@@ -2,7 +2,8 @@
 
 
 def beet_default(ctx: Context):
-    ctx.project_name = "something_else"
+    ctx.project_id = "something_else"
+    ctx.project_name = "Something else"
     ctx.project_description = {"text": "bold description", "bold": True}
     ctx.project_author = "Fizzy"
     ctx.project_version = "1.2.3"

examples/code_metadata/demo.py

@@ -2,7 +2,8 @@
 
 
 def beet_default(ctx: Context):
-    ctx.project_name = "demo"
+    ctx.project_id = "demo"
+    ctx.project_name = "Demo"
     ctx.project_description = "The description of my project"
     ctx.project_author = "Example"
     ctx.project_version = "1.7.4"

examples/code_metadata/templates/foo.mcfunction

@@ -1,3 +1,4 @@
+say {{ project_id }}
 say {{ project_name }}
 say {{ project_description }}
 say {{ project_author }}

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

@@ -1,3 +1,4 @@
+say {{ project_id }}
 say {{ project_name }}
 say {{ project_description }}
 say {{ project_author }}

tests/snapshots/config__config_resolution_basic__0.beet-config

@@ -1,4 +1,5 @@
 {
+  "id": "",
   "name": "my_project",
   "description": "",
   "author": "",

tests/snapshots/config__config_resolution_crazy_extend__0.beet-config

@@ -1,4 +1,5 @@
 {
+  "id": "",
   "name": "",
   "description": "",
   "author": "",
@@ -28,6 +29,7 @@
   },
   "pipeline": [
     {
+      "id": "",
       "name": "",
       "description": "",
       "author": "",
@@ -66,6 +68,7 @@
       "meta": {}
     },
     {
+      "id": "",
       "name": "",
       "description": "",
       "author": "",
@@ -107,6 +110,7 @@
       "meta": {}
     },
     {
+      "id": "",
       "name": "",
       "description": "",
       "author": "",

tests/snapshots/config__config_resolution_empty__0.beet-config

@@ -1,4 +1,5 @@
 {
+  "id": "",
   "name": "",
   "description": "",
   "author": "",

tests/snapshots/config__config_resolution_extend_everything__0.beet-config

@@ -1,4 +1,5 @@
 {
+  "id": "",
   "name": "foo",
   "description": "foo",
   "author": "foo",

tests/snapshots/config__config_resolution_load_pack__0.beet-config

@@ -1,4 +1,5 @@
 {
+  "id": "",
   "name": "",
   "description": "",
   "author": "",

tests/snapshots/config__config_resolution_load_with_output__0.beet-config

@@ -1,4 +1,5 @@
 {
+  "id": "",
   "name": "",
   "description": "",
   "author": "",

tests/snapshots/config__config_resolution_load_with_templates__0.beet-config

@@ -1,4 +1,5 @@
 {
+  "id": "",
   "name": "",
   "description": "",
   "author": "",

tests/snapshots/config__config_resolution_more_stuff__0.beet-config

@@ -1,4 +1,5 @@
 {
+  "id": "",
   "name": "my_project",
   "description": "The description of my project",
   "author": "N/A",

tests/snapshots/config__config_resolution_nested__0.beet-config

@@ -1,4 +1,5 @@
 {
+  "id": "",
   "name": "foo",
   "description": "",
   "author": "",
@@ -30,6 +31,7 @@
   },
   "pipeline": [
     {
+      "id": "",
       "name": "",
       "description": "",
       "author": "",

tests/snapshots/config__config_resolution_whitelist__0.beet-config

@@ -1,4 +1,5 @@
 {
+  "id": "",
   "name": "",
   "description": "",
   "author": "",

tests/snapshots/config__config_resolution_whitelist_nested__0.beet-config

@@ -1,4 +1,5 @@
 {
+  "id": "",
   "name": "",
   "description": "",
   "author": "",
@@ -35,6 +36,7 @@
     "bar",
     "hello",
     {
+      "id": "",
       "name": "",
       "description": "",
       "author": "",
@@ -71,6 +73,7 @@
       "meta": {}
     },
     {
+      "id": "",
       "name": "",
       "description": "",
       "author": "",
@@ -104,6 +107,7 @@
       "meta": {}
     },
     {
+      "id": "",
       "name": "",
       "description": "",
       "author": "",

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

@@ -1,4 +1,5 @@
 say demo
+say Demo
 say The description of my project
 say Example
 say 1.7.4

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

@@ -1,4 +1,5 @@
 say demo
+say demo
 say The description of my project
 say Example
 say 1.7.4