@vocab/phrase 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @vocab/phrase
 
+## 1.0.1
+
+### Patch Changes
+
+- [`20eec77`](https://github.com/seek-oss/vocab/commit/20eec770705d05048ad8b32575cb92720b887f5b) [#76](https://github.com/seek-oss/vocab/pull/76) Thanks [@askoufis](https://github.com/askoufis)! - `vocab pull` no longer errors when phrase returns no translations for a configured language
+
 ## 1.0.0
 
 ### Major Changes

package/README.md

@@ -110,7 +110,7 @@ So far, your app will run, but you're missing any translations other than the in
 }
 ```
 
-### Step 6: [Optional] Setup Webpack plugin
+### Step 6: [Optional] Set up Webpack plugin
 
 Right now every language is loaded into your web application all the time, which could lead to a large bundle size. Ideally you will want to switch out the Node/default runtime for web runtime that will load only the active language.
 
@@ -171,8 +171,10 @@ In the below example we use two messages, one that passes in a single parameter
 Vocab will automatically parse these strings as ICU messages, identify the required parameters and ensure TypeScript knows the values must be passed in.
 
 ```tsx
-t('my key with param', {name: 'Vocab'});
-t('my key with component', {Link: children => (<a href="/foo">{children}</Link>)});
+t('my key with param', { name: 'Vocab' });
+t('my key with component', {
+  Link: (children) => <a href="/foo">{children}</a>
+});
 ```
 
 ## Configuration
@@ -194,7 +196,7 @@ module.exports = {
    * The root directory to compile and validate translations
    * Default: Current working directory
    */
-  projectRoot: ['./example/'];
+  projectRoot: './example/';
   /**
    * A custom suffix to name vocab translation directories
    * Default: '.vocab'

package/dist/vocab-phrase.cjs.dev.js

@@ -83,7 +83,6 @@ async function callPhrase(relativePath, options = {}) {
   }
 
   return _callPhrase(`https://api.phrase.com/v2/projects/${projectId}/${relativePath}`, options).then(result => {
-    // console.log('Result:', result);
     if (Array.isArray(result)) {
       console.log('Result length:', result.length);
     }
@@ -174,31 +173,33 @@ async function pull({
     await writeFile(loadedTranslation.filePath, `${JSON.stringify(defaultValues, null, 2)}\n`);
 
     for (const alternativeLanguage of alternativeLanguages) {
-      const altTranslations = { ...loadedTranslation.languages[alternativeLanguage]
-      };
-      const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
+      if (alternativeLanguage in allPhraseTranslations) {
+        const altTranslations = { ...loadedTranslation.languages[alternativeLanguage]
+        };
+        const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
+
+        for (const key of localKeys) {
+          var _phraseAltTranslation;
 
-      for (const key of localKeys) {
-        var _phraseAltTranslation;
+          const phraseKey = core.getUniqueKey(key, loadedTranslation.namespace);
+          const phraseTranslationMessage = (_phraseAltTranslation = phraseAltTranslations[phraseKey]) === null || _phraseAltTranslation === void 0 ? void 0 : _phraseAltTranslation.message;
 
-        const phraseKey = core.getUniqueKey(key, loadedTranslation.namespace);
-        const phraseTranslationMessage = (_phraseAltTranslation = phraseAltTranslations[phraseKey]) === null || _phraseAltTranslation === void 0 ? void 0 : _phraseAltTranslation.message;
+          if (!phraseTranslationMessage) {
+            trace(`Missing translation. No translation for key ${key} in phrase as ${phraseKey} in language ${alternativeLanguage}.`);
+            continue;
+          }
 
-        if (!phraseTranslationMessage) {
-          trace(`Missing translation. No translation for key ${key} in phrase as ${phraseKey} in language ${alternativeLanguage}.`);
-          continue;
+          altTranslations[key] = { ...altTranslations[key],
+            message: phraseTranslationMessage
+          };
         }
 
-        altTranslations[key] = { ...altTranslations[key],
-          message: phraseTranslationMessage
-        };
+        const altTranslationFilePath = core.getAltLanguageFilePath(loadedTranslation.filePath, alternativeLanguage);
+        await mkdir(path__default['default'].dirname(altTranslationFilePath), {
+          recursive: true
+        });
+        await writeFile(altTranslationFilePath, `${JSON.stringify(altTranslations, null, 2)}\n`);
       }
-
-      const altTranslationFilePath = core.getAltLanguageFilePath(loadedTranslation.filePath, alternativeLanguage);
-      await mkdir(path__default['default'].dirname(altTranslationFilePath), {
-        recursive: true
-      });
-      await writeFile(altTranslationFilePath, `${JSON.stringify(altTranslations, null, 2)}\n`);
     }
   }
 }

package/dist/vocab-phrase.cjs.prod.js

@@ -83,7 +83,6 @@ async function callPhrase(relativePath, options = {}) {
   }
 
   return _callPhrase(`https://api.phrase.com/v2/projects/${projectId}/${relativePath}`, options).then(result => {
-    // console.log('Result:', result);
     if (Array.isArray(result)) {
       console.log('Result length:', result.length);
     }
@@ -174,31 +173,33 @@ async function pull({
     await writeFile(loadedTranslation.filePath, `${JSON.stringify(defaultValues, null, 2)}\n`);
 
     for (const alternativeLanguage of alternativeLanguages) {
-      const altTranslations = { ...loadedTranslation.languages[alternativeLanguage]
-      };
-      const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
+      if (alternativeLanguage in allPhraseTranslations) {
+        const altTranslations = { ...loadedTranslation.languages[alternativeLanguage]
+        };
+        const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
+
+        for (const key of localKeys) {
+          var _phraseAltTranslation;
 
-      for (const key of localKeys) {
-        var _phraseAltTranslation;
+          const phraseKey = core.getUniqueKey(key, loadedTranslation.namespace);
+          const phraseTranslationMessage = (_phraseAltTranslation = phraseAltTranslations[phraseKey]) === null || _phraseAltTranslation === void 0 ? void 0 : _phraseAltTranslation.message;
 
-        const phraseKey = core.getUniqueKey(key, loadedTranslation.namespace);
-        const phraseTranslationMessage = (_phraseAltTranslation = phraseAltTranslations[phraseKey]) === null || _phraseAltTranslation === void 0 ? void 0 : _phraseAltTranslation.message;
+          if (!phraseTranslationMessage) {
+            trace(`Missing translation. No translation for key ${key} in phrase as ${phraseKey} in language ${alternativeLanguage}.`);
+            continue;
+          }
 
-        if (!phraseTranslationMessage) {
-          trace(`Missing translation. No translation for key ${key} in phrase as ${phraseKey} in language ${alternativeLanguage}.`);
-          continue;
+          altTranslations[key] = { ...altTranslations[key],
+            message: phraseTranslationMessage
+          };
         }
 
-        altTranslations[key] = { ...altTranslations[key],
-          message: phraseTranslationMessage
-        };
+        const altTranslationFilePath = core.getAltLanguageFilePath(loadedTranslation.filePath, alternativeLanguage);
+        await mkdir(path__default['default'].dirname(altTranslationFilePath), {
+          recursive: true
+        });
+        await writeFile(altTranslationFilePath, `${JSON.stringify(altTranslations, null, 2)}\n`);
       }
-
-      const altTranslationFilePath = core.getAltLanguageFilePath(loadedTranslation.filePath, alternativeLanguage);
-      await mkdir(path__default['default'].dirname(altTranslationFilePath), {
-        recursive: true
-      });
-      await writeFile(altTranslationFilePath, `${JSON.stringify(altTranslations, null, 2)}\n`);
     }
   }
 }

package/dist/vocab-phrase.esm.js

@@ -71,7 +71,6 @@ async function callPhrase(relativePath, options = {}) {
   }
 
   return _callPhrase(`https://api.phrase.com/v2/projects/${projectId}/${relativePath}`, options).then(result => {
-    // console.log('Result:', result);
     if (Array.isArray(result)) {
       console.log('Result length:', result.length);
     }
@@ -162,31 +161,33 @@ async function pull({
     await writeFile(loadedTranslation.filePath, `${JSON.stringify(defaultValues, null, 2)}\n`);
 
     for (const alternativeLanguage of alternativeLanguages) {
-      const altTranslations = { ...loadedTranslation.languages[alternativeLanguage]
-      };
-      const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
+      if (alternativeLanguage in allPhraseTranslations) {
+        const altTranslations = { ...loadedTranslation.languages[alternativeLanguage]
+        };
+        const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
+
+        for (const key of localKeys) {
+          var _phraseAltTranslation;
 
-      for (const key of localKeys) {
-        var _phraseAltTranslation;
+          const phraseKey = getUniqueKey(key, loadedTranslation.namespace);
+          const phraseTranslationMessage = (_phraseAltTranslation = phraseAltTranslations[phraseKey]) === null || _phraseAltTranslation === void 0 ? void 0 : _phraseAltTranslation.message;
 
-        const phraseKey = getUniqueKey(key, loadedTranslation.namespace);
-        const phraseTranslationMessage = (_phraseAltTranslation = phraseAltTranslations[phraseKey]) === null || _phraseAltTranslation === void 0 ? void 0 : _phraseAltTranslation.message;
+          if (!phraseTranslationMessage) {
+            trace(`Missing translation. No translation for key ${key} in phrase as ${phraseKey} in language ${alternativeLanguage}.`);
+            continue;
+          }
 
-        if (!phraseTranslationMessage) {
-          trace(`Missing translation. No translation for key ${key} in phrase as ${phraseKey} in language ${alternativeLanguage}.`);
-          continue;
+          altTranslations[key] = { ...altTranslations[key],
+            message: phraseTranslationMessage
+          };
         }
 
-        altTranslations[key] = { ...altTranslations[key],
-          message: phraseTranslationMessage
-        };
+        const altTranslationFilePath = getAltLanguageFilePath(loadedTranslation.filePath, alternativeLanguage);
+        await mkdir(path.dirname(altTranslationFilePath), {
+          recursive: true
+        });
+        await writeFile(altTranslationFilePath, `${JSON.stringify(altTranslations, null, 2)}\n`);
       }
-
-      const altTranslationFilePath = getAltLanguageFilePath(loadedTranslation.filePath, alternativeLanguage);
-      await mkdir(path.dirname(altTranslationFilePath), {
-        recursive: true
-      });
-      await writeFile(altTranslationFilePath, `${JSON.stringify(altTranslations, null, 2)}\n`);
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vocab/phrase",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "dist/vocab-phrase.cjs.js",
   "module": "dist/vocab-phrase.esm.js",
   "author": "SEEK",

package/src/phrase-api.ts

@@ -80,7 +80,6 @@ export async function callPhrase(
     options,
   )
     .then((result) => {
-      // console.log('Result:', result);
       if (Array.isArray(result)) {
         console.log('Result length:', result.length);
       }

package/src/pull-translations.test.ts

@@ -2,6 +2,7 @@ import path from 'path';
 import { pull } from './pull-translations';
 import { pullAllTranslations } from './phrase-api';
 import { writeFile } from './file';
+import { LanguageTarget } from '@vocab/types';
 
 jest.mock('./file', () => ({
   writeFile: jest.fn(() => Promise.resolve),
@@ -13,28 +14,83 @@ jest.mock('./phrase-api', () => ({
   pullAllTranslations: jest.fn(() => Promise.resolve({ en: {}, fr: {} })),
 }));
 
-function runPhrase() {
+function runPhrase(options: { languages: LanguageTarget[] }) {
   return pull(
     { branch: 'tester' },
     {
+      ...options,
       devLanguage: 'en',
-      languages: [{ name: 'en' }, { name: 'fr' }],
       projectRoot: path.resolve(__dirname, '..', '..', '..', 'fixtures/phrase'),
     },
   );
 }
 
-describe('pull', () => {
-  beforeEach(() => {
-    (pullAllTranslations as jest.Mock).mockClear();
-    (writeFile as jest.Mock).mockClear();
-  });
-  it('should resolve', async () => {
-    await expect(runPhrase()).resolves.toBeUndefined();
+describe('pull translations', () => {
+  describe('when pulling translations for languages that already have translations', () => {
+    beforeEach(() => {
+      (pullAllTranslations as jest.Mock).mockClear();
+      (writeFile as jest.Mock).mockClear();
+    });
+    (pullAllTranslations as jest.Mock).mockImplementation(() =>
+      Promise.resolve({
+        en: {
+          'hello.mytranslations': {
+            message: 'Hi there',
+          },
+        },
+        fr: {
+          'hello.mytranslations': {
+            message: 'merci',
+          },
+        },
+      }),
+    );
 
-    expect(writeFile as jest.Mock).toHaveBeenCalledTimes(2);
+    const options = {
+      languages: [{ name: 'en' }, { name: 'fr' }],
+    };
+
+    it('should resolve', async () => {
+      await expect(runPhrase(options)).resolves.toBeUndefined();
+
+      expect(writeFile as jest.Mock).toHaveBeenCalledTimes(2);
+    });
+
+    it('should update keys', async () => {
+      await expect(runPhrase(options)).resolves.toBeUndefined();
+
+      expect(
+        (writeFile as jest.Mock).mock.calls.map(
+          ([_filePath, contents]: [string, string]) => JSON.parse(contents),
+        ),
+      ).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "hello": Object {
+            "message": "Hi there",
+          },
+          "world": Object {
+            "message": "world",
+          },
+        },
+        Object {
+          "hello": Object {
+            "message": "merci",
+          },
+          "world": Object {
+            "message": "monde",
+          },
+        },
+      ]
+    `);
+    });
   });
-  it('should update keys', async () => {
+
+  describe('when pulling translations and some languages do not have any translations', () => {
+    beforeEach(() => {
+      (pullAllTranslations as jest.Mock).mockClear();
+      (writeFile as jest.Mock).mockClear();
+    });
     (pullAllTranslations as jest.Mock).mockImplementation(() =>
       Promise.resolve({
         en: {
@@ -50,13 +106,24 @@ describe('pull', () => {
       }),
     );
 
-    await expect(runPhrase()).resolves.toBeUndefined();
+    const options = {
+      languages: [{ name: 'en' }, { name: 'fr' }, { name: 'ja' }],
+    };
+
+    it('should resolve', async () => {
+      await expect(runPhrase(options)).resolves.toBeUndefined();
+
+      expect(writeFile as jest.Mock).toHaveBeenCalledTimes(2);
+    });
+
+    it('should update keys', async () => {
+      await expect(runPhrase(options)).resolves.toBeUndefined();
 
-    expect(
-      (writeFile as jest.Mock).mock.calls.map(
-        ([_filePath, contents]: [string, string]) => JSON.parse(contents),
-      ),
-    ).toMatchInlineSnapshot(`
+      expect(
+        (writeFile as jest.Mock).mock.calls.map(
+          ([_filePath, contents]: [string, string]) => JSON.parse(contents),
+        ),
+      ).toMatchInlineSnapshot(`
       Array [
         Object {
           "hello": Object {
@@ -76,5 +143,6 @@ describe('pull', () => {
         },
       ]
     `);
+    });
   });
 });

package/src/pull-translations.ts

@@ -59,41 +59,44 @@ export async function pull(
     );
 
     for (const alternativeLanguage of alternativeLanguages) {
-      const altTranslations = {
-        ...loadedTranslation.languages[alternativeLanguage],
-      };
-      const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
+      if (alternativeLanguage in allPhraseTranslations) {
+        const altTranslations = {
+          ...loadedTranslation.languages[alternativeLanguage],
+        };
+        const phraseAltTranslations =
+          allPhraseTranslations[alternativeLanguage];
 
-      for (const key of localKeys) {
-        const phraseKey = getUniqueKey(key, loadedTranslation.namespace);
-        const phraseTranslationMessage =
-          phraseAltTranslations[phraseKey]?.message;
+        for (const key of localKeys) {
+          const phraseKey = getUniqueKey(key, loadedTranslation.namespace);
+          const phraseTranslationMessage =
+            phraseAltTranslations[phraseKey]?.message;
 
-        if (!phraseTranslationMessage) {
-          trace(
-            `Missing translation. No translation for key ${key} in phrase as ${phraseKey} in language ${alternativeLanguage}.`,
-          );
-          continue;
-        }
+          if (!phraseTranslationMessage) {
+            trace(
+              `Missing translation. No translation for key ${key} in phrase as ${phraseKey} in language ${alternativeLanguage}.`,
+            );
+            continue;
+          }
 
-        altTranslations[key] = {
-          ...altTranslations[key],
-          message: phraseTranslationMessage,
-        };
-      }
+          altTranslations[key] = {
+            ...altTranslations[key],
+            message: phraseTranslationMessage,
+          };
+        }
 
-      const altTranslationFilePath = getAltLanguageFilePath(
-        loadedTranslation.filePath,
-        alternativeLanguage,
-      );
+        const altTranslationFilePath = getAltLanguageFilePath(
+          loadedTranslation.filePath,
+          alternativeLanguage,
+        );
 
-      await mkdir(path.dirname(altTranslationFilePath), {
-        recursive: true,
-      });
-      await writeFile(
-        altTranslationFilePath,
-        `${JSON.stringify(altTranslations, null, 2)}\n`,
-      );
+        await mkdir(path.dirname(altTranslationFilePath), {
+          recursive: true,
+        });
+        await writeFile(
+          altTranslationFilePath,
+          `${JSON.stringify(altTranslations, null, 2)}\n`,
+        );
+      }
     }
   }
 }