feat: Handle multiple ":" in translation keys

closes #73
freakzlike · Dec 3, 2024 · 5ca8ec5 · 5ca8ec5
1 parent b7b4100
commit 5ca8ec5
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 5 deletions.
diff --git a/bin/extract.cjs b/bin/extract.cjs
@@ -9,4 +9,8 @@ if (!args.length || !args[0]) {
 }
 
 const options = require(path.resolve(process.cwd(), args[0]))
-i18nExtract(options)
+i18nExtract(options).then(result => {
+  if (!result) {
+    process.exit(1)
+  }
+})
diff --git a/examples/namespaces/src/typescript-file.ts b/examples/namespaces/src/typescript-file.ts
@@ -16,6 +16,11 @@ $t('context.key_2')
 $t('context.nested.key')
 $t('new_key')
 
+/**
+ * Invalid usages
+ */
+$t('common:invalid:nested:key')
+
 /**
  * Not parse this
  */

diff --git a/src/check.ts b/src/check.ts
@@ -16,13 +16,17 @@ export const i18nCheck = async (
 
 const checkUntranslated = async (translationResults: TranslationMapWrite): Promise<boolean> => {
   let hasUntranslated = false
+  let hasOtherError = false
   for (const languageTranslations of Object.values(translationResults)) {
-    for (const { filePath, untranslatedCount} of Object.values(languageTranslations)) {
+    for (const { filePath, untranslatedCount, otherError } of Object.values(languageTranslations)) {
       if (untranslatedCount) {
         hasUntranslated = true
         console.log(`${filePath} has untranslated messages!`)
       }
+      if (otherError) {
+        hasOtherError = true
+      }
     }
   }
-  return !hasUntranslated
+  return !hasUntranslated && !hasOtherError
 }
diff --git a/src/extract.ts b/src/extract.ts
@@ -14,6 +14,8 @@ export const i18nExtract = async (
 
   const translationResults = await generateNewTranslations(translationKeys, existingTranslations, options)
   await writeTranslations(translationResults)
+
+  return true
 }
 
 export const writeTranslations = async (

diff --git a/src/parse.ts b/src/parse.ts
@@ -15,8 +15,9 @@ export const parseFiles = async (
   await Promise.all(files.map(async filePath => {
     const fileResults = await parseFile(options, filePath)
     fileResults.forEach(fullKey => {
-      const [namespace, key] = fullKey.includes(':')
-        ? fullKey.split(':', 2)
+      const namespaceIndex = fullKey.indexOf(':')
+      const [namespace, key] = namespaceIndex > 0
+        ? [fullKey.substring(0, namespaceIndex), fullKey.substring(namespaceIndex + 1)]
         : [defaultNamespace, fullKey]
 
       if (!results[namespace]) {

diff --git a/src/types.ts b/src/types.ts
@@ -13,6 +13,7 @@ export interface TranslationResult {
 
 export interface TranslationResultWrite extends TranslationResult {
   untranslatedCount: number
+  otherError?: boolean
 }
 
 export type TranslationMap <T extends TranslationResult = TranslationResult> = Record<Language, Record<Namespace, T & { filePath: string}>>

diff --git a/tests/extract.spec.ts b/tests/extract.spec.ts
@@ -42,6 +42,7 @@ describe('i18nExtract', () => {
           key: 'Nested Key DE'
         }
       },
+      'invalid:nested:key': '__MISSING_TRANSLATION__',
       key_1: 'Key 1 DE',
       key_2: 'Key 2 DE',
       key_3: 'Key 3 DE',
@@ -60,6 +61,7 @@ describe('i18nExtract', () => {
           key: 'Nested Key EN'
         }
       },
+      'invalid:nested:key': '__MISSING_TRANSLATION__',
       key_1: 'Key 1 EN',
       key_2: 'Key 2 EN',
       key_3: 'Key 3 EN',

diff --git a/tests/parse.spec.ts b/tests/parse.spec.ts
@@ -28,6 +28,7 @@ describe('parseFiles', () => {
       'context.key_1',
       'context.key_2',
       'context.nested.key',
+      'invalid:nested:key',
       'key_1',
       'key_2',
       'key_3',
@@ -56,6 +57,7 @@ describe('parseFiles', () => {
       'new_key'
     ])
     expect(results.common).toStrictEqual([
+      'invalid:nested:key',
       'key_2'
     ])
     expect(results.other).toStrictEqual([
@@ -153,6 +155,7 @@ describe('parseFile', () => {
   it('should parse translations of typescript file', async () => {
     const filePath = path.join(__dirname, '../examples/namespaces/src/typescript-file.ts')
     expect(await parseFile(options, filePath)).toStrictEqual(new Set([
+      'common:invalid:nested:key',
       'key_1',
       'common:key_2',
       'other:key_1',