Support optional locales for development

Author: sheepzh

global.d.ts

@@ -190,15 +190,20 @@ declare namespace timer {
      * @since 1.4.0
      */
     type SourceLocale = 'en'
-
     /**
-     * @since 0.8.0
+     * The locale must be translated with code
+     * 
+     * @since 1.5.3
      */
-    type Locale = SourceLocale
-        | 'zh_CN'
+    type RequiredLocale = SourceLocale | 'zh_CN'
+    type OptionalLocale =
         | 'ja'
         // @since 0.9.0
         | 'zh_TW'
+    /**
+     * @since 0.8.0
+     */
+    type Locale = RequiredLocale | OptionalLocale
 
     /**
      * Translating locales
@@ -575,4 +580,13 @@ declare type ChromeAlarm = chrome.alarms.Alarm
 // chrome.runtime
 declare type ChromeOnInstalledReason = chrome.runtime.OnInstalledReason
 declare type ChromeMessageSender = chrome.runtime.MessageSender
-declare type ChromeMessageHandler<T = any, R = any> = (req: timer.mq.Request<T>, sender: ChromeMessageSender) => Promise<timer.mq.Response<R>>
+declare type ChromeMessageHandler<T = any, R = any> = (req: timer.mq.Request<T>, sender: ChromeMessageSender) => Promise<timer.mq.Response<R>>
+
+// Embedded partial
+declare type EmbeddedPartial<T> = {
+    [P in keyof T]?: T[P] extends Array<infer U>
+    ? Array<EmbeddedPartial<U>>
+    : T[P] extends ReadonlyArray<infer U>
+    ? ReadonlyArray<EmbeddedPartial<U>>
+    : EmbeddedPartial<T[P]>;
+}

script/crowdin/common.ts

@@ -71,7 +71,6 @@ export async function readAllMessages(dir: Dir): Promise<Record<string, Messages
     return result
 }
 
-
 /**
  * Merge crowdin message into locale codes
  */

src/app/components/option/common.ts

@@ -18,7 +18,11 @@ import { OptionMessage } from "@i18n/message/app/option"
  * @param label label
  * @param defaultValue default value
  */
-export function renderOptionItem(input: VNode | { [key: string]: VNode }, label: (msg: OptionMessage) => string, defaultValue?: string | number) {
+export function renderOptionItem(
+    input: VNode | { [key: string]: VNode },
+    label: (msg: OptionMessage | EmbeddedPartial<OptionMessage>) => string,
+    defaultValue?: string | number
+) {
     const param = isVNode(input) ? { input } : input
     const labelArcher = h('a', { class: 'option-label' }, tN(msg => label(msg.option), param))
     const content = [labelArcher]

src/i18n/i18n.d.ts

@@ -1,4 +1,9 @@
+type RequiredMessages<M> = {
+    [locale in timer.RequiredLocale]: M
+}
 
-type Messages<M> = {
-    [locale in timer.Locale]: M
+type OptionalMessages<M> = {
+    [locale in timer.OptionalLocale]?: EmbeddedPartial<M>
 }
+
+type Messages<M> = RequiredMessages<M> & OptionalMessages<M>

src/i18n/index.ts

@@ -109,12 +109,24 @@ export async function initLocale() {
 
 optionService.addOptionChangeListener(handleLocaleOption)
 
+function tryGetOriginalI18nVal<MessageType>(
+    messages: Messages<MessageType>,
+    keyPath: I18nKey<MessageType>,
+    specLocale?: timer.Locale
+) {
+    try {
+        return keyPath(messages[specLocale || locale])
+    } catch (ignore) {
+        return undefined
+    }
+}
+
 export function getI18nVal<MessageType>(
     messages: Messages<MessageType>,
     keyPath: I18nKey<MessageType>,
     specLocale?: timer.Locale
 ): string {
-    const result = keyPath(messages[specLocale || locale])
+    const result = tryGetOriginalI18nVal(messages, keyPath, specLocale)
         || keyPath(messages[FEEDBACK_LOCALE])
         || ''
     return typeof result === 'string' ? result : JSON.stringify(result)
@@ -141,4 +153,4 @@ export function t<MessageType>(messages: Messages<MessageType>, props: Translate
     return param ? fillWithParam(result, param) : result
 }
 
-export type I18nKey<MessageType> = (messages: MessageType) => any
+export type I18nKey<MessageType> = (messages: MessageType | EmbeddedPartial<MessageType>) => any

src/i18n/message/app/help-us.ts

@@ -25,7 +25,7 @@ const _default: Messages<HelpUsMessage> = {
             l1: '由于作者的语言能力，该扩展原生只支持简体中文和英语，其他语言要么缺失，要么就严重依赖机器翻译。',
             l2: '为了能够提供更好的用户体验，我将其他语言的翻译任务托管在了 Crowdin 上。Crowdin 是一个对开源软件免费的翻译管理系统。',
             l3: '如果您觉得这个扩展对您有用，并且您愿意完善它的文本翻译的话，可以点击下方按钮前往 Crowdin 上的项目主页。',
-            l4: '当某种语言的翻译进度达到 80% 之后，我将会考虑在扩展中支持它。',
+            l4: '当某种语言的翻译进度达到 50% 之后，我将会考虑在扩展中支持它。',
         },
         button: '前往 Crowdin',
         loading: '正在查询翻译进度...',
@@ -41,39 +41,7 @@ const _default: Messages<HelpUsMessage> = {
                 Crowdin is a translation management system free for open source software.',
             l3: 'If you find this extension useful to you and you are willing to improve its translation, \
                 you can click the button below to go to the project home page on Crowdin.',
-            l4: 'When the translation progress of a language reaches 80%, I will consider supporting it in this extension.',
-        },
-        button: 'Go Crowdin',
-        loading: 'Checking translation progress...',
-    },
-    ja: {
-        title: 'Feel free to help improve the extension\'s localization translations!',
-        alert: {
-            l1: 'Due to the author\'s language ability, \
-                the extension only supports Simplified Chinese and English natively, \
-                and other languages are either missing or rely heavily on machine translation.',
-            l2: 'In order to provide a better user experience, \
-                I host the translation tasks for other languages on Crowdin. \
-                Crowdin is a translation management system free for open source software.',
-            l3: 'If you find this extension useful to you and you are willing to improve its translation, \
-                you can click the button below to go to the project home page on Crowdin.',
-            l4: 'When the translation progress of a language reaches 80%, I will consider supporting it in this extension.',
-        },
-        button: 'Go Crowdin',
-        loading: 'Checking translation progress...',
-    },
-    zh_TW: {
-        title: 'Feel free to help improve the extension\'s localization translations!',
-        alert: {
-            l1: 'Due to the author\'s language ability, \
-                the extension only supports Simplified Chinese and English natively, \
-                and other languages are either missing or rely heavily on machine translation.',
-            l2: 'In order to provide a better user experience, \
-                I host the translation tasks for other languages on Crowdin. \
-                Crowdin is a translation management system free for open source software.',
-            l3: 'If you find this extension useful to you and you are willing to improve its translation, \
-                you can click the button below to go to the project home page on Crowdin.',
-            l4: 'When the translation progress of a language reaches 80%, I will consider supporting it in this extension.',
+            l4: 'When the translation progress of a language reaches 50%, I will consider supporting it in this extension.',
         },
         button: 'Go Crowdin',
         loading: 'Checking translation progress...',