refactor: move locales folder (#3374)

* chore: move locales out

* fix: correct import

* move generate local script

Author: hyoban

apps/desktop/configs/vite.render.config.ts

@@ -35,7 +35,7 @@ export const viteRenderBaseConfig = {
     alias: {
       "~": resolve("src/renderer/src"),
       "@pkg": resolve("package.json"),
-      "@locales": resolve("locales"),
+      "@locales": resolve("../../locales"),
       "@follow/electron-main": resolve("src/main/src"),
     },
   },

apps/desktop/electron.vite.config.ts

@@ -19,7 +19,7 @@ export default defineConfig({
       alias: {
         "@shared": resolve("packages/shared/src"),
         "@pkg": resolve("./package.json"),
-        "@locales": resolve("./locales"),
+        "@locales": resolve("../../locales"),
         "~": resolve("./src/main/src"),
       },
     },
@@ -38,7 +38,7 @@ export default defineConfig({
     resolve: {
       alias: {
         "@pkg": resolve("./package.json"),
-        "@locales": resolve("./locales"),
+        "@locales": resolve("../../locales"),
       },
     },
   },

apps/desktop/package.json

@@ -28,7 +28,6 @@
     "dev:electron": "electron-vite dev",
     "dev:server": "pnpm run --filter=ssr dev",
     "dev:web": "cross-env WEB_BUILD=1 vite",
-    "generator:i18n-template": "tsx scripts/generate-i18n-locale.ts",
     "publish": "electron-vite build && electron-forge publish",
     "start": "electron-vite preview",
     "update:main-hash": "tsx plugins/vite/generate-main-hash.ts"

apps/desktop/plugins/vite/locales.ts

@@ -12,7 +12,7 @@ export function localesPlugin(): Plugin {
     generateBundle(_options, bundle) {
       const __dirname = dirname(fileURLToPath(import.meta.url))
 
-      const localesDir = path.resolve(__dirname, "../../locales")
+      const localesDir = path.resolve(__dirname, "../../../../locales")
 
       const namespaces = fs.readdirSync(localesDir).filter((dir) => dir !== ".DS_Store")
       const languageResources = {} as any

apps/desktop/plugins/vite/utils/i18n-completeness.ts

@@ -58,5 +58,5 @@ function calculateCompleteness(localesDir: string): LanguageCompletion {
 }
 const __dirname = dirname(fileURLToPath(import.meta.url))
 
-const i18n = calculateCompleteness(path.resolve(__dirname, "../../../locales"))
+const i18n = calculateCompleteness(path.resolve(__dirname, "../../../../../locales"))
 export default i18n

apps/desktop/src/main/tsconfig.json

@@ -13,7 +13,7 @@
     "baseUrl": ".",
     "paths": {
       "@pkg": ["../../package.json"],
-      "@locales/*": ["../../locales/*"],
+      "@locales/*": ["../../../../locales/*"],
       "~/*": ["./src/*"]
     }
   }

apps/desktop/src/renderer/src/@types/default-resource.ts

@@ -1,50 +1,50 @@
 // This file is auto-generated by scripts/generate-i18n-locale.ts
 // DONT EDIT THIS FILE MANUALLY
-import en from "../../../../locales/app/en.json"
-import common_ardz from "../../../../locales/common/ar-DZ.json"
-import common_ariq from "../../../../locales/common/ar-IQ.json"
-import common_arkw from "../../../../locales/common/ar-KW.json"
-import common_arma from "../../../../locales/common/ar-MA.json"
-import common_arsa from "../../../../locales/common/ar-SA.json"
-import common_artn from "../../../../locales/common/ar-TN.json"
-import common_de from "../../../../locales/common/de.json"
-import common_en from "../../../../locales/common/en.json"
-import common_es from "../../../../locales/common/es.json"
-import common_fi from "../../../../locales/common/fi.json"
-import common_fr from "../../../../locales/common/fr.json"
-import common_it from "../../../../locales/common/it.json"
-import common_ja from "../../../../locales/common/ja.json"
-import common_ko from "../../../../locales/common/ko.json"
-import common_pt from "../../../../locales/common/pt.json"
-import common_ru from "../../../../locales/common/ru.json"
-import common_tr from "../../../../locales/common/tr.json"
-import common_zhCN from "../../../../locales/common/zh-CN.json"
-import common_zhHK from "../../../../locales/common/zh-HK.json"
-import common_zhTW from "../../../../locales/common/zh-TW.json"
-import errors_en from "../../../../locales/errors/en.json"
-import external_en from "../../../../locales/external/en.json"
-import lang_ardz from "../../../../locales/lang/ar-DZ.json"
-import lang_ariq from "../../../../locales/lang/ar-IQ.json"
-import lang_arkw from "../../../../locales/lang/ar-KW.json"
-import lang_arma from "../../../../locales/lang/ar-MA.json"
-import lang_arsa from "../../../../locales/lang/ar-SA.json"
-import lang_artn from "../../../../locales/lang/ar-TN.json"
-import lang_de from "../../../../locales/lang/de.json"
-import lang_en from "../../../../locales/lang/en.json"
-import lang_es from "../../../../locales/lang/es.json"
-import lang_fi from "../../../../locales/lang/fi.json"
-import lang_fr from "../../../../locales/lang/fr.json"
-import lang_it from "../../../../locales/lang/it.json"
-import lang_ja from "../../../../locales/lang/ja.json"
-import lang_ko from "../../../../locales/lang/ko.json"
-import lang_pt from "../../../../locales/lang/pt.json"
-import lang_ru from "../../../../locales/lang/ru.json"
-import lang_tr from "../../../../locales/lang/tr.json"
-import lang_zhCN from "../../../../locales/lang/zh-CN.json"
-import lang_zhHK from "../../../../locales/lang/zh-HK.json"
-import lang_zhTW from "../../../../locales/lang/zh-TW.json"
-import settings_en from "../../../../locales/settings/en.json"
-import shortcuts_en from "../../../../locales/shortcuts/en.json"
+import en from "@locales/app/en.json"
+import common_ardz from "@locales/common/ar-DZ.json"
+import common_ariq from "@locales/common/ar-IQ.json"
+import common_arkw from "@locales/common/ar-KW.json"
+import common_arma from "@locales/common/ar-MA.json"
+import common_arsa from "@locales/common/ar-SA.json"
+import common_artn from "@locales/common/ar-TN.json"
+import common_de from "@locales/common/de.json"
+import common_en from "@locales/common/en.json"
+import common_es from "@locales/common/es.json"
+import common_fi from "@locales/common/fi.json"
+import common_fr from "@locales/common/fr.json"
+import common_it from "@locales/common/it.json"
+import common_ja from "@locales/common/ja.json"
+import common_ko from "@locales/common/ko.json"
+import common_pt from "@locales/common/pt.json"
+import common_ru from "@locales/common/ru.json"
+import common_tr from "@locales/common/tr.json"
+import common_zhCN from "@locales/common/zh-CN.json"
+import common_zhHK from "@locales/common/zh-HK.json"
+import common_zhTW from "@locales/common/zh-TW.json"
+import errors_en from "@locales/errors/en.json"
+import external_en from "@locales/external/en.json"
+import lang_ardz from "@locales/lang/ar-DZ.json"
+import lang_ariq from "@locales/lang/ar-IQ.json"
+import lang_arkw from "@locales/lang/ar-KW.json"
+import lang_arma from "@locales/lang/ar-MA.json"
+import lang_arsa from "@locales/lang/ar-SA.json"
+import lang_artn from "@locales/lang/ar-TN.json"
+import lang_de from "@locales/lang/de.json"
+import lang_en from "@locales/lang/en.json"
+import lang_es from "@locales/lang/es.json"
+import lang_fi from "@locales/lang/fi.json"
+import lang_fr from "@locales/lang/fr.json"
+import lang_it from "@locales/lang/it.json"
+import lang_ja from "@locales/lang/ja.json"
+import lang_ko from "@locales/lang/ko.json"
+import lang_pt from "@locales/lang/pt.json"
+import lang_ru from "@locales/lang/ru.json"
+import lang_tr from "@locales/lang/tr.json"
+import lang_zhCN from "@locales/lang/zh-CN.json"
+import lang_zhHK from "@locales/lang/zh-HK.json"
+import lang_zhTW from "@locales/lang/zh-TW.json"
+import settings_en from "@locales/settings/en.json"
+import shortcuts_en from "@locales/shortcuts/en.json"
 /**
  * This file is the language resource that is loaded in full when the app is initialized.
  * When switching languages, the app will automatically download the required language resources,

apps/desktop/src/renderer/src/lib/load-language.ts

@@ -52,7 +52,7 @@ export const loadLanguageAndApply = async (lang: string) => {
 
     const res = await Promise.allSettled(
       namespaces.map(async (ns) => {
-        const loader = nsGlobbyMap[`../../locales/${ns}/${lang}.json`]
+        const loader = nsGlobbyMap[`../../../../locales/${ns}/${lang}.json`]
 
         if (!loader) return
         const nsResources = await loader().then((m: any) => m.default)

apps/desktop/src/renderer/tsconfig.json

@@ -22,7 +22,7 @@
     "paths": {
       "~/*": ["src/*"],
       "@pkg": ["../../package.json"],
-      "@locales/*": ["../../locales/*"]
+      "@locales/*": ["../../../../locales/*"]
     }
   },
   "references": [{ "path": "../main" }]

apps/ssr/client/@types/default-resource.ts

@@ -1,47 +1,47 @@
 // This file is auto-generated by scripts/generate-i18n-locale.ts
 // DONT EDIT THIS FILE MANUALLY
-import common_ardz from "../../../desktop/locales/common/ar-DZ.json"
-import common_ariq from "../../../desktop/locales/common/ar-IQ.json"
-import common_arkw from "../../../desktop/locales/common/ar-KW.json"
-import common_arma from "../../../desktop/locales/common/ar-MA.json"
-import common_arsa from "../../../desktop/locales/common/ar-SA.json"
-import common_artn from "../../../desktop/locales/common/ar-TN.json"
-import common_de from "../../../desktop/locales/common/de.json"
-import common_en from "../../../desktop/locales/common/en.json"
-import common_es from "../../../desktop/locales/common/es.json"
-import common_fi from "../../../desktop/locales/common/fi.json"
-import common_fr from "../../../desktop/locales/common/fr.json"
-import common_it from "../../../desktop/locales/common/it.json"
-import common_ja from "../../../desktop/locales/common/ja.json"
-import common_ko from "../../../desktop/locales/common/ko.json"
-import common_pt from "../../../desktop/locales/common/pt.json"
-import common_ru from "../../../desktop/locales/common/ru.json"
-import common_tr from "../../../desktop/locales/common/tr.json"
-import common_zhCN from "../../../desktop/locales/common/zh-CN.json"
-import common_zhHK from "../../../desktop/locales/common/zh-HK.json"
-import common_zhTW from "../../../desktop/locales/common/zh-TW.json"
-import errors_en from "../../../desktop/locales/errors/en.json"
-import external_en from "../../../desktop/locales/external/en.json"
-import lang_ardz from "../../../desktop/locales/lang/ar-DZ.json"
-import lang_ariq from "../../../desktop/locales/lang/ar-IQ.json"
-import lang_arkw from "../../../desktop/locales/lang/ar-KW.json"
-import lang_arma from "../../../desktop/locales/lang/ar-MA.json"
-import lang_arsa from "../../../desktop/locales/lang/ar-SA.json"
-import lang_artn from "../../../desktop/locales/lang/ar-TN.json"
-import lang_de from "../../../desktop/locales/lang/de.json"
-import lang_en from "../../../desktop/locales/lang/en.json"
-import lang_es from "../../../desktop/locales/lang/es.json"
-import lang_fi from "../../../desktop/locales/lang/fi.json"
-import lang_fr from "../../../desktop/locales/lang/fr.json"
-import lang_it from "../../../desktop/locales/lang/it.json"
-import lang_ja from "../../../desktop/locales/lang/ja.json"
-import lang_ko from "../../../desktop/locales/lang/ko.json"
-import lang_pt from "../../../desktop/locales/lang/pt.json"
-import lang_ru from "../../../desktop/locales/lang/ru.json"
-import lang_tr from "../../../desktop/locales/lang/tr.json"
-import lang_zhCN from "../../../desktop/locales/lang/zh-CN.json"
-import lang_zhHK from "../../../desktop/locales/lang/zh-HK.json"
-import lang_zhTW from "../../../desktop/locales/lang/zh-TW.json"
+import common_ardz from "@locales/common/ar-DZ.json"
+import common_ariq from "@locales/common/ar-IQ.json"
+import common_arkw from "@locales/common/ar-KW.json"
+import common_arma from "@locales/common/ar-MA.json"
+import common_arsa from "@locales/common/ar-SA.json"
+import common_artn from "@locales/common/ar-TN.json"
+import common_de from "@locales/common/de.json"
+import common_en from "@locales/common/en.json"
+import common_es from "@locales/common/es.json"
+import common_fi from "@locales/common/fi.json"
+import common_fr from "@locales/common/fr.json"
+import common_it from "@locales/common/it.json"
+import common_ja from "@locales/common/ja.json"
+import common_ko from "@locales/common/ko.json"
+import common_pt from "@locales/common/pt.json"
+import common_ru from "@locales/common/ru.json"
+import common_tr from "@locales/common/tr.json"
+import common_zhCN from "@locales/common/zh-CN.json"
+import common_zhHK from "@locales/common/zh-HK.json"
+import common_zhTW from "@locales/common/zh-TW.json"
+import errors_en from "@locales/errors/en.json"
+import external_en from "@locales/external/en.json"
+import lang_ardz from "@locales/lang/ar-DZ.json"
+import lang_ariq from "@locales/lang/ar-IQ.json"
+import lang_arkw from "@locales/lang/ar-KW.json"
+import lang_arma from "@locales/lang/ar-MA.json"
+import lang_arsa from "@locales/lang/ar-SA.json"
+import lang_artn from "@locales/lang/ar-TN.json"
+import lang_de from "@locales/lang/de.json"
+import lang_en from "@locales/lang/en.json"
+import lang_es from "@locales/lang/es.json"
+import lang_fi from "@locales/lang/fi.json"
+import lang_fr from "@locales/lang/fr.json"
+import lang_it from "@locales/lang/it.json"
+import lang_ja from "@locales/lang/ja.json"
+import lang_ko from "@locales/lang/ko.json"
+import lang_pt from "@locales/lang/pt.json"
+import lang_ru from "@locales/lang/ru.json"
+import lang_tr from "@locales/lang/tr.json"
+import lang_zhCN from "@locales/lang/zh-CN.json"
+import lang_zhHK from "@locales/lang/zh-HK.json"
+import lang_zhTW from "@locales/lang/zh-TW.json"
 /**
  * This file is the language resource that is loaded in full when the app is initialized.
  * When switching languages, the app will automatically download the required language resources,

apps/ssr/tsconfig.json

@@ -23,7 +23,8 @@
     ],
     "paths": {
       "~/*": ["./src/*"],
-      "@client/*": ["./client/*"]
+      "@client/*": ["./client/*"],
+      "@locales/*": ["../../locales/*"]
     }
   },
   "include": [

apps/ssr/vite.config.mts

@@ -12,6 +12,7 @@ export default () => {
       alias: {
         "@pkg": resolve(__dirname, "../../package.json"),
         "@client": resolve(__dirname, "./client"),
+        "@locales": resolve(__dirname, "../../locales"),
       },
     },
     define: {

eslint.config.mjs

@@ -89,7 +89,7 @@ export default defineConfig(
   },
   // @ts-expect-error
   {
-    files: ["apps/desktop/locales/**/*.json"],
+    files: ["locales/**/*.json"],
     plugins: {
       "recursive-sort": recursiveSort,
       "check-i18n-json": checkI18nJson,

apps/desktop/locales/app/ar-DZ.json renamed to locales/app/ar-DZ.json

@@ -13,10 +13,11 @@
   },
   "scripts": {
     "build:web": "turbo run Folo#build:web",
-    "dedupe:locales": "eslint --fix apps/desktop/locales/**/*.json",
+    "dedupe:locales": "eslint --fix locales/**/*.json",
     "depcheck": "npx depcheck --quiet",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
+    "generator:i18n-template": "tsx scripts/generate-i18n-locale.ts",
     "hotfix": "vv -c bump.hotfix.config.js",
     "icons:sync": "tsx scripts/svg-to-rn.ts && prettier --write apps/mobile/src/icons/**/*.tsx && eslint --fix apps/mobile/src/icons/**/*.tsx",
     "icons:update": "tsx scripts/update-icon.ts",

apps/desktop/locales/app/ar-IQ.json renamed to locales/app/ar-IQ.json

@@ -9,5 +9,5 @@
       "@pkg": ["../../package.json"]
     }
   },
-  "include": ["src/**/*", "../../locales/**/*.json"]
+  "include": ["src/**/*", "../../../../locales/**/*.json"]
 }

apps/desktop/locales/app/ar-KW.json renamed to locales/app/ar-KW.json

@@ -11,7 +11,7 @@
     "paths": {
       "@shared/*": ["./src/*"],
       "@pkg": ["../../package.json"],
-      "@locales/*": ["../../locales/*"],
+      "@locales/*": ["../../../../locales/*"],
       "~/*": ["./src/*"]
     }
   }

apps/desktop/locales/app/ar-MA.json renamed to locales/app/ar-MA.json

@@ -179,7 +179,7 @@ async function selectLocale(): Promise<string> {
 
 const __dirname = dirname(fileURLToPath(import.meta.url))
 const LOCALE_DIR = path.resolve(__dirname, "../locales")
-const CONFIG_DIR = path.resolve(__dirname, "../src/renderer/src/@types")
+const CONFIG_DIR = path.resolve(__dirname, "../apps/desktop/src/renderer/src/@types")
 
 async function main() {
   const selectedLocale = await selectLocale()
@@ -253,11 +253,11 @@ function updateDefaultResourceFile(sourceFile: ts.SourceFile, locale: string): s
           const newImports = [
             createImportDeclaration(
               `lang_${locale.replace("-", "")}`,
-              `../../../../locales/lang/${locale}.json`,
+              `@locales/lang/${locale}.json`,
             ),
             createImportDeclaration(
               `common_${locale.replace("-", "")}`,
-              `../../../../locales/common/${locale}.json`,
+              `@locales/common/${locale}.json`,
             ),
           ]
           importsAdded = true