Merge branch 'global-key-support' into global-key-push-translations

# Conflicts: # fixtures/phrase/src/mytranslations.vocab/translations.json
seek-oss · Oct 20, 2023 · e7de704 · e7de704
2 parents 0730293 + 41532d9
commit e7de704
Show file tree

Hide file tree

Showing 11 changed files with 72 additions and 32 deletions.
diff --git a/.changeset/nasty-seahorses-confess.md b/.changeset/nasty-seahorses-confess.md
@@ -0,0 +1,15 @@
+---
+'@vocab/phrase': minor
+'@vocab/core': minor
+---
+
+Vocab pull: support custom key
+
+```json
+{
+  "thanks": {
+    "message": "Thanks",
+    "global-key": "app.thanks.label"
+  }
+}
+```
diff --git a/fixtures/phrase/src/mytranslations.vocab/translations.json b/fixtures/phrase/src/mytranslations.vocab/translations.json
@@ -9,8 +9,8 @@
   "world": {
     "message": "world"
   },
-  "profile": {
-    "message": "profile",
-    "global-key": "app.common.profile"
+  "thanks": {
+    "message": "Thanks",
+    "global-key": "app.thanks.label"
   }
 }
diff --git a/packages/core/src/config.ts b/packages/core/src/config.ts
@@ -202,3 +202,5 @@ export function resolveConfigSync(
 
   return null;
 }
+
+export const GLOBAL_KEY = 'global-key';
diff --git a/packages/core/src/load-translations.ts b/packages/core/src/load-translations.ts
@@ -21,6 +21,7 @@ import {
   getDevTranslationFileGlob,
 } from './utils';
 import { generateLanguageFromTranslations } from './generate-language';
+import { GLOBAL_KEY } from './config';
 
 export function getUniqueKey(key: string, namespace: string) {
   return `${key}.${namespace}`;
@@ -410,6 +411,17 @@ export async function loadAllTranslations(
         );
       }
       keys.add(uniqueKey);
+
+      const globalKey =
+        loadedTranslation.languages[config.devLanguage][key][GLOBAL_KEY];
+      if (globalKey) {
+        if (keys.has(globalKey)) {
+          throw new Error(
+            `Duplicate keys found. Global key ${key} was found multiple times`,
+          );
+        }
+        keys.add(globalKey);
+      }
     }
   }
   return result;

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -134,10 +134,10 @@ export interface TranslationFileMetadata {
 }
 
 export interface TranslationData {
-  'global-key'?: string;
   message: TranslationMessage;
   description?: string;
   tags?: Tags;
+  'global-key'?: string;
 }
 
 export type TranslationsByKey<Key extends TranslationKey = string> = Record<

diff --git a/packages/phrase/src/config.ts b/packages/phrase/src/config.ts
@@ -0,0 +1 @@
+export const GLOBAL_KEY = 'global-key';
diff --git a/packages/phrase/src/index.ts b/packages/phrase/src/index.ts
@@ -1,4 +1,2 @@
 export { pull } from './pull-translations';
 export { push } from './push-translations';
-
-export const GLOBAL_KEY = 'global-key';
diff --git a/packages/phrase/src/pull-translations.test.ts b/packages/phrase/src/pull-translations.test.ts
@@ -41,11 +41,17 @@ describe('pull translations', () => {
             'hello.mytranslations': {
               message: 'Hi there',
             },
+            'app.thanks.label': {
+              message: 'Thank you.',
+            },
           },
           fr: {
             'hello.mytranslations': {
               message: 'merci',
             },
+            'app.thanks.label': {
+              message: 'Merci.',
+            },
           },
         }),
       );
@@ -98,6 +104,10 @@ describe('pull translations', () => {
                 "greeting",
               ],
             },
+            "thanks": {
+              "global-key": "app.thanks.label",
+              "message": "Thank you.",
+            },
             "world": {
               "message": "world",
             },
@@ -106,6 +116,9 @@ describe('pull translations', () => {
             "hello": {
               "message": "merci",
             },
+            "thanks": {
+              "message": "Merci.",
+            },
             "world": {
               "message": "monde",
             },
@@ -182,6 +195,10 @@ describe('pull translations', () => {
                 "greeting",
               ],
             },
+            "thanks": {
+              "global-key": "app.thanks.label",
+              "message": "Thanks",
+            },
             "world": {
               "message": "world",
             },

diff --git a/packages/phrase/src/pull-translations.ts b/packages/phrase/src/pull-translations.ts
@@ -11,6 +11,7 @@ import type { TranslationFileContents, UserConfig } from '@vocab/core';
 
 import { pullAllTranslations, ensureBranch } from './phrase-api';
 import { trace } from './logger';
+import { GLOBAL_KEY } from './config';
 
 interface PullOptions {
   branch?: string;
@@ -61,7 +62,8 @@ export async function pull(
       defaultValues[key] = {
         ...defaultValues[key],
         ...allPhraseTranslations[config.devLanguage][
-          getUniqueKey(key, loadedTranslation.namespace)
+          defaultValues[key][GLOBAL_KEY] ??
+            getUniqueKey(key, loadedTranslation.namespace)
         ],
       };
     }
@@ -85,7 +87,9 @@ export async function pull(
           allPhraseTranslations[alternativeLanguage];
 
         for (const key of localKeys) {
-          const phraseKey = getUniqueKey(key, loadedTranslation.namespace);
+          const phraseKey =
+            defaultValues[key][GLOBAL_KEY] ??
+            getUniqueKey(key, loadedTranslation.namespace);
           const phraseTranslationMessage =
             phraseAltTranslations[phraseKey]?.message;
 

diff --git a/packages/phrase/src/push-translations.test.ts b/packages/phrase/src/push-translations.test.ts
@@ -63,22 +63,22 @@ describe('push', () => {
         .toMatchInlineSnapshot(`
         {
           "en": {
-            "app.common.profile": {
-              "global-key": "app.common.profile",
-              "message": "profile",
+            "hello.mytranslations": {
+              "message": "Hello",
               "tags": [
+                "only for this key",
+                "greeting",
                 "every",
                 "key",
                 "gets",
                 "these",
                 "tags",
               ],
             },
-            "hello.mytranslations": {
-              "message": "Hello",
+            "thanks.mytranslations": {
+              "global-key": "app.thanks.label",
+              "message": "Thanks",
               "tags": [
-                "only for this key",
-                "greeting",
                 "every",
                 "key",
                 "gets",
@@ -98,10 +98,6 @@ describe('push', () => {
             },
           },
           "fr": {
-            "app.common.profile": {
-              "description": undefined,
-              "message": "profil",
-            },
             "hello.mytranslations": {
               "description": undefined,
               "message": "Bonjour",
@@ -149,22 +145,22 @@ describe('push', () => {
           .toMatchInlineSnapshot(`
           {
             "en": {
-              "app.common.profile": {
-                "global-key": "app.common.profile",
-                "message": "profile",
+              "hello.mytranslations": {
+                "message": "Hello",
                 "tags": [
+                  "only for this key",
+                  "greeting",
                   "every",
                   "key",
                   "gets",
                   "these",
                   "tags",
                 ],
               },
-              "hello.mytranslations": {
-                "message": "Hello",
+              "thanks.mytranslations": {
+                "global-key": "app.thanks.label",
+                "message": "Thanks",
                 "tags": [
-                  "only for this key",
-                  "greeting",
                   "every",
                   "key",
                   "gets",
@@ -184,10 +180,6 @@ describe('push', () => {
               },
             },
             "fr": {
-              "app.common.profile": {
-                "description": undefined,
-                "message": "profil",
-              },
               "hello.mytranslations": {
                 "description": undefined,
                 "message": "Bonjour",

diff --git a/packages/phrase/src/push-translations.ts b/packages/phrase/src/push-translations.ts
@@ -10,8 +10,7 @@ import {
   pushTranslations,
 } from './phrase-api';
 import { trace } from './logger';
-import { loadAllTranslations, getUniqueKey } from '@vocab/core';
-import { GLOBAL_KEY } from '.';
+import { loadAllTranslations, getUniqueKey, GLOBAL_KEY } from '@vocab/core';
 
 interface PushOptions {
   branch: string;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -202,3 +202,5 @@ export function resolveConfigSync(

		return null;
		}

		export const GLOBAL_KEY = 'global-key';