sort attributes of XML elements before converting them into a string

daniel-sc · Feb 8, 2024 · d928301 · d928301
1 parent 8f3f417
commit d928301
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 9 deletions.
diff --git a/src/builder.spec.ts b/src/builder.spec.ts
@@ -2006,7 +2006,7 @@ describe('Builder', () => {
                     '        <source>Some text <ph id="0" equiv="INTERPOLATION" disp="{{ myLabel }}"/> <ph id="1" equiv="INTERPOLATION_1" disp="{{ myNumber }}"/></source>\n' +
                     '      </trans-unit>\n' +
                     '      <trans-unit id="ID2" datatype="html">\n' +
-                    '        <source>no-space<ph id="0" equiv="INTERPOLATION" disp="{{ myLabel }}"/> <ph id="1" equiv="INTERPOLATION_1" disp="{{ myNumber }}"/></source>\n' +
+                    '        <source>no-space<ph equiv="INTERPOLATION" id="0" disp="{{ myLabel }}"/> <ph id="1" disp="{{ myNumber }}" equiv="INTERPOLATION_1"/></source>\n' +
                     '      </trans-unit>\n' +
                     '    </body>\n' +
                     '  </file>\n' +
@@ -2026,10 +2026,10 @@ describe('Builder', () => {
                     '  <file source-language="de" datatype="plaintext" original="ng2.template">\n' +
                     '    <body>\n' +
                     '      <trans-unit id="ID1" datatype="html">\n' +
-                    '        <source>Some text <ph id="0" equiv="INTERPOLATION" disp="{{ myLabel }}"/> <ph id="1" equiv="INTERPOLATION_1" disp="{{ myNumber }}"/></source>\n' +
+                    '        <source>Some text <ph disp="{{ myLabel }}" equiv="INTERPOLATION" id="0"/> <ph disp="{{ myNumber }}" equiv="INTERPOLATION_1" id="1"/></source>\n' +
                     '      </trans-unit>\n' +
                     '      <trans-unit id="ID2" datatype="html">\n' +
-                    '        <source>no-space<ph id="0" equiv="INTERPOLATION" disp="{{ myLabel }}"/> <ph id="1" equiv="INTERPOLATION_1" disp="{{ myNumber }}"/></source>\n' +
+                    '        <source>no-space<ph disp="{{ myLabel }}" equiv="INTERPOLATION" id="0"/> <ph disp="{{ myNumber }}" equiv="INTERPOLATION_1" id="1"/></source>\n' +
                     '      </trans-unit>\n' +
                     '    </body>\n' +
                     '  </file>\n' +
@@ -2038,12 +2038,12 @@ describe('Builder', () => {
                     '  <file source-language="de" target-language="fr-ch" datatype="plaintext" original="ng2.template">\n' +
                     '    <body>\n' +
                     '      <trans-unit id="ID1" datatype="html">\n' +
-                    '        <source>Some text <ph id="0" equiv="INTERPOLATION" disp="{{ myLabel }}"/> <ph id="1" equiv="INTERPOLATION_1" disp="{{ myNumber }}"/></source>\n' +
-                    '        <target state="new">Some text <ph id="0" equiv="INTERPOLATION" disp="{{ myLabel }}"/> <ph id="1" equiv="INTERPOLATION_1" disp="{{ myNumber }}"/></target>\n' +
+                    '        <source>Some text <ph disp="{{ myLabel }}" equiv="INTERPOLATION" id="0"/> <ph disp="{{ myNumber }}" equiv="INTERPOLATION_1" id="1"/></source>\n' +
+                    '        <target state="new">Some text <ph disp="{{ myLabel }}" equiv="INTERPOLATION" id="0"/> <ph disp="{{ myNumber }}" equiv="INTERPOLATION_1" id="1"/></target>\n' +
                     '      </trans-unit>\n' +
                     '      <trans-unit id="ID2" datatype="html">\n' +
-                    '        <source>no-space<ph id="0" equiv="INTERPOLATION" disp="{{ myLabel }}"/> <ph id="1" equiv="INTERPOLATION_1" disp="{{ myNumber }}"/></source>\n' +
-                    '        <target state="new">no-space<ph id="0" equiv="INTERPOLATION" disp="{{ myLabel }}"/> <ph id="1" equiv="INTERPOLATION_1" disp="{{ myNumber }}"/></target>\n' +
+                    '        <source>no-space<ph disp="{{ myLabel }}" equiv="INTERPOLATION" id="0"/> <ph disp="{{ myNumber }}" equiv="INTERPOLATION_1" id="1"/></source>\n' +
+                    '        <target state="new">no-space<ph disp="{{ myLabel }}" equiv="INTERPOLATION" id="0"/> <ph disp="{{ myNumber }}" equiv="INTERPOLATION_1" id="1"/></target>\n' +
                     '      </trans-unit>\n' +
                     '    </body>\n' +
                     '  </file>\n' +

diff --git a/src/model/translationFileSerialization.spec.ts b/src/model/translationFileSerialization.spec.ts
@@ -266,7 +266,7 @@ describe('translationFileSerialization', () => {
             const translationFile = fromXlf1(xlf1);
             expect(translationFile).toEqual(new TranslationFile([{
                 id: 'ID1',
-                source: 'Some text <ph id="0" equiv="INTERPOLATION" disp="{{ myLabel }}"/>',
+                source: 'Some text <ph disp="{{ myLabel }}" equiv="INTERPOLATION" id="0"/>',
                 locations: []
             }], 'de', undefined, undefined));
         });

diff --git a/src/model/translationFileSerialization.ts b/src/model/translationFileSerialization.ts
@@ -64,7 +64,13 @@ export function fromXlf1(xlf1: string): TranslationFile {
 }
 
 function toString(...nodes: XmlNode[]): string {
-    return nodes.map(n => n.toString({preserveWhitespace: true, compressed: true})).join('');
+    return nodes.map(n => {
+        if (n instanceof XmlElement) {
+            const attr = Object.entries(n.attr).sort((a, b) => a[0].localeCompare(b[0]));
+            n.attr = Object.fromEntries(attr);
+        }
+        return n.toString({ preserveWhitespace: true, compressed: true });
+    }).join('');
 }
 
 function toStringOrUndefined(nodes: XmlNode[] | undefined): string | undefined {