Replace type synonym placeholders with bracket notation for better DX (#1133)

* Initial plan

* Replace placeholder syntax for type synonyms to be more DX friendly

Co-authored-by: jbtronics <[email protected]>

* Update translation files to use new placeholder syntax

Co-authored-by: jbtronics <[email protected]>

* Use mb_strtoupper with mb_substr for Unicode consistency

Co-authored-by: jbtronics <[email protected]>

* Make placeholder generation right

* Removed obsolete transltions

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: jbtronics <[email protected]>
Co-authored-by: Jan Böhmer <[email protected]>

Author: Copilot

config/permissions.yaml

@@ -18,7 +18,7 @@ perms: # Here comes a list with all Permission names (they have a perm_[name] co
 
   parts: # e.g. this maps to perms_parts in User/Group database
     group: "data"
-    label: "{{part}}"
+    label: "[[Part]]"
     operations: # Here are all possible operations are listed => the op name is mapped to bit value
       read:
         label: "perm.read"
@@ -71,7 +71,7 @@ perms: # Here comes a list with all Permission names (they have a perm_[name] co
 
 
   storelocations: &PART_CONTAINING
-    label: "{{storage_location}}"
+    label: "[[Storage_location]]"
     group: "data"
     operations:
       read:
@@ -103,39 +103,39 @@ perms: # Here comes a list with all Permission names (they have a perm_[name] co
 
   footprints:
     <<: *PART_CONTAINING
-    label: "{{footprint}}"
+    label: "[[Footprint]]"
 
   categories:
     <<: *PART_CONTAINING
-    label: "{{category}}"
+    label: "[[Category]]"
 
   suppliers:
     <<: *PART_CONTAINING
-    label: "{{supplier}}"
+    label: "[[Supplier]]"
 
   manufacturers:
     <<: *PART_CONTAINING
-    label: "{{manufacturer}}"
+    label: "[[Manufacturer]]"
 
   projects:
     <<: *PART_CONTAINING
-    label: "{{project}}"
+    label: "[[Project]]"
 
   attachment_types:
     <<: *PART_CONTAINING
-    label: "{{attachment_type}}"
+    label: "[[Attachment_type]]"
 
   currencies:
     <<: *PART_CONTAINING
-    label: "{{currency}}"
+    label: "[[Currency]]"
 
   measurement_units:
     <<: *PART_CONTAINING
-    label: "{{measurement_unit}}"
+    label: "[[Measurement_unit]]"
 
   part_custom_states:
     <<: *PART_CONTAINING
-    label: "{{part_custom_state}}"
+    label: "[[Part_custom_state]]"
 
   tools:
     label: "perm.part.tools"

src/EventListener/RegisterSynonymsAsTranslationParametersListener.php

@@ -60,10 +60,10 @@ public function getSynonymPlaceholders(): array
 
             //Generate a placeholder for each element type
             foreach (ElementTypes::cases() as $elementType) {
-                //We have a placeholder for singular
-                $placeholders['{' . $elementType->value . '}'] = $this->typeNameGenerator->typeLabel($elementType);
-                //We have a placeholder for plural
-                $placeholders['{{' . $elementType->value . '}}'] = $this->typeNameGenerator->typeLabelPlural($elementType);
+                //Versions with capitalized first letter
+                $capitalized = ucfirst($elementType->value); //We have only ASCII element type values, so this is sufficient
+                $placeholders['[' . $capitalized . ']'] = $this->typeNameGenerator->typeLabel($elementType);
+                $placeholders['[[' . $capitalized . ']]'] = $this->typeNameGenerator->typeLabelPlural($elementType);
 
                 //And we have lowercase versions for both
                 $placeholders['[' . $elementType->value . ']'] = mb_strtolower($this->typeNameGenerator->typeLabel($elementType));

tests/EventListener/RegisterSynonymsAsTranslationParametersTest.php

@@ -40,10 +40,11 @@ public function testGetSynonymPlaceholders(): void
         $placeholders = $this->listener->getSynonymPlaceholders();
 
         $this->assertIsArray($placeholders);
-        $this->assertSame('Part', $placeholders['{part}']);
-        $this->assertSame('Parts', $placeholders['{{part}}']);
-        //Lowercase versions:
+        // Curly braces for lowercase versions
         $this->assertSame('part', $placeholders['[part]']);
         $this->assertSame('parts', $placeholders['[[part]]']);
+        // Square brackets for capitalized versions (with capital first letter in placeholder)
+        $this->assertSame('Part', $placeholders['[Part]']);
+        $this->assertSame('Parts', $placeholders['[[Part]]']);
     }
 }

translations/messages.de.xlf

@@ -14297,12 +14297,6 @@ Bitte beachten Sie, dass dieses System derzeit experimentell ist und die hier de
         <target>Mit Typsynonymen können Sie die Bezeichnungen von integrierten Datentypen ersetzen. Zum Beispiel können Sie „Footprint" in etwas anderes umbenennen.</target>
       </segment>
     </unit>
-    <unit id="GSqBiVV" name="{{part}}">
-      <segment>
-        <source>{{part}}</source>
-        <target>Bauteile</target>
-      </segment>
-    </unit>
     <unit id="wjcsjzT" name="log.element_edited.changed_fields.part_ipn_prefix">
       <segment>
         <source>log.element_edited.changed_fields.part_ipn_prefix</source>

translations/messages.en.xlf

@@ -14146,12 +14146,6 @@ Please note that this system is currently experimental, and the synonyms defined
         <target>Type synonyms allow you to replace the labels of built-in data types. For example, you can rename "Footprint" to something else.</target>
       </segment>
     </unit>
-    <unit id="GSqBiVV" name="{{part}}">
-      <segment>
-        <source>{{part}}</source>
-        <target>Parts</target>
-      </segment>
-    </unit>
     <unit id="wjcsjzT" name="log.element_edited.changed_fields.part_ipn_prefix">
       <segment>
         <source>log.element_edited.changed_fields.part_ipn_prefix</source>