refactor: type safety, explicit options

Author: danielroe

lunaria/prepare-json-files.ts

@@ -37,27 +37,30 @@ export async function prepareJsonFiles(): Promise<void> {
   await Promise.all(currentLocales.map(l => mergeLocale(l)))
 }
 
+type NestedObject = Record<string, unknown>
+
 export async function mergeLocaleObject(
   locale: LocaleObject,
-  copy = false,
-): Promise<void | unknown> {
+  options: { copy?: boolean } = {},
+): Promise<NestedObject | undefined> {
+  const { copy = false } = options
   const files = locale.files ?? []
   if (locale.file || files.length === 1) {
     const json =
       (locale.file ? getFileName(locale.file) : undefined) ??
       (files[0] ? getFileName(files[0]) : undefined)
-    if (!json) return
+    if (!json) return undefined
     if (copy) {
       await fs.cp(path.resolve(`${localesFolder}/${json}`), path.resolve(`${destFolder}/${json}`))
-      return
+      return undefined
     }
 
-    return await loadJsonFile(json)
+    return await loadJsonFile<NestedObject>(json)
   }
 
   const firstFile = files[0]
-  if (!firstFile) return
-  const source = await loadJsonFile(getFileName(firstFile))
+  if (!firstFile) return undefined
+  const source = await loadJsonFile<NestedObject>(getFileName(firstFile))
   let currentSource: unknown
   for (let i = 1; i < files.length; i++) {
     const file = files[i]
@@ -69,7 +72,7 @@ export async function mergeLocaleObject(
   return source
 }
 
-async function loadJsonFile(name: string): Promise<unknown> {
+async function loadJsonFile<T = unknown>(name: string): Promise<T> {
   return JSON.parse(await fs.readFile(path.resolve(`${localesFolder}/${name}`), 'utf8'))
 }
 
@@ -78,7 +81,7 @@ function getFileName(file: string | { path: string }): string {
 }
 
 async function mergeLocale(locale: LocaleObject): Promise<void> {
-  const source = await mergeLocaleObject(locale, true)
+  const source = await mergeLocaleObject(locale, { copy: true })
   if (!source) {
     return
   }

scripts/compare-translations.ts

@@ -24,14 +24,18 @@ interface LocaleInfo {
 const countries = new Map<string, Map<string, LocaleInfo>>()
 const availableLocales = new Map<string, LocaleObject>()
 
-const extractLocalInfo = (
-  filePath: string,
-  forCountry: boolean = false,
-  mergeLocale: boolean = false,
-): LocaleInfo => {
+function extractLocalInfo(filePath: string): LocaleInfo {
   const locale = basename(filePath, '.json')
   const [lang, country] = locale.split('-')
-  return { filePath, locale, lang, country, forCountry, mergeLocale }
+  return { filePath, locale, lang, country }
+}
+
+function createVariantInfo(
+  code: string,
+  options: { forCountry: boolean; mergeLocale: boolean },
+): LocaleInfo {
+  const [lang, country] = code.split('-')
+  return { filePath: '', locale: code, lang, country, ...options }
 }
 
 const populateLocaleCountries = (): void => {
@@ -42,10 +46,22 @@ const populateLocaleCountries = (): void => {
         countries.set(lang, new Map())
       }
       if (variant.country) {
-        countries.get(lang)!.set(lang, extractLocalInfo(lang, true))
-        countries.get(lang)!.set(variant.code, extractLocalInfo(variant.code, true, true))
+        countries
+          .get(lang)!
+          .set(lang, createVariantInfo(lang, { forCountry: true, mergeLocale: false }))
+        countries
+          .get(lang)!
+          .set(
+            variant.code,
+            createVariantInfo(variant.code, { forCountry: true, mergeLocale: true }),
+          )
       } else {
-        countries.get(lang)!.set(variant.code, extractLocalInfo(variant.code, false, true))
+        countries
+          .get(lang)!
+          .set(
+            variant.code,
+            createVariantInfo(variant.code, { forCountry: false, mergeLocale: true }),
+          )
       }
     }
   }
@@ -117,7 +133,7 @@ const loadJson = async ({ filePath, mergeLocale, locale }: LocaleInfo): Promise<
     console.error(`${COLORS.red}Error: Failed to merge locale "${locale}"${COLORS.reset}`)
     process.exit(1)
   }
-  return merged as NestedObject
+  return merged
 }
 
 type SyncStats = {
@@ -146,8 +162,9 @@ const syncLocaleData = (
     if (isNested(refValue)) {
       const nextTarget = isNested(target[key]) ? target[key] : {}
       const data = syncLocaleData(refValue, nextTarget, stats, fix, propertyPath)
-      // don't add empty objects: --fix will prevent this
-      if (Object.keys(data).length === 0) {
+      // When fixing, empty objects won't occur since missing keys get placeholders.
+      // Without --fix, keep empty objects to preserve structural parity with the reference.
+      if (fix && Object.keys(data).length === 0) {
         delete result[key]
       } else {
         result[key] = data
@@ -359,4 +376,4 @@ const run = async (): Promise<void> => {
   }
 }
 
-run()
+await run()