Merge pull request #870 from zyf722/i18next-integration-draft

fix(i18n): optimize i18n types performance

Author: hatemhosny

.github/workflows/CI-type-checking.yml

@@ -68,8 +68,7 @@
     "i18n-update-push": "node ./scripts/i18n-upload.mjs",
     "i18n-update-pull": "node ./scripts/i18n-import.mjs",
     "i18n-exclude": "node ./scripts/i18n-exclude.js",
-    "i18n-lokalise-json": "node ./scripts/i18n-lokalise-json.mjs",
-    "check-types": "tsc -p tsconfig.full.json --noEmit"
+    "i18n-lokalise-json": "node ./scripts/i18n-lokalise-json.mjs"
   },
   "dependencies": {
     "@eslint/compat": "1.2.6",

package.json

@@ -1,11 +1,11 @@
-import type { RequireAtLeastOne, UnAsConst } from '../models';
+import type { RequireAtLeastOne } from '../models';
 import type LangInfoTranslation from './en/language-info';
 import type Translation from './en/translation';
 
 /**
  * Add new translatable attributes here.
  *
- * To add new custom data attributes for HTML intellisense, see `script/vscode-intellisense.js`.
+ * To add new custom data attributes for HTML intellisense, see `scripts/vscode-intellisense.js`.
  */
 type I18nAttributes = RequireAtLeastOne<{
   textContent?: string;
@@ -21,17 +21,24 @@ type I18nAttributes = RequireAtLeastOne<{
  * Only use in `en` language with `as const satisfies`.
  */
 export interface I18nTranslationTemplate {
-  [key: string]: ValidI18nTypes | string;
+  [key: string]: I18nAttributes | string | I18nTranslationTemplate;
 }
 
-type ValidI18nTypes = I18nAttributes | I18nTranslationTemplate;
+/**
+ * Maps a nested object structure to a structure where all leaf nodes are strings.
+ *
+ * Use to keep the same structure as the `en` i18n object for other languages.
+ */
+export type I18nStructure<T> = {
+  readonly [K in keyof T]: T[K] extends Record<string, unknown> ? I18nStructure<T[K]> : string;
+};
 
 /**
  * Type for all i18n object of namespace `translation` other than `en`.
  */
-export type I18nTranslation = UnAsConst<typeof Translation, ValidI18nTypes, string>;
+export type I18nTranslation = I18nStructure<typeof Translation>;
 
 /**
  * Type for all i18n object of namespace `language-info` other than `en`.
  */
-export type I18nLangInfoTranslation = UnAsConst<typeof LangInfoTranslation, ValidI18nTypes, string>;
+export type I18nLangInfoTranslation = I18nStructure<typeof LangInfoTranslation>;

src/livecodes/i18n/locales/models.ts

@@ -3,22 +3,13 @@ import type { CustomTypeOptions } from 'i18next';
 /**
  * Report error when no property is provided.
  */
-export type RequireAtLeastOne<T> = {
-  [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
-}[keyof T];
-
-/**
- * Widen `T` to `U` while keeping the structure, with non-object properties widened to `Default`.
- *
- * @param T The object to be converted.
- * @param U The type to be converted to.
- * @param Default The default type.
- */
-export type UnAsConst<T, U, Default> = RequireAtLeastOne<{
-  readonly [K in keyof T]: T[K] extends U
-    ? RequireAtLeastOne<UnAsConst<T[K], U, Default>>
-    : Default;
-}>;
+export type RequireAtLeastOne<T> = T extends any
+  ? keyof T extends never
+    ? never
+    : {
+        [K in keyof T]-?: T & Required<Pick<T, K>>;
+      }[keyof T]
+  : never;
 
 /**
  * Increment a number type by 1.

src/livecodes/i18n/models.ts

@@ -49,5 +49,5 @@
   },
   "compileOnSave": true,
   "include": ["src/**/*.ts"],
-  "exclude": ["**/node_modules/**", "src/livecodes/i18n/locales/**"]
+  "exclude": ["**/node_modules/**"]
 }