@vocab/phrase 0.0.10 → 1.0.1

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @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
+
+- [`3031054`](https://github.com/seek-oss/vocab/commit/303105440851db6126f0606e1607745b27dd981c) [#51](https://github.com/seek-oss/vocab/pull/51) Thanks [@jahredhope](https://github.com/jahredhope)! - Release v1.0.0
+
+  Release Vocab as v1.0.0 to signify a stable API and support future [semver versioning](https://semver.org/) releases.
+
+  Vocab has seen a lot of iteration and changes since it was first published on 20 November 2020. We are now confident with the API and believe Vocab is ready for common use.
+
+### Patch Changes
+
+- Updated dependencies [[`0074382`](https://github.com/seek-oss/vocab/commit/007438273ef70f5d5ded45777933651ad8df36f6), [`3031054`](https://github.com/seek-oss/vocab/commit/303105440851db6126f0606e1607745b27dd981c)]:
+  - @vocab/core@1.0.0
+  - @vocab/types@1.0.0
+
+## 0.0.11
+
+### Patch Changes
+
+- Updated dependencies [[`5b1fdc0`](https://github.com/seek-oss/vocab/commit/5b1fdc019522b12e7ef94b2fec57b54a9310d41c)]:
+  - @vocab/core@0.0.11
+  - @vocab/types@0.0.9
+
 ## 0.0.10
 
 ### Patch Changes

package/README.md

@@ -1,35 +1,32 @@
 # Vocab
 
-Vocab is a strongly typed internationalisation framework for React.
+Vocab is a strongly typed internationalization framework for React.
 
-## Getting started
+Vocab helps you ship multiple languages without compromising the reliability of your site or slowing down delivery.
 
-### Step 1: Install Dependencies
+- Shareable translations
 
-Vocab is a monorepo with different packages you can install depending on your usage, the below list will get you started using the cli, React and webpack integrations.
+  Translations are co-located with the components that use them. Vocab uses the module graph allowing shared components to be installed with package managers like npm, just like any other module.
 
-```bash
-$ npm i --save @vocab/cli @vocab/react @vocab/webpack
-```
+- Loading translations dynamically
 
-### Step 2: Setup Webpack plugin
+  Vocab only loads the current user's language. If the language changes Vocab can load the new language behind the scenes without reloading the page.
 
-Before starting to write code you'll need to setup webpack to understand how to use `translation.json` files.
+- Strongly typed with TypeScript
 
-This is done using the **VocabWebpackPlugin**.
+  When using translations TypeScript will ensure code only accesses valid translations and translations are passed all required dynamic values.
 
-**webpack.config.js**
+## Getting started
 
-```js
-const VocabWebpackPlugin = require('@vocab/webpack').default;
+### Step 1: Install Dependencies
 
-module.exports = {
-  ...,
-  plugins: [new VocabWebpackPlugin({})]
-}
+Vocab is a monorepo with different packages you can install depending on your usage, the below list will get you started using the cli, React and webpack integrations.
+
+```bash
+$ npm i --save @vocab/cli @vocab/react @vocab/webpack
 ```
 
-### Step 3: Configure Vocab
+### Step 2: Configure Vocab
 
 You can configure Vocab directly when calling the API or via a `vocab.config.js` file.
 
@@ -48,7 +45,7 @@ module.exports = {
 
 Vocab doesn't tell you how to select or change your language. You just need to tell Vocab what language to use.
 
-**Note:** Using methods discussed later we'll make sure the first language is loaded on page load. However, after this changing languages may then lead to a period of no translations as Vocab downloads the new language's translations.
+**Note:** Using methods discussed later we'll make sure the first language is loaded on page load. However, after this, changing languages may then lead to a period of no translations as Vocab downloads the new language's translations.
 
 **src/App.tsx**
 
@@ -100,7 +97,7 @@ function MyComponent({ children }) {
 
 ### Step 5: Create translations
 
-So far your app will run, but you're missing any translations other than the initial language. The below file can be created manually; however, you can also integrate with a remote translation platform to push and pull translations automatically. See [External translation tooling](#external-translation-tooling) for more information.
+So far, your app will run, but you're missing any translations other than the initial language. The below file can be created manually; however, you can also integrate with a remote translation platform to push and pull translations automatically. See [External translation tooling](#external-translation-tooling) for more information.
 
 **./example.vocab/fr-FR.translations.json**
 
@@ -108,18 +105,35 @@ So far your app will run, but you're missing any translations other than the ini
 {
   "my key": {
     "message": "Bonjour de Vocab",
-    "decription": "An optional description to help when translating"
+    "description": "An optional description to help when translating"
   }
 }
 ```
 
-### Step 6: Optimize for fast page loading
+### 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.
+
+This is done using the **VocabWebpackPlugin**. Applying this plugin to your client webpack configuration will replace all vocab files with a dynamic asynchronous chunks designed for the web.
+
+**webpack.config.js**
+
+```js
+const { VocabWebpackPlugin } = require('@vocab/webpack');
+
+module.exports = {
+  ...,
+  plugins: [new VocabWebpackPlugin()]
+}
+```
+
+### Step 7: [Optional] Optimize for fast page loading
 
 Using the above method without optimizing what chunks webpack uses you may find the page needing to do an extra round trip to load languages on a page.
 
 This is where `getChunkName` can be used to retrieve the Webpack chunk used for a specific language.
 
-For example here is a Server Render function that would add the current language chunk to [Loadable component's ChunkExtractor](https://loadable-components.com/docs/api-loadable-server/#chunkextractor).
+For example, here is a Server Render function that would add the current language chunk to [Loadable component's ChunkExtractor](https://loadable-components.com/docs/api-loadable-server/#chunkextractor).
 
 **src/render.tsx**
 
@@ -135,6 +149,34 @@ const extractor = new ChunkExtractor();
 extractor.addChunk(chunkName);
 ```
 
+## ICU Message format
+
+Translation messages can sometimes contain dynamic values, such as dates/times, links or usernames. These values can often exist somewhere in the middle of a message and change location based on translation.
+
+To support this Vocab uses [Format.js's intl-messageformat] allowing you to use [ICU Message syntax](https://formatjs.io/docs/core-concepts/icu-syntax/) in your messages.
+
+In the below example we use two messages, one that passes in a single parameter and one uses a component.
+
+```json
+{
+  "my key with param": {
+    "message": "Bonjour de {name}"
+  },
+  "my key with component": {
+    "message": "Bonjour de <Link>Vocab</Link>"
+  }
+}
+```
+
+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}</a>
+});
+```
+
 ## Configuration
 
 Configuration can either be passed into the Node API directly or be gathered from the nearest _vocab.config.js_ file.
@@ -154,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'
@@ -167,6 +209,56 @@ module.exports = {
 };
 ```
 
+## Use without React
+
+If you need to use Vocab outside of React, you can access the returned Vocab file directly. You'll then be responsible for when to load translations and how to update on translation load.
+
+#### Async access
+
+- `getMessages(language: string) => Promise<Messages>` returns messages for the given language formatted according to the correct locale. If the language has not been loaded it will load the language before resolving.
+
+**Note:** To optimize loading time you may want to call `load` (see below) ahead of use.
+
+#### Sync access
+
+- `load(language: string) => Promise<void>` attempts to pre-load messages for the given language. Resolving once complete. Note this only ensures the language is available and does not return any translations.
+- `getLoadedMessages(language: string) => Messages | null` returns messages for the given language formatted according to the correct locale. If the language has not been loaded it will return `null`. Note that this will not load the language if it's not available. Useful when a synchronous (non-promise) return is required.
+
+**Example: Promise based formatting of messages**
+
+```typescript
+import translations from './.vocab';
+
+async function getFooMessage(language) {
+  let messages = await translations.getMessages(language);
+  return messages['my key'].format();
+}
+
+getFooMessage().then((m) => console.log(m));
+```
+
+**Example: Synchronously returning a message**
+
+```typescript
+import translations from './.vocab';
+
+function getFooMessageSync(language) {
+  let messages = translations.getLoadedMessages(language);
+  if (!messages) {
+    // Translations not loaded, start loading and return null for now
+    translations.load();
+    return null;
+  }
+  return messages.foo.format();
+}
+
+translations.load();
+
+const onClick = () => {
+  console.log(getFooMessageSync());
+};
+```
+
 ## Generate Types
 
 Vocab generates custom `index.ts` files that give your React components strongly typed translations to work with.
@@ -185,7 +277,7 @@ $ vocab compile --watch
 
 ## External translation tooling
 
-Vocab can be used to syncronize your translations with translations from a remote translation platform.
+Vocab can be used to synchronize your translations with translations from a remote translation platform.
 
 | Platform                                     | Environment Variables               |
 | -------------------------------------------- | ----------------------------------- |
@@ -196,6 +288,13 @@ $ vocab push --branch my-branch
 $ vocab pull --branch my-branch
 ```
 
+## Troubleshooting
+
+### Problem: Passed locale is being ignored or using en-US instead
+
+When running in Node.js the locale formatting is supported by [Node.js's Internationalization support](https://nodejs.org/api/intl.html#intl_internationalization_support). Node.js will silently switch to the closest locale it can find if the passed locale is not available.
+See Node's documentation on [Options for building Node.js](https://nodejs.org/api/intl.html#intl_options_for_building_node_js) for information on ensuring Node has the locales you need.
+
 ### License
 
 MIT.

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

@@ -53,7 +53,7 @@ function _callPhrase(path, options = {}) {
       const result = await response.json();
       console.log(`Internal Result (Length: ${result.length})\n`);
 
-      if ((!options.method || options.method === 'GET') && ((_response$headers$get = response.headers.get('Link')) === null || _response$headers$get === void 0 ? void 0 : _response$headers$get.includes('rel=next'))) {
+      if ((!options.method || options.method === 'GET') && (_response$headers$get = response.headers.get('Link')) !== null && _response$headers$get !== void 0 && _response$headers$get.includes('rel=next')) {
         var _response$headers$get2, _response$headers$get3;
 
         const [, nextPageUrl] = (_response$headers$get2 = (_response$headers$get3 = response.headers.get('Link')) === null || _response$headers$get3 === void 0 ? void 0 : _response$headers$get3.match(/<([^>]*)>; rel=next/)) !== null && _response$headers$get2 !== void 0 ? _response$headers$get2 : [];
@@ -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

@@ -53,7 +53,7 @@ function _callPhrase(path, options = {}) {
       const result = await response.json();
       console.log(`Internal Result (Length: ${result.length})\n`);
 
-      if ((!options.method || options.method === 'GET') && ((_response$headers$get = response.headers.get('Link')) === null || _response$headers$get === void 0 ? void 0 : _response$headers$get.includes('rel=next'))) {
+      if ((!options.method || options.method === 'GET') && (_response$headers$get = response.headers.get('Link')) !== null && _response$headers$get !== void 0 && _response$headers$get.includes('rel=next')) {
         var _response$headers$get2, _response$headers$get3;
 
         const [, nextPageUrl] = (_response$headers$get2 = (_response$headers$get3 = response.headers.get('Link')) === null || _response$headers$get3 === void 0 ? void 0 : _response$headers$get3.match(/<([^>]*)>; rel=next/)) !== null && _response$headers$get2 !== void 0 ? _response$headers$get2 : [];
@@ -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

@@ -41,7 +41,7 @@ function _callPhrase(path, options = {}) {
       const result = await response.json();
       console.log(`Internal Result (Length: ${result.length})\n`);
 
-      if ((!options.method || options.method === 'GET') && ((_response$headers$get = response.headers.get('Link')) === null || _response$headers$get === void 0 ? void 0 : _response$headers$get.includes('rel=next'))) {
+      if ((!options.method || options.method === 'GET') && (_response$headers$get = response.headers.get('Link')) !== null && _response$headers$get !== void 0 && _response$headers$get.includes('rel=next')) {
         var _response$headers$get2, _response$headers$get3;
 
         const [, nextPageUrl] = (_response$headers$get2 = (_response$headers$get3 = response.headers.get('Link')) === null || _response$headers$get3 === void 0 ? void 0 : _response$headers$get3.match(/<([^>]*)>; rel=next/)) !== null && _response$headers$get2 !== void 0 ? _response$headers$get2 : [];
@@ -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,13 +1,13 @@
 {
   "name": "@vocab/phrase",
-  "version": "0.0.10",
+  "version": "1.0.1",
   "main": "dist/vocab-phrase.cjs.js",
   "module": "dist/vocab-phrase.esm.js",
   "author": "SEEK",
   "license": "MIT",
   "dependencies": {
-    "@vocab/core": "^0.0.10",
-    "@vocab/types": "^0.0.8",
+    "@vocab/core": "^1.0.0",
+    "@vocab/types": "^1.0.0",
     "chalk": "^4.1.0",
     "debug": "^4.3.1",
     "form-data": "^3.0.0",

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`,
+        );
+      }
     }
   }
 }