From f5a54633dca3599dab82730fd7d550c0289f170f Mon Sep 17 00:00:00 2001 From: Sebastian Date: Wed, 17 Jan 2024 10:22:49 -0300 Subject: add translation completeness from pogen to the UI --- packages/demobank-ui/src/components/app.tsx | 4 +- packages/demobank-ui/src/i18n/strings-prelude | 19 ----- packages/demobank-ui/src/i18n/strings.ts | 63 ++++++++------- packages/pogen/src/po2ts.ts | 93 ++++++++++++++++++++--- packages/web-util/src/components/Header.tsx | 4 +- packages/web-util/src/components/LangSelector.tsx | 16 ++-- packages/web-util/src/context/translation.ts | 26 ++++++- packages/web-util/src/hooks/useLang.ts | 36 +++++++-- packages/web-util/src/index.build.ts | 45 +++++++++++ 9 files changed, 231 insertions(+), 75 deletions(-) delete mode 100644 packages/demobank-ui/src/i18n/strings-prelude diff --git a/packages/demobank-ui/src/components/app.tsx b/packages/demobank-ui/src/components/app.tsx index 3d1a43803..c3e579810 100644 --- a/packages/demobank-ui/src/components/app.tsx +++ b/packages/demobank-ui/src/components/app.tsx @@ -24,7 +24,7 @@ import { Fragment, FunctionalComponent, h } from "preact"; import { SWRConfig } from "swr"; import { BackendStateProvider } from "../context/backend.js"; import { BankCoreApiProvider } from "../context/config.js"; -import { strings } from "../i18n/strings.js"; +import { strings, StringsType } from "../i18n/strings.js"; import { BankUiSettings, fetchSettings } from "../settings.js"; import { Routing } from "../Routing.js"; import { BankFrame } from "../pages/BankFrame.js"; @@ -42,7 +42,7 @@ const App: FunctionalComponent = () => { const baseUrl = getInitialBackendBaseURL(settings.backendBaseURL); return ( - + - */ - -/*eslint quote-props: ["error", "consistent"]*/ -export const strings: {[s: string]: any} = {}; - diff --git a/packages/demobank-ui/src/i18n/strings.ts b/packages/demobank-ui/src/i18n/strings.ts index fada43b38..ddff053eb 100644 --- a/packages/demobank-ui/src/i18n/strings.ts +++ b/packages/demobank-ui/src/i18n/strings.ts @@ -1,24 +1,17 @@ -/* - This file is part of GNU Taler - (C) 2022 Taler Systems S.A. - GNU Taler is free software; you can redistribute it and/or modify it under the - terms of the GNU General Public License as published by the Free Software - Foundation; either version 3, or (at your option) any later version. - - GNU Taler is distributed in the hope that it will be useful, but WITHOUT ANY - WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR - A PARTICULAR PURPOSE. See the GNU General Public License for more details. - - You should have received a copy of the GNU General Public License along with - GNU Taler; see the file COPYING. If not, see - */ - -/*eslint quote-props: ["error", "consistent"]*/ -export const strings: {[s: string]: any} = {}; +export interface StringsType { + // X-Domain or 'messages' + domain: string; + lang: string; + completeness: number, + 'plural_forms': string; + locale_data: { + messages: Record + } +} +export const strings: Record = {}; strings['it'] = { - "domain": "messages", "locale_data": { "messages": { "": { @@ -1062,11 +1055,14 @@ strings['it'] = { "" ] } - } + }, + "domain": "messages", + "plural_forms": "nplurals=2; plural=n != 1;", + "lang": "it", + "completeness": 14 }; strings['fr'] = { - "domain": "messages", "locale_data": { "messages": { "": { @@ -2110,11 +2106,14 @@ strings['fr'] = { "" ] } - } + }, + "domain": "messages", + "plural_forms": "nplurals=2; plural=n > 1;", + "lang": "fr", + "completeness": 0 }; strings['es'] = { - "domain": "messages", "locale_data": { "messages": { "": { @@ -3158,11 +3157,14 @@ strings['es'] = { "Bienvenido a %1$s!" ] } - } + }, + "domain": "messages", + "plural_forms": "nplurals=2; plural=n != 1;", + "lang": "es", + "completeness": 100 }; strings['en'] = { - "domain": "messages", "locale_data": { "messages": { "": { @@ -4206,11 +4208,14 @@ strings['en'] = { "" ] } - } + }, + "domain": "messages", + "plural_forms": "nplurals=2; plural=(n != 1);", + "lang": "en", + "completeness": 100 }; strings['de'] = { - "domain": "messages", "locale_data": { "messages": { "": { @@ -5254,6 +5259,10 @@ strings['de'] = { "" ] } - } + }, + "domain": "messages", + "plural_forms": "nplurals=2; plural=n != 1;", + "lang": "de", + "completeness": 4 }; diff --git a/packages/pogen/src/po2ts.ts b/packages/pogen/src/po2ts.ts index d37bdb902..0e2a0d6ea 100644 --- a/packages/pogen/src/po2ts.ts +++ b/packages/pogen/src/po2ts.ts @@ -19,12 +19,53 @@ */ // @ts-ignore -import * as po2json from "po2json"; +import * as po2jsonLib from "po2json"; import * as fs from "fs"; -import * as path from "path"; import glob = require("glob"); -const DEFAULT_STRING_PRELUDE = "export const strings: any = {};\n\n" +//types defined by the po2json library +type Header = { + domain: string; + lang: string; + 'plural_forms': string; +}; + +type MessagesType = Record> & { "": Header } +interface pojsonType { + // X-Domain or 'messages' + domain: string; + locale_data: { + messages: MessagesType + } +} +// ----------- end pf po2json + +interface StringsType { + // X-Domain or 'messages' + domain: string; + lang: string; + completeness: number, + 'plural_forms': string; + locale_data: { + messages: Record> + } +} + +// This prelude match the types above +const TYPES_FOR_STRING_PRELUDE = ` +export interface StringsType { + domain: string; + lang: string; + completeness: number; + 'plural_forms': string; + locale_data: { + messages: Record; + }; +}; +`; + +const DEFAULT_STRING_PRELUDE = `${TYPES_FOR_STRING_PRELUDE}export const strings: Record = {};\n\n` + export function po2ts(): void { const files = glob.sync("src/i18n/*.po"); @@ -54,16 +95,26 @@ export function po2ts(): void { } const lang = m[1]; - const pojson = po2json.parseFileSync(filename, { + const poAsJson: pojsonType = po2jsonLib.parseFileSync(filename, { format: "jed1.x", fuzzy: true, }); - const s = - "strings['" + - lang + - "'] = " + - JSON.stringify(pojson, null, " ") + - ";\n\n"; + const header = poAsJson.locale_data.messages[""] + const total = calculateTotalTranslations(poAsJson.locale_data.messages) + const completeness = + header.lang === "en" + ? 100 // 'en' is always complete + : Math.floor(total.translations * 100 / total.keys); + + const strings: StringsType = { + locale_data: poAsJson.locale_data, + domain: poAsJson.domain, + plural_forms: header.plural_forms, + lang: header.lang, + completeness, + } + const value = JSON.stringify(strings, undefined, 2) + const s = `strings['${lang}'] = ${value};\n\n` chunks.push(s); } @@ -71,3 +122,25 @@ export function po2ts(): void { fs.writeFileSync("src/i18n/strings.ts", tsContents); } + +function calculateTotalTranslations(msgs: MessagesType): { keys: number, translations: number } { + const kv = Object.entries(msgs) + const [keys, translations] = kv.reduce(([total, withTranslation], translation) => { + if (!translation || translation.length !== 2 || !translation[1]) { + //curent key is empty + return [total, withTranslation] + } + const v = translation[1] + if (!Array.isArray(v)) { + // this is not a translation + return [total, withTranslation] + } + if (!v.length || !v[0].length) { + //translation is missing + return [total + 1, withTranslation] + } + //current key has a translation + return [total + 1, withTranslation + 1] + }, [0, 0]) + return { keys, translations } +} \ No newline at end of file diff --git a/packages/web-util/src/components/Header.tsx b/packages/web-util/src/components/Header.tsx index a0587b2ae..e5662fc70 100644 --- a/packages/web-util/src/components/Header.tsx +++ b/packages/web-util/src/components/Header.tsx @@ -3,7 +3,7 @@ import { LangSelector, useTranslationContext } from "../index.browser.js"; import { ComponentChildren, Fragment, VNode, h } from "preact"; import logo from "../assets/logo-2021.svg"; -export function Header({ title, iconLinkURL, sites, supportedLangs, onLogout, children }: +export function Header({ title, iconLinkURL, sites, onLogout, children }: { title: string, iconLinkURL: string, children?: ComponentChildren, onLogout: (() => void) | undefined, sites: Array>, supportedLangs: string[] }): VNode { const { i18n } = useTranslationContext(); const [open, setOpen] = useState(false) @@ -107,7 +107,7 @@ export function Header({ title, iconLinkURL, sites, supportedLangs, onLogout, ch : undefined}
  • - +
    • {/* CHILDREN */} {children} diff --git a/packages/web-util/src/components/LangSelector.tsx b/packages/web-util/src/components/LangSelector.tsx index a8d910129..7deaa0cf4 100644 --- a/packages/web-util/src/components/LangSelector.tsx +++ b/packages/web-util/src/components/LangSelector.tsx @@ -43,9 +43,9 @@ function getLangName(s: keyof LangsNames | string): string { return String(s); } -export function LangSelector({ supportedLangs }: { supportedLangs: string[] }): VNode { +export function LangSelector({ }: {}): VNode { const [updatingLang, setUpdatingLang] = useState(false); - const { lang, changeLanguage } = useTranslationContext(); + const { lang, changeLanguage, completness, supportedLang } = useTranslationContext(); const [hidden, setHidden] = useState(true); useEffect(() => { @@ -66,8 +66,9 @@ export function LangSelector({ supportedLangs }: { supportedLangs: string[] }):