feat: add translation status to language settings (#1717)

scripts/prepare-translation-status.ts

@@ -0,0 +1,137 @@
+import flatten from 'flat'
+import { createResolver } from '@nuxt/kit'
+import fs from 'fs-extra'
+import { currentLocales } from '../config/i18n'
+import vsCodeConfig from '../.vscode/settings.json'
+import type { LocaleEntry } from '../docs/types'
+import type { ElkTranslationStatus } from '~/types/translation-status'
+
+export const localeData: [code: string, file: string[], title: string][]
+    = currentLocales.map((l: any) => [l.code, l.files ? l.files : [l.file!], l.name ?? l.code])
+
+function merge(src: Record<string, any>, dst: Record<string, any>) {
+  for (const key in src) {
+    if (typeof src[key] === 'object') {
+      if (!dst[key])
+        dst[key] = {}
+
+      merge(src[key], dst[key])
+    }
+    else {
+      dst[key] = src[key]
+    }
+  }
+}
+
+async function readI18nFile(file: string | string[]) {
+  const resolver = createResolver(import.meta.url)
+  if (Array.isArray(file)) {
+    const files = await Promise.all(file.map(f => async () => {
+      return JSON.parse(Buffer.from(
+        await fs.readFile(resolver.resolve(`../locales/${f}`), 'utf-8'),
+      ).toString())
+    })).then(f => f.map(f => f()))
+    const data: Record<string, any> = files[0]
+    files.splice(0, 1)
+    files.forEach(f => merge(f, data))
+    return data
+  }
+  else {
+    return JSON.parse(Buffer.from(
+      await fs.readFile(resolver.resolve(`../locales/${file}`), 'utf-8'),
+    ).toString())
+  }
+}
+
+async function compare(
+  baseEntries: Record<string, string>,
+  file: string | string[],
+  data: LocaleEntry,
+) {
+  const baseEntriesKeys = Object.keys(baseEntries)
+  const entries: Record<string, any> = await readI18nFile(file)
+  const flatEntriesKeys = Object.keys(flatten<typeof entries, Record<string, string>>(entries))
+
+  data.translated = flatEntriesKeys.filter(e => baseEntriesKeys.includes(e))
+  data.missing = baseEntriesKeys.filter(e => !flatEntriesKeys.includes(e))
+  data.outdated = flatEntriesKeys.filter(e => !baseEntriesKeys.includes(e))
+  data.total = flatEntriesKeys.length
+}
+
+async function prepareTranslationStatus() {
+  const sourceLanguageLocale = localeData.find(l => l[0] === vsCodeConfig['i18n-ally.sourceLanguage'])!
+  const entries: Record<string, any> = await readI18nFile(sourceLanguageLocale[1])
+  const flatEntries = flatten<typeof entries, Record<string, string>>(entries)
+  const total = Object.keys(flatEntries).length
+  const data: Record<string, LocaleEntry> = {
+    en: {
+      translated: [],
+      file: 'en.json',
+      missing: [],
+      outdated: [],
+      title: 'English (source)',
+      total,
+      isSource: true,
+    },
+  }
+
+  await Promise.all(localeData.filter(l => l[0] !== 'en-US').map(async ([code, file, title]) => {
+    console.info(`Comparing ${code}...`, title)
+    data[code] = {
+      title,
+      file: Array.isArray(file) ? file[file.length - 1] : file,
+      translated: [],
+      missing: [],
+      outdated: [],
+      total: 0,
+    }
+    await compare(flatEntries, file, data[code])
+  }))
+
+  const sorted: Record<string, any> = { en: { ...data.en } }
+
+  Object.keys(data).filter(k => k !== 'en').sort((a, b) => {
+    return data[a].translated.length - data[b].translated.length
+  }).forEach((k) => {
+    sorted[k] = { ...data[k] }
+  })
+
+  const resolver = createResolver(import.meta.url)
+
+  await fs.writeFile(
+    resolver.resolve('../docs/translation-status.json'),
+    JSON.stringify(sorted, null, 2),
+    { encoding: 'utf-8' },
+  )
+
+  const translationStatus: ElkTranslationStatus = {
+    total,
+    locales: {
+      'en-US': {
+        total,
+        percentage: '100',
+      },
+    },
+  }
+
+  Object.keys(data).filter(k => k !== 'en').forEach((e) => {
+    const percentage = total <= 0.0 || data[e].total === 0.0
+      ? '0'
+      : data[e].total === total
+        ? '100'
+        : ((data[e].translated.length / total) * 100).toFixed(1)
+
+    translationStatus.locales[e] = {
+      total: data[e].total,
+      percentage,
+    }
+  })
+
+  await fs.writeFile(
+    resolver.resolve('../elk-translation-status.json'),
+    JSON.stringify(translationStatus, null, 2),
+    { encoding: 'utf-8' },
+  )
+}
+
+prepareTranslationStatus()