refactor(cli/catalog): decouple catalog type from Po message shape

lingui · Mar 22, 2023 · 3e2f749 · 3e2f749
1 parent 94a7e3c
commit 3e2f749
Show file tree

Hide file tree

Showing 11 changed files with 428 additions and 319 deletions.
diff --git a/packages/cli/src/api/__snapshots__/catalog.test.ts.snap b/packages/cli/src/api/__snapshots__/catalog.test.ts.snap
diff --git a/packages/cli/src/api/catalog.test.ts b/packages/cli/src/api/catalog.test.ts
@@ -204,8 +204,8 @@ describe("Catalog", () => {
       expect(messages).toMatchInlineSnapshot(`
         {
           xDAtGP: {
+            comments: [],
             context: undefined,
-            extractedComments: [],
             message: Message,
             origin: [
               [

diff --git a/packages/cli/src/api/catalog/extractFromFiles.ts b/packages/cli/src/api/catalog/extractFromFiles.ts
@@ -24,7 +24,7 @@ export async function extractFromFiles(
           messages[next.id] = {
             message: next.message,
             context: next.context,
-            extractedComments: [],
+            comments: [],
             origin: [],
           }
         }
@@ -50,9 +50,9 @@ export async function extractFromFiles(
 
         messages[next.id] = {
           ...prev,
-          extractedComments: next.comment
-            ? [...prev.extractedComments, next.comment]
-            : prev.extractedComments,
+          comments: next.comment
+            ? [...prev.comments, next.comment]
+            : prev.comments,
           origin: [...prev.origin, [filename, next.origin[1]]],
         }
       },

diff --git a/packages/conf/src/types.ts b/packages/conf/src/types.ts
@@ -23,24 +23,28 @@ export type ExtractorCtx = {
   linguiConfig: LinguiConfigNormalized
 }
 
+type CatalogExtra = Record<string, unknown>
 export type MessageOrigin = [filename: string, line?: number]
-export type ExtractedMessageType = {
+export type ExtractedMessageType<Extra = CatalogExtra> = {
   message?: string
   origin?: MessageOrigin[]
   comments?: string[]
-  extractedComments?: string[]
   obsolete?: boolean
-  flags?: string[]
   context?: string
+  /**
+   * the generic field where
+   * formatters can store additional data
+   */
+  extra?: Extra
 }
-export type MessageType = ExtractedMessageType & {
+export type MessageType<Extra = CatalogExtra> = ExtractedMessageType<Extra> & {
   translation: string
 }
-export type ExtractedCatalogType = {
-  [msgId: string]: ExtractedMessageType
+export type ExtractedCatalogType<Extra = CatalogExtra> = {
+  [msgId: string]: ExtractedMessageType<Extra>
 }
-export type CatalogType = {
-  [msgId: string]: MessageType
+export type CatalogType<Extra = CatalogExtra> = {
+  [msgId: string]: MessageType<Extra>
 }
 
 export type ExtractorType = {

diff --git a/packages/format-json/src/__snapshots__/json.test.ts.snap b/packages/format-json/src/__snapshots__/json.test.ts.snap
@@ -36,26 +36,18 @@ exports[`json format style: lingui should write catalog in lingui format 1`] = `
   },
   "withDescription": {
     "translation": "Message with description",
-    "extractedComments": [
+    "comments": [
       "Description is comment from developers to translators"
     ]
   },
   "withComments": {
-    "comments": [
-      "Translator comment",
-      "This one might come from developer"
-    ],
     "translation": "Support translator comments separately"
   },
   "obsolete": {
     "translation": "Obsolete message",
     "obsolete": true
   },
   "withFlags": {
-    "flags": [
-      "fuzzy",
-      "otherFlag"
-    ],
     "translation": "Keeps any flags that are defined"
   },
   "veryLongString": {

diff --git a/packages/format-json/src/json.test.ts b/packages/format-json/src/json.test.ts
@@ -27,23 +27,16 @@ describe("json format", () => {
         },
         withDescription: {
           translation: "Message with description",
-          extractedComments: [
-            "Description is comment from developers to translators",
-          ],
+          comments: ["Description is comment from developers to translators"],
         },
         withComments: {
-          comments: [
-            "Translator comment",
-            "This one might come from developer",
-          ],
           translation: "Support translator comments separately",
         },
         obsolete: {
           translation: "Obsolete message",
           obsolete: true,
         },
         withFlags: {
-          flags: ["fuzzy", "otherFlag"],
           translation: "Keeps any flags that are defined",
         },
         veryLongString: {
@@ -186,23 +179,16 @@ describe("json format", () => {
         },
         withDescription: {
           translation: "Message with description",
-          extractedComments: [
-            "Description is comment from developers to translators",
-          ],
+          comments: ["Description is comment from developers to translators"],
         },
         withComments: {
-          comments: [
-            "Translator comment",
-            "This one might come from developer",
-          ],
           translation: "Support translator comments separately",
         },
         obsolete: {
           translation: "Obsolete message",
           obsolete: true,
         },
         withFlags: {
-          flags: ["fuzzy", "otherFlag"],
           translation: "Keeps any flags that are defined",
         },
       }

diff --git a/packages/format-po-gettext/src/__snapshots__/po-gettext.test.ts.snap b/packages/format-po-gettext/src/__snapshots__/po-gettext.test.ts.snap
@@ -5,8 +5,10 @@ exports[`po-gettext format convertPluralsToIco handle correctly locales with 4-l
   WGI12K: {
     comments: [],
     context: null,
-    extractedComments: [],
-    flags: [],
+    extra: {
+      flags: [],
+      translatorComments: [],
+    },
     message: {anotherCount, plural, one {Singular case} other {Case number {anotherCount}}},
     obsolete: false,
     origin: [],
@@ -15,8 +17,10 @@ exports[`po-gettext format convertPluralsToIco handle correctly locales with 4-l
   jO/SBZ: {
     comments: [],
     context: null,
-    extractedComments: [],
-    flags: [],
+    extra: {
+      flags: [],
+      translatorComments: [],
+    },
     message: {count, plural, one {Singular} other {Plural}},
     obsolete: false,
     origin: [],
@@ -25,23 +29,27 @@ exports[`po-gettext format convertPluralsToIco handle correctly locales with 4-l
   message_with_id: {
     comments: [],
     context: null,
-    extractedComments: [],
-    flags: [
-      explicit-id,
-    ],
+    extra: {
+      flags: [
+        explicit-id,
+      ],
+      translatorComments: [],
+    },
     obsolete: false,
     origin: [],
     translation: {someCount, plural, one {Singular case} other {Case number {someCount}}},
   },
   message_with_id_but_without_translation: {
-    comments: [],
-    context: null,
-    extractedComments: [
+    comments: [
       Comment made by the developers.,
     ],
-    flags: [
-      explicit-id,
-    ],
+    context: null,
+    extra: {
+      flags: [
+        explicit-id,
+      ],
+      translatorComments: [],
+    },
     obsolete: false,
     origin: [],
     translation: ,
@@ -106,8 +114,10 @@ exports[`po-gettext format should convert gettext plurals to ICU plural messages
   WGI12K: {
     comments: [],
     context: null,
-    extractedComments: [],
-    flags: [],
+    extra: {
+      flags: [],
+      translatorComments: [],
+    },
     message: {anotherCount, plural, one {Singular case} other {Case number {anotherCount}}},
     obsolete: false,
     origin: [],
@@ -116,8 +126,10 @@ exports[`po-gettext format should convert gettext plurals to ICU plural messages
   jO/SBZ: {
     comments: [],
     context: null,
-    extractedComments: [],
-    flags: [],
+    extra: {
+      flags: [],
+      translatorComments: [],
+    },
     message: {count, plural, one {Singular} other {Plural}},
     obsolete: false,
     origin: [],
@@ -126,23 +138,27 @@ exports[`po-gettext format should convert gettext plurals to ICU plural messages
   message_with_id: {
     comments: [],
     context: null,
-    extractedComments: [],
-    flags: [
-      explicit-id,
-    ],
+    extra: {
+      flags: [
+        explicit-id,
+      ],
+      translatorComments: [],
+    },
     obsolete: false,
     origin: [],
     translation: {someCount, plural, one {Singular case} other {Case number {someCount}}},
   },
   message_with_id_but_without_translation: {
-    comments: [],
-    context: null,
-    extractedComments: [
+    comments: [
       Comment made by the developers.,
     ],
-    flags: [
-      explicit-id,
-    ],
+    context: null,
+    extra: {
+      flags: [
+        explicit-id,
+      ],
+      translatorComments: [],
+    },
     obsolete: false,
     origin: [],
     translation: ,

diff --git a/packages/format-po-gettext/src/po-gettext.test.ts b/packages/format-po-gettext/src/po-gettext.test.ts
@@ -39,7 +39,7 @@ describe("po-gettext format", () => {
           and linebreak} other {Case number {someCount} with id}}",
         translation:
           "{someCount, plural, one {Singular case with id} other {Case number {someCount} with id}}",
-        extractedComments: [
+        comments: [
           "This is a comment by the developers about how the content must be localized.",
         ],
       },
@@ -131,19 +131,23 @@ msgstr[2] "# dní"
 
     const parsed = format.parse(po, defaultParseCtx)
 
-    expect(parsed).toEqual({
-      Y8Xw2Y: {
-        // Note that the last case must be `other` (the 4th CLDR case name) instead of `many` (the 3rd CLDR case name).
-        translation: "{#, plural, one {# den} few {# dny} other {# dní}}",
-        message: "{#, plural, one {day} other {days}}",
-        extractedComments: [],
-        context: null,
-        comments: [],
-        obsolete: false,
-        origin: [],
-        flags: [],
-      },
-    })
+    // Note that the last case must be `other` (the 4th CLDR case name) instead of `many` (the 3rd CLDR case name).
+    expect(parsed).toMatchInlineSnapshot(`
+      {
+        Y8Xw2Y: {
+          comments: [],
+          context: null,
+          extra: {
+            flags: [],
+            translatorComments: [],
+          },
+          message: {#, plural, one {day} other {days}},
+          obsolete: false,
+          origin: [],
+          translation: {#, plural, one {# den} few {# dny} other {# dní}},
+        },
+      }
+    `)
   })
 
   describe("when using 'select' format", () => {