chore: upgrade pofile-ts to v3.0.0

BREAKING CHANGE: pofile-ts v3.0.0 uses a functional API instead of classes

Migration:
- PO.parse() → parsePo()
- po.toString() → stringifyPo(po)
- new PO() → createPoFile()
- new PO.Item() → createItem()
- PO class → PoFile interface
- Item class → PoItem interface

Author: swernerx

packages/cli/package.json

@@ -80,7 +80,7 @@
     "normalize-path": "^3.0.0",
     "ora": "^5.1.0",
     "picocolors": "^1.1.1",
-    "pofile-ts": "^2.2.0",
+    "pofile-ts": "^3.0.0",
     "pseudolocale": "^2.0.0",
     "source-map": "^0.7.6",
     "threads": "^1.7.0"

packages/cli/src/services/translationIO.ts

@@ -1,6 +1,13 @@
 import fs from "fs"
 import { dirname } from "path"
-import PO, { Item as POItem, type Headers as POHeaders } from "pofile-ts"
+import {
+  parsePo,
+  stringifyPo,
+  createPoFile,
+  createItem,
+  type PoItem,
+  type Headers as POHeaders,
+} from "pofile-ts"
 import https from "https"
 import { globSync } from "glob"
 import { format as formatDate } from "date-fns"
@@ -109,7 +116,7 @@ function init(
   // Create segments from source locale PO items
   paths[sourceLocale].forEach((path) => {
     const raw = fs.readFileSync(path).toString()
-    const po = PO.parse(raw)
+    const po = parsePo(raw)
 
     po.items
       .filter((item) => !item["obsolete"])
@@ -126,7 +133,7 @@ function init(
   targetLocales.forEach((targetLocale) => {
     paths[targetLocale].forEach((path) => {
       const raw = fs.readFileSync(path).toString()
-      const po = PO.parse(raw)
+      const po = parsePo(raw)
 
       po.items
         .filter((item) => !item["obsolete"])
@@ -181,7 +188,7 @@ function sync(
   // Create segments with correct source
   paths[sourceLocale].forEach((path) => {
     const raw = fs.readFileSync(path).toString()
-    const po = PO.parse(raw)
+    const po = parsePo(raw)
 
     po.items
       .filter((item) => !item["obsolete"])
@@ -223,7 +230,7 @@ function sync(
   )
 }
 
-function createSegmentFromPoItem(item: POItem) {
+function createSegmentFromPoItem(item: PoItem) {
   const itemHasExplicitId = item.extractedComments.includes(EXPLICIT_ID_FLAG)
   const itemHasContext = item.msgctxt != null
 
@@ -276,7 +283,7 @@ function createPoItemFromSegment(segment: TranslationIoSegment) {
     EXPLICIT_ID_AND_CONTEXT_FLAG
   )
 
-  const item = new PO.Item()
+  const item = createItem()
 
   if (segmentHasExplicitId || segmentHasExplicitIdAndContext) {
     item.msgid = segment.context
@@ -337,10 +344,10 @@ function saveSegmentsToTargetPos(
     )
     const segments = segmentsPerLocale[targetLocale]
 
-    const po = new PO()
+    const po = createPoFile()
     po.headers = getCreateHeaders(targetLocale)
 
-    const items: POItem[] = []
+    const items: PoItem[] = []
 
     segments.forEach((segment: TranslationIoSegment) => {
       const item = createPoItemFromSegment(segment)
@@ -362,7 +369,7 @@ function saveSegmentsToTargetPos(
     /* istanbul ignore next -- @preserve Integration with external Translation.io service */
     fs.promises
       .mkdir(dirname(localePath), { recursive: true })
-      .then(() => fs.promises.writeFile(localePath, po.toString()))
+      .then(() => fs.promises.writeFile(localePath, stringifyPo(po)))
       .catch((err) => {
         console.error("Error while saving target PO files:")
         console.error(err)

packages/format-po-gettext/package.json

@@ -50,7 +50,7 @@
     "cldr-core": "^45.0.0",
     "node-gettext": "^3.0.0",
     "plurals-cldr": "^2.0.1",
-    "pofile-ts": "^2.2.0"
+    "pofile-ts": "^3.0.0"
   },
   "devDependencies": {
     "@lingui/jest-mocks": "workspace:^",

packages/format-po-gettext/src/po-gettext.ts

@@ -1,6 +1,6 @@
 import { parse as parseIcu, Select, SelectCase } from "@messageformat/parser"
 import pluralsCldr from "plurals-cldr"
-import PO, { Item as POItem } from "pofile-ts"
+import { parsePo, stringifyPo, createItem, type PoItem } from "pofile-ts"
 import gettextPlurals from "node-gettext/lib/plurals"
 
 import type { CatalogFormatter, CatalogType, MessageType } from "@lingui/conf"
@@ -50,12 +50,12 @@ const LINE_ENDINGS = /\r?\n/g
 const DEFAULT_CTX_PREFIX = "js-lingui:"
 
 function serializePlurals(
-  item: POItem,
+  item: PoItem,
   message: MessageType,
   id: string,
   isGeneratedId: boolean,
   options: PoGettextFormatterOptions
-): POItem {
+): PoItem {
   // Depending on whether custom ids are used by the developer, the (potential plural) "original", untranslated ICU
   // message can be found in `message.message` or in the item's `key` itself.
   const icuMessage = message.message
@@ -223,7 +223,7 @@ function parsePluralFormsFn(pluralFormsHeader: string): GettextPluralsInfo {
 }
 
 const convertPluralsToICU = (
-  item: POItem,
+  item: PoItem,
   pluralForms: string[],
   lang: string,
   ctxPrefix: string = DEFAULT_CTX_PREFIX
@@ -304,7 +304,7 @@ const convertPluralsToICU = (
 }
 
 const updateContextComment = (
-  item: POItem,
+  item: PoItem,
   contextComment: string,
   ctxPrefix: string
 ) => {
@@ -367,11 +367,11 @@ function getContextFromComments(
  * This happens when plural calls have identical strings but different variables
  */
 function mergeDuplicatePluralEntries(
-  items: POItem[],
+  items: PoItem[],
   options: PoGettextFormatterOptions
-): POItem[] {
+): PoItem[] {
   const ctxPrefix = options.customICUPrefix || DEFAULT_CTX_PREFIX
-  const itemMap = new Map<string, POItem[]>()
+  const itemMap = new Map<string, PoItem[]>()
 
   // Group items by msgid + msgid_plural combination
   for (const item of items) {
@@ -385,7 +385,7 @@ function mergeDuplicatePluralEntries(
     }
   }
 
-  const mergedItems: POItem[] = []
+  const mergedItems: PoItem[] = []
 
   for (const duplicateItems of itemMap.values()) {
     if (duplicateItems.length === 1) {
@@ -439,11 +439,11 @@ function replaceArgInIcu(icu: string, oldVar: string, newVar: string) {
  * This ensures all original message IDs are available in the compiled catalog
  */
 function expandMergedPluralEntries(
-  items: POItem[],
+  items: PoItem[],
   options: PoGettextFormatterOptions
-): POItem[] {
+): PoItem[] {
   const ctxPrefix = options.customICUPrefix || DEFAULT_CTX_PREFIX
-  const expandedItems: POItem[] = []
+  const expandedItems: PoItem[] = []
 
   for (const item of items) {
     if (!item.msgid_plural) {
@@ -473,7 +473,7 @@ function expandMergedPluralEntries(
 
     // Create a new item for each variable after first
     for (const variable of variableList) {
-      const newItem = new PO.Item()
+      const newItem = createItem()
 
       // Set the msgid to the original ICU message
       newItem.msgid = item.msgid
@@ -519,7 +519,7 @@ export function formatter(
     templateExtension: ".pot",
 
     parse(content, ctx): CatalogType {
-      const po = PO.parse(content)
+      const po = parsePo(content)
 
       if (options.mergePlurals) {
         // Expand merged entries back to individual catalog entries BEFORE ICU conversion
@@ -543,11 +543,11 @@ export function formatter(
         )
       })
 
-      return formatter.parse(po.toString(), ctx) as CatalogType
+      return formatter.parse(stringifyPo(po), ctx) as CatalogType
     },
 
     serialize(catalog, ctx): string {
-      const po = PO.parse(formatter.serialize(catalog, ctx) as string)
+      const po = parsePo(formatter.serialize(catalog, ctx) as string)
 
       po.items = po.items.map((item) => {
         const isGeneratedId = !item.extractedComments.includes(
@@ -564,7 +564,7 @@ export function formatter(
         // Merge duplicate entries that have the same msgid and msgid_plural
         const mergedPlurals = mergeDuplicatePluralEntries(po.items, options)
         const newItems = []
-        const processed = new Set<POItem>()
+        const processed = new Set<PoItem>()
 
         // adding it this way versus just adding all mergedPlurals preserves order of translations
 
@@ -587,7 +587,7 @@ export function formatter(
         po.items = newItems
       }
 
-      return po.toString()
+      return stringifyPo(po)
     },
   }
 }

packages/format-po/package.json

@@ -46,7 +46,7 @@
     "@lingui/conf": "5.6.1",
     "@lingui/message-utils": "5.6.1",
     "date-fns": "^3.6.0",
-    "pofile-ts": "^2.2.0"
+    "pofile-ts": "^3.0.0"
   },
   "devDependencies": {
     "@lingui/jest-mocks": "workspace:^",

packages/format-po/src/po.ts

@@ -1,5 +1,13 @@
 import { format as formatDate } from "date-fns"
-import PO, { Item as POItem, type Headers as POHeaders } from "pofile-ts"
+import {
+  parsePo,
+  stringifyPo,
+  createPoFile,
+  createItem,
+  type PoFile,
+  type PoItem,
+  type Headers as POHeaders,
+} from "pofile-ts"
 
 import { CatalogFormatter, CatalogType, MessageType } from "@lingui/conf"
 import { generateMessageId } from "@lingui/message-utils/generateMessageId"
@@ -127,7 +135,7 @@ const serialize = (catalog: CatalogType, options: PoFormatterOptions) => {
   return Object.keys(catalog).map((id) => {
     const message: MessageType<POCatalogExtra> = catalog[id]
 
-    const item = new PO.Item()
+    const item = createItem()
 
     // The extractedComments array may be modified in this method,
     // so create a new array with the message's elements.
@@ -215,7 +223,7 @@ const serialize = (catalog: CatalogType, options: PoFormatterOptions) => {
 }
 
 function deserialize(
-  items: POItem[],
+  items: PoItem[],
   options: PoFormatterOptions
 ): CatalogType {
   return items.reduce<CatalogType<POCatalogExtra>>((catalog, item) => {
@@ -260,17 +268,17 @@ export function formatter(options: PoFormatterOptions = {}): CatalogFormatter {
     templateExtension: ".pot",
 
     parse(content): CatalogType {
-      const po = PO.parse(content)
+      const po = parsePo(content)
       return deserialize(po.items, options)
     },
 
     serialize(catalog, ctx): string {
-      let po: PO
+      let po: PoFile
 
       if (ctx.existing) {
-        po = PO.parse(ctx.existing)
+        po = parsePo(ctx.existing)
       } else {
-        po = new PO()
+        po = createPoFile()
         po.headers = getCreateHeaders(
           ctx.locale,
           options.customHeaderAttributes
@@ -280,7 +288,7 @@ export function formatter(options: PoFormatterOptions = {}): CatalogFormatter {
       }
 
       po.items = serialize(catalog, options)
-      return po.toString()
+      return stringifyPo(po)
     },
   }
 }

yarn.lock

@@ -3029,7 +3029,7 @@ __metadata:
     normalize-path: ^3.0.0
     ora: ^5.1.0
     picocolors: ^1.1.1
-    pofile-ts: ^2.2.0
+    pofile-ts: ^3.0.0
     pseudolocale: ^2.0.0
     source-map: ^0.7.6
     threads: ^1.7.0
@@ -3135,7 +3135,7 @@ __metadata:
     mockdate: ^3.0.5
     node-gettext: ^3.0.0
     plurals-cldr: ^2.0.1
-    pofile-ts: ^2.2.0
+    pofile-ts: ^3.0.0
     unbuild: 2.0.0
   languageName: unknown
   linkType: soft
@@ -3149,7 +3149,7 @@ __metadata:
     "@lingui/message-utils": 5.6.1
     date-fns: ^3.6.0
     mockdate: ^3.0.5
-    pofile-ts: ^2.2.0
+    pofile-ts: ^3.0.0
     unbuild: 2.0.0
   languageName: unknown
   linkType: soft
@@ -13769,10 +13769,10 @@ __metadata:
   languageName: node
   linkType: hard
 
-"pofile-ts@npm:^2.2.0":
-  version: 2.2.0
-  resolution: "pofile-ts@npm:2.2.0"
-  checksum: f0d4b6c8b22e2e8ea4be98e8d20794cd0f40969e26dc35b2b0d0668a0a593d467b14145e10b9ebe9abc8b6c969d2b19ab390f26b8e57d79ea23195fa5aa5b958
+"pofile-ts@npm:^3.0.0":
+  version: 3.0.0
+  resolution: "pofile-ts@npm:3.0.0"
+  checksum: 9d4a1737a4dad8e6ae9f7716ba050a9f5c758403f57e09abff50c5613b16095d2c7e13aadfaa888ad06df3d6905153b561a23b4332d18383ee2e59d9ff664237
   languageName: node
   linkType: hard