@skyroc/scripts 2.5.0

package/templates/admin-shell/i18n/hooks/use-lang.ts

@@ -0,0 +1,47 @@
+import { useAtom, useAtomValue } from 'jotai';
+import { currentLangOptionAtom, fallbackLangAtom, langAtom, localeOptionsAtom } from '../atoms/lang';
+import { getFallbackLocale, getLocaleOptions, loadLocaleMessages } from '../i18n';
+import type { LangOption, LangType } from '../types';
+
+export interface UseLangReturn {
+  /** Change the current language. */
+  changeLocale: (lang: LangType) => void;
+  /** Current language option. */
+  currentOption: LangOption | undefined;
+
+  /** Fallback language. */
+  fallbackLang: LangType;
+  /** Check whether the supplied language is active. */
+  isCurrentLang: (lang: LangType) => boolean;
+
+  /** Current language. */
+  locale: LangType;
+  /** Language options for switch UI. */
+  localeOptions: LangOption[];
+
+  /** Alias of changeLocale. */
+  setLocale: (lang: LangType) => void;
+}
+
+/** Hook for language management */
+export function useLang(): UseLangReturn {
+  const [locale, setLocale] = useAtom(langAtom);
+  const currentOption = useAtomValue(currentLangOptionAtom);
+  const localeOptions = useAtomValue(localeOptionsAtom);
+  const fallbackLang = useAtomValue(fallbackLangAtom);
+
+  function changeLocale(lang: LangType) {
+    setLocale(lang);
+    loadLocaleMessages(lang);
+  }
+
+  return {
+    locale,
+    currentOption,
+    localeOptions: localeOptions.length > 0 ? localeOptions : getLocaleOptions(),
+    fallbackLang: fallbackLang || getFallbackLocale(),
+    changeLocale,
+    setLocale: changeLocale,
+    isCurrentLang: (lang: LangType) => locale === lang
+  };
+}

package/templates/admin-shell/i18n/i18n.ts

@@ -0,0 +1,116 @@
+import { setAtomValue } from '@skyroc/core-state';
+import i18next from 'i18next';
+import { initReactI18next } from 'react-i18next';
+
+import { fallbackLangAtom, langAtom, localeOptionsAtom } from './atoms/lang';
+import { defaultLangConfig } from './config/default';
+import { localeResources } from './langs';
+import type { LangOption, LangType, LocaleChangeHandler, LocaleSetupOptions, LocaleStorage } from './types';
+
+// oxlint-disable-next-line import/no-named-as-default-member
+export const i18n = i18next.use(initReactI18next);
+
+export const reactI18nextInstance = i18n;
+
+export const $t = i18n.t;
+
+interface RuntimeConfig {
+  fallbackLocale: LangType;
+  localeOptions: LangOption[];
+  onLocaleChange?: LocaleChangeHandler<LangType>;
+  storage?: LocaleStorage<LangType>;
+}
+
+const runtimeConfig: RuntimeConfig = {
+  fallbackLocale: defaultLangConfig.fallbackLang,
+  localeOptions: defaultLangConfig.langOptions
+};
+
+function normalizeLocale(lang: string) {
+  return lang as LangType;
+}
+
+function configureRuntime(options: LocaleSetupOptions<LangType>) {
+  runtimeConfig.fallbackLocale = options.fallbackLocale ?? runtimeConfig.fallbackLocale;
+  runtimeConfig.localeOptions = options.localeOptions ?? runtimeConfig.localeOptions;
+  runtimeConfig.storage = options.storage ?? runtimeConfig.storage;
+  runtimeConfig.onLocaleChange = options.onLocaleChange ?? runtimeConfig.onLocaleChange;
+
+  setAtomValue(fallbackLangAtom, runtimeConfig.fallbackLocale);
+  setAtomValue(localeOptionsAtom, runtimeConfig.localeOptions);
+}
+
+function resolveInitialLocale(options: LocaleSetupOptions<LangType>) {
+  return options.defaultLocale ?? runtimeConfig.storage?.getLocale() ?? defaultLangConfig.defaultLang;
+}
+
+function loadAdminLocaleMessages(lang: LangType) {
+  return localeResources[lang];
+}
+
+export function getLocaleOptions() {
+  return runtimeConfig.localeOptions;
+}
+
+export function getFallbackLocale() {
+  return runtimeConfig.fallbackLocale;
+}
+
+export function getStoredLocale() {
+  return runtimeConfig.storage?.getLocale() ?? null;
+}
+
+export function saveLocale(lang: LangType) {
+  runtimeConfig.storage?.setLocale(lang);
+}
+
+export async function setupI18n(options: LocaleSetupOptions<LangType> = {}) {
+  configureRuntime(options);
+
+  const locale = resolveInitialLocale(options);
+
+  if (!i18n.isInitialized) {
+    await i18n.init({
+      fallbackLng: options.fallbackLocale ?? runtimeConfig.fallbackLocale,
+      interpolation: {
+        escapeValue: false
+      },
+      lng: locale,
+      missingKeyHandler(lng, _namespace, key) {
+        if (options.missingWarn && key.includes('.')) {
+          console.warn(`[i18next] Not found '${key}' key in '${lng}' locale messages.`);
+        }
+      },
+      react: {
+        useSuspense: false
+      },
+      resources: options.resources,
+      saveMissing: options.missingWarn,
+      ...options.i18nextOptions
+    });
+  }
+
+  await loadLocaleMessages(locale);
+}
+
+export async function loadLocaleMessages(lang: LangType) {
+  const locale = normalizeLocale(lang);
+  const messages = await loadAdminLocaleMessages(locale);
+
+  i18n.addResourceBundle(locale, 'translation', messages, true, true);
+
+  saveLocale(locale);
+
+  await i18n.changeLanguage(locale);
+  setAtomValue(langAtom, locale);
+
+  await runtimeConfig.onLocaleChange?.(locale);
+}
+
+export async function setLng(lang: LangType) {
+  await loadLocaleMessages(lang);
+}
+
+export function getCurrentLang() {
+  return normalizeLocale(i18n.language || defaultLangConfig.defaultLang);
+}

package/templates/admin-shell/i18n/index.ts

@@ -0,0 +1,23 @@
+// oxlint-disable-next-line import/no-unassigned-import
+import './types/i18n';
+
+// Atoms
+export { currentLangOptionAtom, fallbackLangAtom, langAtom, localeOptionsAtom } from './atoms/lang';
+// Config
+export { defaultLangConfig } from './config/default';
+export { default as LangEffect } from './features/lang/LangEffect';
+
+export { default as LangSwitch } from './features/lang/LangSwitch';
+
+// Hooks
+export { useLang } from './hooks/use-lang';
+export type { UseLangReturn } from './hooks/use-lang';
+
+// Runtime
+export { $t, getCurrentLang, i18n, loadLocaleMessages, reactI18nextInstance, setLng, setupI18n } from './i18n';
+
+// Types
+export type { LangConfig, LangOption, LangType, LocaleChangeHandler, LocaleSetupOptions, LocaleStorage } from './types';
+
+// Utils
+export { getLangFromStorage, getLangLabel, saveLangToStorage } from './utils/helpers';

package/templates/admin-shell/i18n/langs/en-us/common.json

@@ -0,0 +1,49 @@
+{
+  "action": "Action",
+  "add": "Add",
+  "addSuccess": "Add Success",
+  "backToHome": "Back to home",
+  "batchDelete": "Batch Delete",
+  "cancel": "Cancel",
+  "check": "Check",
+  "close": "Close",
+  "columnSetting": "Column Setting",
+  "config": "Config",
+  "confirm": "Confirm",
+  "confirmDelete": "Are you sure you want to delete?",
+  "createTime": "Create Time",
+  "delete": "Delete",
+  "deleteSuccess": "Delete Success",
+  "detail": "Detail",
+  "edit": "Edit",
+  "error": "Error",
+  "errorHint": "Please try again later",
+  "expandColumn": "Expand Column",
+  "index": "Index",
+  "keywordSearch": "Please enter keyword",
+  "logout": "Logout",
+  "logoutConfirm": "Are you sure you want to log out?",
+  "lookForward": "Coming soon",
+  "modify": "Modify",
+  "modifySuccess": "Modify Success",
+  "noData": "No Data",
+  "operate": "Operate",
+  "pleaseCheckValue": "Please check whether the value is valid",
+  "refresh": "Refresh",
+  "reset": "Reset",
+  "search": "Search",
+  "selectAll": "Select All",
+  "switch": "Switch",
+  "tip": "Tip",
+  "trigger": "Trigger",
+  "tryAlign": "Try Align",
+  "update": "Update",
+  "updateTime": "Update Time",
+  "updateSuccess": "Update Success",
+  "userCenter": "User Center",
+  "warning": "Warning",
+  "yesOrNo": {
+    "no": "No",
+    "yes": "Yes"
+  }
+}

package/templates/admin-shell/i18n/langs/en-us/datatable.json

@@ -0,0 +1,8 @@
+{
+  "fixed": {
+    "left": "Fix to left",
+    "right": "Fix to right",
+    "unFixed": "Unfix"
+  },
+  "itemCount": "Total {{total}} items"
+}

package/templates/admin-shell/i18n/langs/en-us/dropdown.json

@@ -0,0 +1,9 @@
+{
+  "closeAll": "Close All",
+  "closeCurrent": "Close Current",
+  "closeLeft": "Close Left",
+  "closeOther": "Close Other",
+  "closeRight": "Close Right",
+  "pin": "Pin Tab",
+  "unpin": "Unpin Tab"
+}

package/templates/admin-shell/i18n/langs/en-us/form.json

@@ -0,0 +1,27 @@
+{
+  "code": {
+    "invalid": "Verification code format is incorrect",
+    "required": "Please enter verification code"
+  },
+  "confirmPwd": {
+    "invalid": "The two passwords are inconsistent",
+    "required": "Please enter password again"
+  },
+  "email": {
+    "invalid": "Email format is incorrect",
+    "required": "Please enter email"
+  },
+  "phone": {
+    "invalid": "Phone number format is incorrect",
+    "required": "Please enter phone number"
+  },
+  "pwd": {
+    "invalid": "6-18 characters, including letters, numbers, and underscores",
+    "required": "Please enter password"
+  },
+  "required": "Cannot be empty",
+  "userName": {
+    "invalid": "User name format is incorrect",
+    "required": "Please enter user name"
+  }
+}

package/templates/admin-shell/i18n/langs/en-us/icon.json

@@ -0,0 +1,13 @@
+{
+  "collapse": "Collapse Menu",
+  "expand": "Expand Menu",
+  "fullscreen": "Fullscreen",
+  "fullscreenExit": "Exit Fullscreen",
+  "lang": "Switch Language",
+  "notification": "Notification",
+  "pin": "Pin",
+  "reload": "Reload Page",
+  "themeConfig": "Theme Configuration",
+  "themeSchema": "Theme Schema",
+  "unpin": "Unpin"
+}

package/templates/admin-shell/i18n/langs/en-us/notification.json

@@ -0,0 +1,20 @@
+{
+  "all": "All",
+  "browser": "Browser Notification",
+  "clearAll": "Clear All",
+  "clearConfirm": "Are you sure to clear all notifications?",
+  "doNotDisturb": "Do Not Disturb",
+  "empty": "No notifications",
+  "markAllRead": "Mark All Read",
+  "message": "Message",
+  "priority": {
+    "high": "High",
+    "urgent": "Urgent"
+  },
+  "reminder": "Notifications",
+  "sound": "Notification Sound",
+  "system": "System",
+  "title": "Notification Center",
+  "unread": "Unread",
+  "viewAll": "View All Notifications"
+}