refactor: split localizations in namespaces (#116)

* refactor: split localizations in namespaces * fix: tests * chore: update crowdin configs * fix: test
imnaiyar · Nov 5, 2024 · 146148a · 146148a
1 parent 37566d4
commit 146148a
Show file tree

Hide file tree

Showing 95 changed files with 2,310 additions and 19,599 deletions.
diff --git a/.github/workflows/crowdin-action.yml b/.github/workflows/crowdin-action.yml
@@ -21,7 +21,7 @@ jobs:
         uses: crowdin/github-action@v2
         with:
           upload_sources: true
-          upload_translations: false
+          upload_translations: true
           download_translations: true
           localization_branch_name: crowdin_translate
           create_pull_request: true

diff --git a/__tests__/getTranslator.test.ts b/__tests__/getTranslator.test.ts
@@ -3,29 +3,29 @@ import { getTranslator } from "../src/bot/i18n.js";
 describe("getTranslator", () => {
   it("should return the translated string for a given key and language", () => {
     const translator = getTranslator("en-US");
-    const translation = translator("common.bot.intro");
+    const translation = translator("common:bot.intro");
 
     expect(translation).toMatch("That's me...");
   });
 
   it("should throw an error if translation key is not found", () => {
     const translator = getTranslator("en-US");
     // @ts-expect-error
-    expect(() => translator("common.nonexistentKey")).toThrow("Translation key invalid: common.nonexistentKey");
+    expect(() => translator("common:nonexistentKey")).toThrow("Translation key invalid: nonexistentKey");
   });
 
   it("should return the translated string with interpolation values", () => {
     const translator = getTranslator("en-US");
-    const translatedString = translator("common.errors.ERROR_ID", { ID: "123456" });
+    const translatedString = translator("errors:ERROR_ID", { ID: "123456" });
 
     expect(translatedString).toBe("Error ID: `123456`");
   });
 
   it("should return the translated string for a different language", () => {
     const translatorHi = getTranslator("hi");
     const translatorRu = getTranslator("ru");
-    const translatedStringHi = translatorHi("common.bot.intro");
-    const translatedStringRu = translatorRu("common.bot.intro");
+    const translatedStringHi = translatorHi("common:bot.intro");
+    const translatedStringRu = translatorRu("common:bot.intro");
 
     expect(translatedStringHi).toMatch("यह में हूं...");
     expect(translatedStringRu).toMatch("Это я...");

diff --git a/__tests__/useTranslation.test.ts b/__tests__/useTranslation.test.ts
@@ -5,7 +5,7 @@ type Localizations = Partial<Record<(typeof l)[number], string>>;
 
 describe("useTranslations", () => {
   it("should return the correct translation for a given key", () => {
-    const translations = useTranslations("common.bot.intro");
+    const translations = useTranslations("common:bot.intro");
 
     const translationsTyped: Localizations = translations;
     expect(translationsTyped).toBeDefined();
@@ -19,15 +19,15 @@ describe("useTranslations", () => {
 
   it("should return an empty object if the translation key is not found", () => {
     // @ts-expect-error
-    const translations = useTranslations("common.nonexistentKey");
+    const translations = useTranslations("common:nonexistentKey");
 
     expect(translations).toEqual({});
     expect(Object.keys(translations).length).toBe(0);
   });
 
   it("should throw an error if the translation value is not a string", () => {
     expect(() => {
-      useTranslations("common.bot");
+      useTranslations("common:bot");
     }).toThrow(TypeError);
   });
 });
diff --git a/crowdin.yml b/crowdin.yml
@@ -12,8 +12,8 @@ pull_request_title: "chore: new translations [crowdin]"
 commit_message: "chore: translate to %language%"
 append_commit_message: false
 files:
-  - source: /locales/en-US.json
-    translation: /locales/%two_letters_code%.json
+  - source: /locales/en-US/*.json
+    translation: /locales/%two_letters_code%/%original_file_name%
     preserve_translations: true
 
 pre_translate: