lightnet 2.16.0 → 2.16.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # lightnet
 
+## 2.16.2
+
+### Patch Changes
+
+- [#215](https://github.com/LightNetDev/LightNet/pull/215) [`6d963a7`](https://github.com/LightNetDev/LightNet/commit/6d963a76df071771bf96a616a4a45103fc068c98) Thanks [@smn-cds](https://github.com/smn-cds)! - Makes translation files imports more static
+
+## 2.16.1
+
+### Patch Changes
+
+- [#213](https://github.com/LightNetDev/LightNet/pull/213) [`d78e4fd`](https://github.com/LightNetDev/LightNet/commit/d78e4fd0c60cef710f57ede45c204ad839ba7f0f) Thanks [@smn-cds](https://github.com/smn-cds)! - Fix loading of built in languages.
+
 ## 2.16.0
 
 ### Minor Changes

package/package.json

@@ -2,7 +2,7 @@
   "name": "lightnet",
   "type": "module",
   "license": "MIT",
-  "version": "2.16.0",
+  "version": "2.16.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/LightNetDev/lightnet",

package/src/i18n/translate.ts

@@ -1,13 +1,10 @@
 import { AstroError } from "astro/errors"
 import i18next, { type TOptions } from "i18next"
 import config from "virtual:lightnet/config"
-import YAML from "yaml"
 
 import { resolveDefaultLocale } from "./resolve-default-locale"
 import { resolveLanguage } from "./resolve-language"
-import type { LightNetTranslationKey } from "./translation-key"
-
-type TranslationsByLocales = Record<string, Record<string, string>>
+import { type LightNetTranslationKey, loadTranslations } from "./translations"
 
 // We add (string & NonNullable<unknown>) to preserve typescript autocompletion for known keys
 export type TranslationKey =
@@ -18,25 +15,20 @@ export type TranslateFn = (key: TranslationKey, options?: TOptions) => string
 
 const languageCodes = [
   ...new Set(
-    config.languages.flatMap((lng) => [
-      lng.code,
-      ...lng.fallbackLanguages,
-      "en",
-    ]),
+    config.languages
+      .filter((lng) => lng.isUILanguage)
+      .flatMap((lng) => [lng.code, ...lng.fallbackLanguages, "en"]),
   ),
 ]
 const defaultLocale = resolveDefaultLocale(config)
 
-const builtInTranslations = await loadTranslations("/i18n/translations")
-const userTranslations = await loadTranslations("/src/translations")
-
 await i18next.init({
   lng: defaultLocale,
   // don't use name spacing
   nsSeparator: false,
   // only use flat keys
   keySeparator: false,
-  resources: prepareI18nextTranslations(),
+  resources: await prepareI18nextTranslations(),
 })
 
 export function useTranslate(bcp47: string | undefined): TranslateFn {
@@ -62,39 +54,11 @@ export function useTranslate(bcp47: string | undefined): TranslateFn {
   }
 }
 
-async function loadTranslations(path: string) {
-  const translations: TranslationsByLocales = {}
-  const imports = Object.entries(
-    import.meta.glob(
-      ["./translations/*.(yml|yaml)", "/src/translations/*.(yml|yaml)"],
-      {
-        query: "?raw",
-        import: "default",
-      },
-    ),
-  )
-  const addTranslation = async (bcp47: string) => {
-    const translationImport = imports.find(([importPath]) =>
-      importPath.includes(`${path}/${bcp47}.`),
-    )?.[1]
-    if (!translationImport) {
-      return
-    }
-    const translationsYml = (await translationImport()) as string
-    translations[bcp47] = YAML.parse(translationsYml)
-  }
-  await Promise.all(languageCodes.map((lng) => addTranslation(lng)))
-  return translations
-}
-
-function prepareI18nextTranslations() {
+async function prepareI18nextTranslations() {
   const result: Record<string, { translation: Record<string, string> }> = {}
   for (const bcp47 of languageCodes) {
     result[bcp47] = {
-      translation: {
-        ...builtInTranslations[bcp47],
-        ...userTranslations[bcp47],
-      },
+      translation: await loadTranslations(bcp47),
     }
   }
   return result

package/src/i18n/translations.ts

@@ -0,0 +1,69 @@
+import YAML from "yaml"
+
+const builtInTranslations = {
+  en: () => import("./translations/en.yml?raw"),
+  de: () => import("./translations/de.yml?raw"),
+} as const
+
+type BuiltInLanguage = keyof typeof builtInTranslations
+
+const userTranslations = Object.fromEntries(
+  Object.entries(
+    import.meta.glob(["/src/translations/*.(yml|yaml)"], {
+      query: "?raw",
+      import: "default",
+    }),
+  ).map(([path, translationImport]) => {
+    const [fileName] = path.split("/").slice(-1)
+    const lang = fileName.replace(/\.ya?ml/, "")
+    return [lang, translationImport]
+  }),
+)
+
+export const loadTranslations = async (bcp47: string) => ({
+  ...(await loadBuiltInTranslations(bcp47)),
+  ...(await loadUserTranslations(bcp47)),
+})
+
+function isBuiltInLanguage(bcp47: string): bcp47 is BuiltInLanguage {
+  return Object.hasOwn(builtInTranslations, bcp47)
+}
+
+export const loadBuiltInTranslations = async (bcp47: string) => {
+  if (!isBuiltInLanguage(bcp47)) {
+    return {}
+  }
+  const yml = (await builtInTranslations[bcp47]()).default
+  return YAML.parse(yml)
+}
+
+export const loadUserTranslations = async (bcp47: string) => {
+  if (!userTranslations[bcp47]) {
+    return {}
+  }
+  const yml = (await userTranslations[bcp47]()) as string
+  return YAML.parse(yml)
+}
+
+export type LightNetTranslationKey =
+  | "ln.404.go-to-the-home-page"
+  | "ln.404.page-not-found"
+  | "ln.category"
+  | "ln.language"
+  | "ln.external-link"
+  | "ln.type_one"
+  | "ln.details.open"
+  | "ln.details.share"
+  | "ln.details.part-of-collection"
+  | "ln.details.download"
+  | "ln.header.open-main-menu"
+  | "ln.header.select-language"
+  | "ln.home.title"
+  | "ln.search.all-categories"
+  | "ln.search.all-languages"
+  | "ln.search.all-types"
+  | "ln.search.more-results"
+  | "ln.search.no-results"
+  | "ln.search.placeholder"
+  | "ln.search.title"
+  | "ln.share.url-copied-to-clipboard"

package/src/i18n/translation-key.ts

@@ -1,22 +0,0 @@
-export type LightNetTranslationKey =
-  | "ln.404.go-to-the-home-page"
-  | "ln.404.page-not-found"
-  | "ln.category"
-  | "ln.language"
-  | "ln.external-link"
-  | "ln.type_one"
-  | "ln.details.open"
-  | "ln.details.share"
-  | "ln.details.part-of-collection"
-  | "ln.details.download"
-  | "ln.header.open-main-menu"
-  | "ln.header.select-language"
-  | "ln.home.title"
-  | "ln.search.all-categories"
-  | "ln.search.all-languages"
-  | "ln.search.all-types"
-  | "ln.search.more-results"
-  | "ln.search.no-results"
-  | "ln.search.placeholder"
-  | "ln.search.title"
-  | "ln.share.url-copied-to-clipboard"