fix(extractor): sort placeholders to keep them stable between runs (#2307)

Author: timofei-iatsenko

packages/cli/src/api/catalog.test.ts

@@ -193,6 +193,39 @@ describe("Catalog", () => {
       expect(messages).toMatchSnapshot()
     })
 
+    it("should sort placeholders to keep them stable between runs", async () => {
+      const runA = await extractFromFiles(
+        [
+          fixture("collect-placeholders-sorting/a.ts"),
+          fixture("collect-placeholders-sorting/b.ts"),
+        ],
+        mockConfig()
+      )
+
+      const runB = await extractFromFiles(
+        [
+          fixture("collect-placeholders-sorting/b.ts"),
+          fixture("collect-placeholders-sorting/a.ts"),
+        ],
+        mockConfig()
+      )
+
+      expect(Object.values(runA)[0].placeholders[0]).toStrictEqual(
+        Object.values(runB)[0].placeholders[0]
+      )
+
+      expect(Object.values(runA)[0].placeholders).toMatchInlineSnapshot(`
+        {
+          0: [
+            getUser(),
+            getWorld(),
+          ],
+        }
+      `)
+
+      // expect(messages).toMatchSnapshot()
+    })
+
     it("should support experimental typescript decorators under a flag", async () => {
       const messages = await extractFromFiles(
         [fixture("collect-typescript-jsx/tsx-experimental-decorators.tsx")],

packages/cli/src/api/catalog/extractFromFiles.ts

@@ -23,6 +23,8 @@ function mergePlaceholders(
     if (!res[key].includes(value)) {
       res[key].push(value)
     }
+
+    res[key].sort()
   })
 
   return res

packages/cli/src/api/fixtures/collect-placeholders-sorting/a.ts

@@ -0,0 +1,7 @@
+import { t } from "@lingui/core/macro";
+
+function getUser() {
+  return 'John'
+}
+
+t`Hello ${getUser()}`

packages/cli/src/api/fixtures/collect-placeholders-sorting/b.ts

@@ -0,0 +1,7 @@
+import { t } from "@lingui/core/macro"
+
+function getWorld() {
+  return "John"
+}
+
+t`Hello ${getWorld()}`

packages/cli/test/extract-po-format/expected/en.po

@@ -13,9 +13,9 @@ msgstr ""
 msgid "addToCart"
 msgstr "Add To Cart"
 
-#. placeholder {0}: user.name
 #. placeholder {0}: author.name
 #. placeholder {0}: moderator.name
+#. placeholder {0}: user.name
 #: fixtures/placeholders.ts:3
 #: fixtures/placeholders.ts:4
 #: fixtures/placeholders.ts:5

packages/cli/test/extract-po-format/expected/pl.po

@@ -13,9 +13,9 @@ msgstr ""
 msgid "addToCart"
 msgstr ""
 
-#. placeholder {0}: user.name
 #. placeholder {0}: author.name
 #. placeholder {0}: moderator.name
+#. placeholder {0}: user.name
 #: fixtures/placeholders.ts:3
 #: fixtures/placeholders.ts:4
 #: fixtures/placeholders.ts:5