fix(formatters): fix typing inconsistency and add tsd test for each p…

…ackage (#1547)

packages/format-csv/__typetests__/index.test-d.ts

@@ -0,0 +1,5 @@
+import { CatalogFormatter } from "@lingui/conf"
+import { expectAssignable } from "tsd"
+import { formatter } from "@lingui/format-csv"
+
+expectAssignable<CatalogFormatter>(formatter())

packages/format-csv/__typetests__/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "moduleResolution": "Node16",
+    "skipLibCheck": true,
+    "esModuleInterop": true
+  },
+  "paths": {}
+}

packages/format-csv/package.json

@@ -41,6 +41,7 @@
     "papaparse": "^5.4.0"
   },
   "devDependencies": {
+    "tsd": "^0.28.0",
     "unbuild": "^1.1.2"
   }
 }

packages/format-json/__typetests__/index.test-d.ts

@@ -0,0 +1,8 @@
+import { CatalogFormatter } from "@lingui/conf"
+import { expectAssignable } from "tsd"
+import { formatter } from "@lingui/format-json"
+
+expectAssignable<CatalogFormatter>(formatter())
+expectAssignable<CatalogFormatter>(
+  formatter({ lineNumbers: true, origins: true })
+)

packages/format-json/__typetests__/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "moduleResolution": "Node16",
+    "skipLibCheck": true,
+    "esModuleInterop": true
+  },
+  "paths": {}
+}

packages/format-json/package.json

@@ -41,6 +41,7 @@
     "ramda": "^0.28.0"
   },
   "devDependencies": {
+    "tsd": "^0.28.0",
     "unbuild": "^1.1.2"
   }
 }

packages/format-po-gettext/__typetests__/index.test-d.ts

@@ -0,0 +1,13 @@
+import { CatalogFormatter } from "@lingui/conf"
+import { expectAssignable } from "tsd"
+import { formatter } from "@lingui/format-po-gettext"
+
+expectAssignable<CatalogFormatter>(formatter())
+expectAssignable<CatalogFormatter>(
+  formatter({
+    lineNumbers: true,
+    origins: true,
+    printLinguiId: true,
+    disableSelectWarning: true,
+  })
+)

packages/format-po-gettext/__typetests__/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "moduleResolution": "Node16",
+    "skipLibCheck": true,
+    "esModuleInterop": true
+  },
+  "paths": {}
+}

packages/format-po-gettext/package.json

@@ -49,6 +49,7 @@
   },
   "devDependencies": {
     "@lingui/jest-mocks": "workspace:^",
+    "tsd": "^0.28.0",
     "unbuild": "^1.1.2"
   }
 }

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

@@ -2,11 +2,24 @@ import { mockConsole } from "@lingui/jest-mocks"
 import fs from "fs"
 import path from "path"
 
-import { CatalogType } from "@lingui/conf"
+import { CatalogFormatter, CatalogType } from "@lingui/conf"
 import { formatter as createFormat } from "./po-gettext"
 
+const defaultParseCtx: Parameters<CatalogFormatter["parse"]>[1] = {
+  locale: "en",
+  sourceLocale: "en",
+  filename: "file.po",
+}
+
+const defaultSerializeCtx: Parameters<CatalogFormatter["serialize"]>[1] = {
+  locale: "en",
+  existing: null,
+  filename: "file.po",
+  sourceLocale: "en",
+}
+
 describe("po-gettext format", () => {
-  let format = createFormat()
+  const format = createFormat()
 
   afterEach(() => {
     jest.useRealTimers()
@@ -50,10 +63,7 @@ describe("po-gettext format", () => {
       },
     }
 
-    const pofile = format.serialize(catalog, {
-      locale: "en",
-      existing: null,
-    })
+    const pofile = format.serialize(catalog, defaultSerializeCtx)
 
     expect(pofile).toMatchSnapshot()
   })
@@ -63,7 +73,8 @@ describe("po-gettext format", () => {
       .readFileSync(path.join(__dirname, "fixtures/messages_plural.po"))
       .toString()
 
-    const catalog = format.parse(pofile)
+    const catalog = format.parse(pofile, defaultParseCtx)
+
     expect(catalog).toMatchSnapshot()
   })
 
@@ -94,7 +105,7 @@ describe("po-gettext format", () => {
     }
 
     mockConsole((console) => {
-      format.serialize(catalog, { existing: null, locale: "en" })
+      format.serialize(catalog, defaultSerializeCtx)
 
       expect(console.warn).toHaveBeenCalledWith(
         expect.stringContaining("Nested plurals"),
@@ -118,7 +129,7 @@ msgstr[1] "# dny"
 msgstr[2] "# dní"
   `
 
-    const parsed = format.parse(po)
+    const parsed = format.parse(po, defaultParseCtx)
 
     expect(parsed).toEqual({
       Y8Xw2Y: {
@@ -145,7 +156,7 @@ msgstr[2] "# dní"
 
     it("should warn", () => {
       mockConsole((console) => {
-        format.serialize(catalog, { locale: "en", existing: null })
+        format.serialize(catalog, defaultSerializeCtx)
 
         expect(console.warn).toHaveBeenCalledWith(
           expect.stringContaining("select"),
@@ -158,7 +169,7 @@ msgstr[2] "# dní"
       const format = createFormat({ disableSelectWarning: true })
 
       mockConsole((console) => {
-        format.serialize(catalog, { locale: "en", existing: null })
+        format.serialize(catalog, defaultSerializeCtx)
 
         expect(console.warn).not.toHaveBeenCalled()
       })
@@ -175,7 +186,7 @@ msgstr[2] "# dní"
 
     it("should warn", () => {
       mockConsole((console) => {
-        format.serialize(catalog, { locale: "en", existing: null })
+        format.serialize(catalog, defaultSerializeCtx)
 
         expect(console.warn).toHaveBeenCalledWith(
           expect.stringContaining("selectOrdinal"),
@@ -188,7 +199,7 @@ msgstr[2] "# dní"
       const format = createFormat({ disableSelectWarning: true })
 
       mockConsole((console) => {
-        format.serialize(catalog, { locale: "en", existing: null })
+        format.serialize(catalog, defaultSerializeCtx)
 
         expect(console.warn).not.toHaveBeenCalled()
       })
@@ -202,7 +213,8 @@ msgstr[2] "# dní"
       )
       .toString()
 
-    const catalog = format.parse(pofile)
+    const catalog = format.parse(pofile, defaultParseCtx)
+
     expect(catalog).toMatchSnapshot()
   })
 })

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

@@ -238,7 +238,9 @@ const convertPluralsToICU = (
   item.msgstr = ["{" + pluralizeOn + ", plural, " + pluralClauses + "}"]
 }
 
-export function formatter(options: PoGettextFormatterOptions = {}) {
+export function formatter(
+  options: PoGettextFormatterOptions = {}
+): CatalogFormatter {
   options = {
     origins: true,
     lineNumbers: true,
@@ -251,7 +253,7 @@ export function formatter(options: PoGettextFormatterOptions = {}) {
     catalogExtension: ".po",
     templateExtension: ".pot",
 
-    parse(content): CatalogType {
+    parse(content, ctx): CatalogType {
       const po = PO.parse(content)
 
       // .po plurals are numbered 0-N and need to be mapped to ICU plural classes ("one", "few", "many"...). Different
@@ -263,14 +265,11 @@ export function formatter(options: PoGettextFormatterOptions = {}) {
         convertPluralsToICU(item, pluralForms, po.headers.Language)
       })
 
-      return formatter.parse(po.toString())
+      return formatter.parse(po.toString(), ctx) as CatalogType
     },
 
-    serialize(
-      catalog: CatalogType,
-      ctx: { locale: string; existing: string }
-    ): string {
-      const po = PO.parse(formatter.serialize(catalog, ctx))
+    serialize(catalog, ctx): string {
+      const po = PO.parse(formatter.serialize(catalog, ctx) as string)
 
       po.items = po.items.map((item) => {
         const isGeneratedId = !item.flags["explicit-id"]
@@ -283,5 +282,5 @@ export function formatter(options: PoGettextFormatterOptions = {}) {
 
       return po.toString()
     },
-  } satisfies CatalogFormatter
+  }
 }

packages/format-po/__typetests__/index.test-d.ts

@@ -0,0 +1,12 @@
+import { CatalogFormatter } from "@lingui/conf"
+import { expectAssignable } from "tsd"
+import { formatter } from "@lingui/format-po"
+
+expectAssignable<CatalogFormatter>(formatter())
+expectAssignable<CatalogFormatter>(
+  formatter({
+    lineNumbers: true,
+    origins: true,
+    printLinguiId: true,
+  })
+)

packages/format-po/__typetests__/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "moduleResolution": "Node16",
+    "skipLibCheck": true,
+    "esModuleInterop": true
+  },
+  "paths": {}
+}

packages/format-po/package.json

@@ -46,6 +46,7 @@
   },
   "devDependencies": {
     "@lingui/jest-mocks": "workspace:^",
+    "tsd": "^0.28.0",
     "unbuild": "^1.1.2"
   }
 }

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

@@ -2,7 +2,20 @@ import fs from "fs"
 import path from "path"
 
 import { formatter as createFormatter } from "./po"
-import { CatalogType } from "@lingui/conf"
+import { CatalogFormatter, CatalogType } from "@lingui/conf"
+
+const defaultParseCtx: Parameters<CatalogFormatter["parse"]>[1] = {
+  locale: "en",
+  sourceLocale: "en",
+  filename: "file.po",
+}
+
+const defaultSerializeCtx: Parameters<CatalogFormatter["serialize"]>[1] = {
+  locale: "en",
+  existing: null,
+  filename: "file.po",
+  sourceLocale: "en",
+}
 
 describe("pofile format", () => {
   jest.useFakeTimers().setSystemTime(new Date("2018-08-27T10:00Z").getTime())
@@ -65,10 +78,7 @@ describe("pofile format", () => {
       },
     }
 
-    const pofile = format.serialize(catalog, {
-      locale: "en",
-      existing: null,
-    })
+    const pofile = format.serialize(catalog, defaultSerializeCtx)
     expect(pofile).toMatchSnapshot()
   })
 
@@ -79,7 +89,7 @@ describe("pofile format", () => {
       .readFileSync(path.join(__dirname, "fixtures/messages.po"))
       .toString()
 
-    const actual = format.parse(pofile)
+    const actual = format.parse(pofile, defaultParseCtx)
     expect(actual).toMatchSnapshot()
   })
 
@@ -95,12 +105,9 @@ describe("pofile format", () => {
       },
     }
 
-    const serialized = format.serialize(catalog, {
-      locale: "en",
-      existing: null,
-    })
+    const serialized = format.serialize(catalog, defaultSerializeCtx) as string
 
-    const actual = format.parse(serialized)
+    const actual = format.parse(serialized, defaultParseCtx)
     expect(actual).toMatchObject(catalog)
   })
 
@@ -116,10 +123,7 @@ describe("pofile format", () => {
       },
     }
 
-    const serialized = format.serialize(catalog, {
-      locale: "en",
-      existing: null,
-    })
+    const serialized = format.serialize(catalog, defaultSerializeCtx)
 
     expect(serialized).toMatchSnapshot()
   })
@@ -137,10 +141,7 @@ describe("pofile format", () => {
       },
     }
 
-    const serialized = format.serialize(catalog, {
-      locale: "en",
-      existing: null,
-    })
+    const serialized = format.serialize(catalog, defaultSerializeCtx)
 
     expect(serialized).toMatchSnapshot()
   })
@@ -164,7 +165,7 @@ describe("pofile format", () => {
       msgstr "Second description joins translator comments"
     `
 
-    const actual = format.parse(po)
+    const actual = format.parse(po, defaultParseCtx)
     expect(actual).toMatchSnapshot()
   })
 
@@ -188,7 +189,7 @@ describe("pofile format", () => {
       },
     }
 
-    const actual = format.serialize(catalog, { locale: "en", existing: null })
+    const actual = format.serialize(catalog, defaultSerializeCtx)
     const pofileOriginPrefix = "#:"
     expect(actual).toEqual(expect.not.stringContaining(pofileOriginPrefix))
   })
@@ -212,10 +213,7 @@ describe("pofile format", () => {
         ],
       },
     }
-    const actual = format.serialize(catalog, {
-      locale: "en",
-      existing: null,
-    })
+    const actual = format.serialize(catalog, defaultSerializeCtx)
 
     expect(actual).toMatchInlineSnapshot(`
       msgid ""
@@ -262,10 +260,7 @@ describe("pofile format", () => {
       },
     }
 
-    const actual = format.serialize(catalog, {
-      locale: "en",
-      existing: null,
-    })
+    const actual = format.serialize(catalog, defaultSerializeCtx)
 
     expect(actual).toMatchInlineSnapshot(`
       msgid ""