feat(write): Add default value for new translations

freakzlike · Jun 25, 2023 · d3d10e4 · d3d10e4
1 parent 03c987c
commit d3d10e4
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -29,6 +29,8 @@ module.exports = {
   // Optional: Default namespace if none given in translation
   defaultNamespace: 'common',
   // Optional: Namespaces
-  namespaces: ['common', 'other']
+  namespaces: ['common', 'other'],
+  // Default value for new translations
+  defaultValue: '__MISSING_TRANSLATION__'
 }
 ```
diff --git a/src/merge.ts b/src/merge.ts
@@ -13,7 +13,7 @@ export const generateNewTranslations = async (
     const _translationKeys = translationKeys[namespace] || []
     const _existingTranslations = existingTranslations[language]?.[namespace]?.translations || {}
     for (const translationKey of _translationKeys) {
-      translations = await writeTranslationStructure(translationKey, _existingTranslations, translations)
+      translations = await writeTranslationStructure(translationKey, _existingTranslations, translations, options)
     }
 
     return translations
@@ -29,7 +29,8 @@ const mapTranslationStructure = (
 export const writeTranslationStructure = async (
   translationKey: string,
   existingTranslations: TranslationStructure,
-  translations: TranslationStructure
+  translations: TranslationStructure,
+  options: I18nExtractOptions
 ): Promise<TranslationStructure> => {
   const contextIdx = translationKey.indexOf('.')
   if (contextIdx > -1) {
@@ -38,12 +39,13 @@ export const writeTranslationStructure = async (
     translations[context] = await writeTranslationStructure(
       nestedKey,
       mapTranslationStructure(existingTranslations[context]),
-      mapTranslationStructure(translations[context])
+      mapTranslationStructure(translations[context]),
+      options
     )
   } else if (typeof existingTranslations[translationKey] === 'string') {
     translations[translationKey] = existingTranslations[translationKey]
   } else {
-    translations[translationKey] = '__MISSING_TRANSLATION__'
+    translations[translationKey] = options.defaultValue || '__MISSING_TRANSLATION__'
   }
   return translations
 }
diff --git a/src/types.ts b/src/types.ts
@@ -18,4 +18,5 @@ export interface I18nExtractOptions {
   languages: Language[]
   defaultNamespace?: Namespace
   namespaces?: Namespace[]
+  defaultValue?: string
 }
diff --git a/tests/merge.spec.ts b/tests/merge.spec.ts
@@ -1,15 +1,22 @@
 import { describe, expect, it } from 'vitest'
 import { writeTranslationStructure } from '@/merge'
+import { I18nExtractOptions } from '@/types'
 
 /**
  * writeTranslationStructure
  */
 describe('writeTranslationStructure', () => {
+  const defaultOptions: I18nExtractOptions = {
+    input: ['src/**'],
+    output: 'examples/default/locales/{{lng}}.json',
+    languages: ['de', 'en-GB']
+  }
+
   it('should write simple translation key', async () => {
     expect(await writeTranslationStructure('key_1', {
       key_1: 'Key 1',
       key_2: 'Key 2'
-    }, {})).toStrictEqual({
+    }, {}, defaultOptions)).toStrictEqual({
       key_1: 'Key 1',
     })
   })
@@ -19,7 +26,7 @@ describe('writeTranslationStructure', () => {
       key_1: 'Key 1'
     }, {
       key_2: 'Key 2'
-    })).toStrictEqual({
+    }, defaultOptions)).toStrictEqual({
       key_1: 'Key 1',
       key_2: 'Key 2'
     })
@@ -28,17 +35,28 @@ describe('writeTranslationStructure', () => {
   it('should write simple translation key with missing translation', async () => {
     expect(await writeTranslationStructure('key_1', {
       key_2: 'Key 2'
-    }, {})).toStrictEqual({
+    }, {}, defaultOptions)).toStrictEqual({
       key_1: '__MISSING_TRANSLATION__',
     })
   })
 
+  it('should write simple translation key with missing translation', async () => {
+    expect(await writeTranslationStructure('key_1', {
+      key_2: 'Key 2'
+    }, {}, {
+      ...defaultOptions,
+      defaultValue: '__NEW_KEY__'
+    })).toStrictEqual({
+      key_1: '__NEW_KEY__',
+    })
+  })
+
   it('should write missing translation key if different context', async () => {
     expect(await writeTranslationStructure('key_1', {
       key_1: {
         nested: '1'
       }
-    }, {})).toStrictEqual({
+    }, {}, defaultOptions)).toStrictEqual({
       key_1: '__MISSING_TRANSLATION__',
     })
   })
@@ -49,7 +67,7 @@ describe('writeTranslationStructure', () => {
         nested: 'Nested translation',
         other: 'other'
       }
-    }, {})).toStrictEqual({
+    }, {}, defaultOptions)).toStrictEqual({
       context: {
         nested: 'Nested translation'
       }
@@ -65,7 +83,7 @@ describe('writeTranslationStructure', () => {
           }
         }
       }
-    }, {})).toStrictEqual({
+    }, {}, defaultOptions)).toStrictEqual({
       context: {
         nested: {
           more: {
@@ -81,7 +99,7 @@ describe('writeTranslationStructure', () => {
       context: {
         other: 'other'
       }
-    }, {})).toStrictEqual({
+    }, {}, defaultOptions)).toStrictEqual({
       context: {
         nested: '__MISSING_TRANSLATION__'
       }
@@ -98,7 +116,7 @@ describe('writeTranslationStructure', () => {
       context: {
         other: 'other'
       }
-    })).toStrictEqual({
+    }, defaultOptions)).toStrictEqual({
       key: 'key',
       context: {
         nested: 'Nested translation',
@@ -114,7 +132,7 @@ describe('writeTranslationStructure', () => {
       }
     }, {
       context: 'Context'
-    })).toStrictEqual({
+    }, defaultOptions)).toStrictEqual({
       context: {
         nested: 'Nested translation'
       }