feat: shoudTranslate

Author: maxprilutskiy

packages/cli/src/cli/loaders/index.spec.ts

@@ -1066,6 +1066,79 @@ user.password=Contraseña
         expect(spaceIdx).toBeLessThan(stringKeys.indexOf("apple"));
       }
     });
+
+    it("should respect shouldTranslate: false flag", async () => {
+      setupFileMocks();
+
+      // Create input with a key that has shouldTranslate: false
+      const input = `{
+  "sourceLanguage": "en",
+  "strings": {
+    "do_not_translate": {
+      "shouldTranslate": false,
+      "localizations": {
+        "en": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "This should not be translated"
+          }
+        }
+      }
+    },
+    "normal_key": {
+      "extractionState": "manual",
+      "localizations": {
+        "en": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "This should be translated"
+          }
+        }
+      }
+    }
+  }
+}`;
+
+      mockFileOperations(input);
+
+      const xcodeXcstringsLoader = createBucketLoader("xcode-xcstrings", "i18n/[locale].xcstrings", { isCacheRestore: false, defaultLocale: "en" });
+      xcodeXcstringsLoader.setDefaultLocale("en");
+      
+      // Pull data and verify that the shouldTranslate: false entry is skipped
+      const data = await xcodeXcstringsLoader.pull("en");
+      
+      expect(data).toHaveProperty("normal_key", "This should be translated");
+      expect(data).not.toHaveProperty("do_not_translate");
+      
+      // Now push a translation for the normal key
+      const payload = {
+        "normal_key": "Ceci devrait être traduit"
+      };
+      
+      await xcodeXcstringsLoader.push("fr", payload);
+      
+      expect(fs.writeFile).toHaveBeenCalled();
+      const writeFileCall = (fs.writeFile as any).mock.calls[0];
+      const writtenContent = JSON.parse(writeFileCall[1]);
+      
+      // Verify that the normal key was translated
+      expect(writtenContent.strings.normal_key.localizations.fr.stringUnit.value).toBe("Ceci devrait être traduit");
+      
+      // Verify that the do_not_translate key was preserved with its shouldTranslate: false flag
+      expect(writtenContent.strings.do_not_translate).toHaveProperty("shouldTranslate", false);
+      
+      // Check that the do_not_translate key has no localizations for the target language
+      expect(writtenContent.strings.do_not_translate.localizations).not.toHaveProperty("fr");
+      
+      // Now also test pushing with empty {} content to verify the flag is still preserved
+      await xcodeXcstringsLoader.push("fr", {});
+      
+      const secondWriteFileCall = (fs.writeFile as any).mock.calls[1];
+      const secondWrittenContent = JSON.parse(secondWriteFileCall[1]);
+      
+      // Verify the flag is still there
+      expect(secondWrittenContent.strings.do_not_translate).toHaveProperty("shouldTranslate", false);
+    });
   });
 
   describe("yaml bucket loader", () => {

packages/cli/src/cli/loaders/xcode-xcstrings.ts

@@ -10,6 +10,12 @@ export default function createXcodeXcstringsLoader(defaultLocale: string): ILoad
 
       for (const [translationKey, _translationEntity] of Object.entries((input as any).strings)) {
         const rootTranslationEntity = _translationEntity as any;
+        
+        // Skip translation keys marked with shouldTranslate: false
+        if (rootTranslationEntity.shouldTranslate === false) {
+          continue;
+        }
+        
         const langTranslationEntity = rootTranslationEntity?.localizations?.[locale];
 
         if (langTranslationEntity) {
@@ -42,8 +48,22 @@ export default function createXcodeXcstringsLoader(defaultLocale: string): ILoad
     async push(locale, payload, originalInput) {
       const langDataToMerge: any = {};
       langDataToMerge.strings = {};
-
+      
+      // Copy original input if it exists, or create a new structure
+      const input = _.cloneDeep(originalInput) || { sourceLanguage: locale, strings: {} };
+      
       for (const [key, value] of Object.entries(payload)) {
+        // Skip keys with null or undefined values
+        if (value === null || value === undefined) {
+          continue;
+        }
+        
+        // Check if this key has shouldTranslate: false in the original input
+        const hasDoNotTranslateFlag = originalInput && 
+                                     (originalInput as any).strings && 
+                                     (originalInput as any).strings[key] && 
+                                     (originalInput as any).strings[key].shouldTranslate === false;
+        
         if (typeof value === "string") {
           langDataToMerge.strings[key] = {
             extractionState: "manual",
@@ -56,6 +76,11 @@ export default function createXcodeXcstringsLoader(defaultLocale: string): ILoad
               },
             },
           };
+          
+          // Preserve shouldTranslate flag if it exists in the original input
+          if (hasDoNotTranslateFlag) {
+            langDataToMerge.strings[key].shouldTranslate = false;
+          }
         } else {
           const updatedVariations: any = {};
 
@@ -78,6 +103,11 @@ export default function createXcodeXcstringsLoader(defaultLocale: string): ILoad
               },
             },
           };
+          
+          // Preserve shouldTranslate flag if it exists in the original input
+          if (hasDoNotTranslateFlag) {
+            langDataToMerge.strings[key].shouldTranslate = false;
+          }
         }
       }