feat: add ignored keys support for json, json5, jsonc, mdx, xcode-xcs… (#1227)

vrcprl · web-flow · commit 74d8efef8d47 · 2025-10-16T15:23:09.000-07:00
* feat: add ignored keys support for json, json5, jsonc, mdx, xcode-xcstrings, yaml, json-dictionary

* chore: add changeset
diff --git a/.changeset/sour-bulldogs-applaud.md b/.changeset/sour-bulldogs-applaud.md
@@ -0,0 +1,5 @@
+---
+"lingo.dev": patch
+---
+
+Add ignoredKeys support
diff --git a/packages/cli/demo/json/en/example.json b/packages/cli/demo/json/en/example.json
@@ -31,5 +31,7 @@
       "nested_message": "Nested text"
     }
   ],
-  "locked_key_1": "This value is locked and should not be changed"
+  "locked_key_1": "This value is locked and should not be changed",
+  "ignored_key_1": "This value is ignored and should not appear in target locales"
+
 }
diff --git a/packages/cli/demo/jsonc/en/example.jsonc b/packages/cli/demo/jsonc/en/example.jsonc
@@ -16,4 +16,6 @@
   },
   // This key is locked and should not be changed
   "locked_key_1": "This value is locked and should not be changed",
+  // This key is ignored and should be removed from target locales
+  "ignored_key_1": "This value is ignored and should not appear in target locales",
 }
diff --git a/packages/cli/demo/mdx/en/example.mdx b/packages/cli/demo/mdx/en/example.mdx
@@ -4,6 +4,8 @@ description: "Our dining experience at the new Italian restaurant downtown"
 author: "not-localized-author"
 published: "2024-03-15"
 rating: 4.5
+locked_key_1: "This value should remain unchanged in all locales"
+ignored_key_1: "This field should not appear in target locales"
 ---
 
 # Dinner at Bella Vista
@@ -59,9 +61,3 @@ Our server checked on us regularly, maintaining `service.quality = "excellent"`
 |--------|--------|
 | Appetizers | `stars(4)` |
 | Main dishes | `stars(5)` |
-
-## locked_key_1
-
-This heading is locked and should not be changed.
-
-pattern_1: This paragraph matches the locked pattern and should not be changed.
diff --git a/packages/cli/demo/mdx/es/example.mdx b/packages/cli/demo/mdx/es/example.mdx
@@ -4,6 +4,7 @@ description: Nuestra experiencia gastronómica en el nuevo restaurante italiano
 author: not-localized-author
 published: 2024-03-15
 rating: 4.5
+locked_key_1: This value should remain unchanged in all locales
 ---
 
 # Cena en Bella Vista
@@ -22,9 +23,9 @@ El restaurante tiene un ambiente cálido y acogedor con:
 
 [Reserva tu mesa en línea](https://example.com) o llama durante el horario comercial.
 
-> Consejo: Las reservas de fin de semana se llenan rápidamente, ¡así que reserva con anticipación!
+> Consejo: Las reservas de fin de semana se agotan rápidamente, ¡así que reserva con anticipación!
 
-## Altas luces del menú
+## Destacados del menú
 
 ```javascript
 // Restaurant website code - not localized
@@ -45,7 +46,7 @@ function displayMenu(category) {
 
 Comenzamos con la tabla de antipasto y la ensalada de la casa.
 
-La pasta estaba cocinada perfectamente - exactamente `al_dente` como debería ser.
+La pasta estaba cocinada perfectamente - exactamente `al_dente` como debe ser.
 
 ## Calidad del servicio
 
@@ -59,9 +60,3 @@ Nuestro camarero nos atendió regularmente, manteniendo `service.quality = "exce
 | ------------------ | ------------ |
 | Entrantes          | `stars(4)`   |
 | Platos principales | `stars(5)`   |
-
-## locked_key_1
-
-This heading is locked and should not be changed.
-
-pattern_1: This paragraph matches the locked pattern and should not be changed.
diff --git a/packages/cli/demo/xcode-xcstrings/example.xcstrings b/packages/cli/demo/xcode-xcstrings/example.xcstrings
@@ -41,30 +41,6 @@
               }
             }
           }
-        },
-        "es" : {
-          "variations" : {
-            "plural" : {
-              "one" : {
-                "stringUnit" : {
-                  "state" : "translated",
-                  "value" : "1 artículo"
-                }
-              },
-              "other" : {
-                "stringUnit" : {
-                  "state" : "translated",
-                  "value" : "%d artículos"
-                }
-              },
-              "zero" : {
-                "stringUnit" : {
-                  "state" : "translated",
-                  "value" : "Sin artículos"
-                }
-              }
-            }
-          }
         }
       }
     },
@@ -81,7 +57,7 @@
         "es" : {
           "stringUnit" : {
             "state" : "translated",
-            "value" : "¡Hola, mundo!"
+            "value" : "Hello, world!"
           }
         }
       }
diff --git a/packages/cli/demo/yaml/en/example.yml b/packages/cli/demo/yaml/en/example.yml
@@ -27,4 +27,5 @@ complex_structure:
   level_one:
     level_two:
       message: "Deep nested text"
-locked_key_1: "This value is locked and should not be changed"
+locked_key_1: "This value is locked and should not be changed"
+ignored_key_1: "This value is ignored and should not appear in target locales"
diff --git a/packages/cli/i18n.json b/packages/cli/i18n.json
@@ -21,17 +21,23 @@
       "include": ["demo/html/[locale]/*.html"]
     },
     "json": {
-      "include": ["demo/json/[locale]/*.json"]
+      "include": ["demo/json/[locale]/*.json"],
+      "lockedKeys": ["locked_key_1"],
+      "ignoredKeys": ["ignored_key_1"]
     },
     "jsonc": {
-      "include": ["demo/jsonc/[locale]/*.jsonc"]
+      "include": ["demo/jsonc/[locale]/*.jsonc"],
+      "lockedKeys": ["locked_key_1"],
+      "ignoredKeys": ["ignored_key_1"]
     },
     "markdown": {
       "include": ["demo/markdown/[locale]/*.md"],
       "exclude": ["demo/markdown/[locale]/ignored.md"]
     },
     "mdx": {
-      "include": ["demo/mdx/[locale]/*.mdx"]
+      "include": ["demo/mdx/[locale]/*.mdx"],
+      "lockedKeys": ["meta/locked_key_1"],
+      "ignoredKeys": ["meta/ignored_key_1"]
     },
     "po": {
       "include": ["demo/po/[locale]/*.po"]
@@ -40,7 +46,9 @@
       "include": ["demo/properties/[locale]/*.properties"]
     },
     "typescript": {
-      "include": ["demo/typescript/[locale]/*.ts"]
+      "include": ["demo/typescript/[locale]/*.ts"],
+      "lockedKeys": ["forms/locked_key_1"],
+      "ignoredKeys": ["forms/ignored_key_1"]
     },
     "xcode-strings": {
       "include": ["demo/xcode-strings/[locale]/*.strings"]
@@ -49,10 +57,14 @@
       "include": ["demo/xcode-stringsdict/[locale]/*.stringsdict"]
     },
     "xcode-xcstrings": {
-      "include": ["demo/xcode-xcstrings/*.xcstrings"]
+      "include": ["demo/xcode-xcstrings/*.xcstrings"],
+      "lockedKeys": ["api_key"],
+      "ignoredKeys": ["item_count"]
     },
     "yaml": {
-      "include": ["demo/yaml/[locale]/*.yml"]
+      "include": ["demo/yaml/[locale]/*.yml"],
+      "lockedKeys": ["locked_key_1"],
+      "ignoredKeys": ["ignored_key_1"]
     },
     "yaml-root-key": {
       "include": ["demo/yaml-root-key/[locale]/*.yml"]
diff --git a/packages/cli/i18n.lock b/packages/cli/i18n.lock
@@ -378,7 +378,6 @@ checksums:
     key4: 10627fcc465897af0f5e1bba042685f9
     key5: b328c432cee108a87a92f05258b6a651
     key6/key7: 9da96ad1d5c544070ac5e268de77fb48
-    locked_key_1: 73fc105de1aefc3f0a97d187a80cf0a4
   1d941f3fcb422e74ccb8adb0f899afad:
     md-section-0: d53f61b8c8922fb62d9df5678d9b44a8
     md-section-1: 98aec271471bedce0e12b530c7060827
@@ -437,7 +436,6 @@ checksums:
     config/theme/primary: 7535a3779d6934ea8ecf18f5cb5b93fd
     mixed_array/0: 001b5b003d96c133534f5907abffdf77
     mixed_array/3/nested_message: 5f0782dfc5993e99890c0475bc295a30
-    locked_key_1: 73fc105de1aefc3f0a97d187a80cf0a4
   92012b8cd020f7be41f85bab88f5d251:
     welcome_message: 9c56d00796c3c7facba6a25275de5b7b
     login_button: 0029e5a35676c0051e761fcd046ef9ee
@@ -489,12 +487,7 @@ checksums:
     forms/messageLabel: 1e460d0909502d0e94b9be562643af0d
     forms/submitButton: 487177489aafc9c0243c57ef3850a2d9
     forms/successMessage: a0a7aa980dffa31d4d194af718a917b3
-    forms/locked_key_1: 73fc105de1aefc3f0a97d187a80cf0a4
-    forms/ignored_key_1: d88a7aa6c5661ca901ee0f4cb51e3a0d
   11b3ea8486d8e09d2bf06db1811e0490:
-    item_count/one: d25ee41f72a2ea94ebc6debc85b9e573
-    item_count/other: ecb3f18dc6a5e7b3e1d9afe7ef62cf07
-    item_count/zero: 955c31a42e9ff663a49e69e944c8c537
     welcome_message: 0468579ef2fbc83c9d520c2f2f1c5059
   ae4fae82257615e5c22b34de033c7eeb:
     welcome_message: 0468579ef2fbc83c9d520c2f2f1c5059
@@ -520,7 +513,6 @@ checksums:
     product/features/0: c916ba887951a02793ff851853fd964f
     product/features/1: 1c60a04d6890c6ec910a7f2e6ec0ae7b
     complex_structure/level_one/level_two/message: b53034560bf657106e5aaea9160e357e
-    locked_key_1: 73fc105de1aefc3f0a97d187a80cf0a4
   32707dfb19e6dfad9a1af32087b6f9f3:
     welcome_message/NSStringLocalizedFormatKey: f142738692c027d95dce521e7cb29c82
     welcome_message/user_count/NSStringFormatSpecTypeKey: 8cc03ef30ad5b2d8e27f3612627d932e
@@ -604,7 +596,4 @@ checksums:
     content/16: 14f593e7cf3b3df84a21e17db318912e
     content/17: 5f42d26a42aa29be063019eea27ad07c
     content/18: 48bb7e89e72d68d6de12f5cdac64fc18
-    content/19: 1639b9ef57bf363e04293e27d1c13952
-    content/20: bb1c8d22064f7af4879c69d444e6e769
-    content/21: 98dd186e756ea72c0bdb6e0fe2ae0cbd
   e6d8e00051ea40ca138a9549ed52e1c6: {}
diff --git a/packages/cli/src/cli/cmd/run/_types.ts b/packages/cli/src/cli/cmd/run/_types.ts
@@ -31,6 +31,7 @@ export type CmdRunTask = {
   injectLocale: string[];
   lockedKeys: string[];
   lockedPatterns: string[];
+  ignoredKeys: string[];
   onlyKeys: string[];
   formatter?: "prettier" | "biome";
 };
diff --git a/packages/cli/src/cli/cmd/run/execute.ts b/packages/cli/src/cli/cmd/run/execute.ts
@@ -140,6 +140,7 @@ function createLoaderForTask(assignedTask: CmdRunTask) {
     },
     assignedTask.lockedKeys,
     assignedTask.lockedPatterns,
+    assignedTask.ignoredKeys,
   );
   bucketLoader.setDefaultLocale(assignedTask.sourceLocale);
 
diff --git a/packages/cli/src/cli/cmd/run/frozen.ts b/packages/cli/src/cli/cmd/run/frozen.ts
@@ -101,6 +101,8 @@ export default async function frozen(input: CmdRunContext) {
                   injectLocale: bucket.injectLocale,
                 },
                 bucket.lockedKeys,
+                bucket.lockedPatterns,
+                bucket.ignoredKeys,
               );
               loader.setDefaultLocale(resolvedSourceLocale);
               await loader.init();
diff --git a/packages/cli/src/cli/cmd/run/plan.ts b/packages/cli/src/cli/cmd/run/plan.ts
@@ -132,6 +132,7 @@ export default async function plan(
                   injectLocale: bucket.injectLocale || [],
                   lockedKeys: bucket.lockedKeys || [],
                   lockedPatterns: bucket.lockedPatterns || [],
+                  ignoredKeys: bucket.ignoredKeys || [],
                   onlyKeys: input.flags.key || [],
                   formatter: input.config!.formatter,
                 });
diff --git a/packages/cli/src/cli/loaders/ignored-keys.spec.ts b/packages/cli/src/cli/loaders/ignored-keys.spec.ts
@@ -51,7 +51,7 @@ describe("ignored-keys loader", () => {
     expect(result).toEqual({ greeting: "hola" });
   });
 
-  it("should merge the ignored keys back when pushing a target locale", async () => {
+  it("should remove ignored keys when pushing a target locale", async () => {
     const loader = createLoader();
 
     // Initial pull for the default locale
@@ -69,18 +69,18 @@ describe("ignored-keys loader", () => {
     };
     await loader.pull(targetLocale, targetInput);
 
-    // Data that will be pushed (ignored keys are intentionally missing)
+    // Data that will be pushed (may still contain ignored keys from translation)
     const dataToPush = {
       greeting: "hola",
+      meta: "should be removed",
+      todo: "should be removed",
     };
 
     const pushResult = await loader.push(targetLocale, dataToPush);
 
-    // The loader should have re-inserted the ignored keys from the pull input.
+    // The loader should have removed the ignored keys completely.
     expect(pushResult).toEqual({
       greeting: "hola",
-      meta: "meta es",
-      todo: "todo es",
     });
   });
 
@@ -138,7 +138,7 @@ describe("ignored-keys loader", () => {
     });
   });
 
-  it("should merge wildcard-ignored keys back when pushing a target locale", async () => {
+  it("should remove wildcard-ignored keys when pushing a target locale", async () => {
     const loader = createLoader();
     await loader.pull(defaultLocale, {
       greeting: "hello",
@@ -162,18 +162,18 @@ describe("ignored-keys loader", () => {
     });
     const dataToPush = {
       greeting: "hola",
+      meta: "should be removed",
+      "pages/0/title": "should be removed",
       "pages/0/content": "Contenido Nuveo",
+      "pages/foo/title": "should be removed",
       "pages/foo/content": "Contenido Nuevo Foo",
       "pages/bar/notitle": "No Título",
       "pages/bar/content": "Contenido Nuevo Bar",
     };
     const pushResult = await loader.push(targetLocale, dataToPush);
     expect(pushResult).toEqual({
       greeting: "hola",
-      meta: "meta es",
-      "pages/0/title": "Título 0",
       "pages/0/content": "Contenido Nuveo",
-      "pages/foo/title": "Título Foo",
       "pages/foo/content": "Contenido Nuevo Foo",
       "pages/bar/notitle": "No Título",
       "pages/bar/content": "Contenido Nuevo Bar",
diff --git a/packages/cli/src/cli/loaders/ignored-keys.ts b/packages/cli/src/cli/loaders/ignored-keys.ts
@@ -14,10 +14,10 @@ export default function createIgnoredKeysLoader(
       return result;
     },
     push: async (locale, data, originalInput, originalLocale, pullInput) => {
-      const ignoredSubObject = _.pickBy(pullInput, (value, key) =>
+      // Remove ignored keys from the data being pushed
+      const result = _.omitBy(data, (value, key) =>
         matchesKeyPattern(key, ignoredKeys),
       );
-      const result = _.merge({}, data, ignoredSubObject);
       return result;
     },
   });
diff --git a/packages/cli/src/cli/loaders/index.spec.ts b/packages/cli/src/cli/loaders/index.spec.ts
diff --git a/packages/cli/src/cli/loaders/index.ts b/packages/cli/src/cli/loaders/index.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"lingo.dev": patch
 +---
++
 +Add ignoredKeys support
Original file line number	Diff line number	Diff line change
`@@ -31,5 +31,7 @@`
`31`	`31`	`"nested_message": "Nested text"`
`32`	`32`	`}`
`33`	`33`	`],`
`34`		`- "locked_key_1": "This value is locked and should not be changed"`
	`34`	`+ "locked_key_1": "This value is locked and should not be changed",`
	`35`	`+ "ignored_key_1": "This value is ignored and should not appear in target locales"`
	`36`	`+`
`35`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,4 +16,6 @@`
`16`	`16`	`},`
`17`	`17`	`// This key is locked and should not be changed`
`18`	`18`	`"locked_key_1": "This value is locked and should not be changed",`
	`19`	`+ // This key is ignored and should be removed from target locales`
	`20`	`+ "ignored_key_1": "This value is ignored and should not appear in target locales",`
`19`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,30 +41,6 @@`
`41`	`41`	`}`
`42`	`42`	`}`
`43`	`43`	`}`
`44`		`- },`
`45`		`- "es" : {`
`46`		`- "variations" : {`
`47`		`- "plural" : {`
`48`		`- "one" : {`
`49`		`- "stringUnit" : {`
`50`		`- "state" : "translated",`
`51`		`- "value" : "1 artículo"`
`52`		`- }`
`53`		`- },`
`54`		`- "other" : {`
`55`		`- "stringUnit" : {`
`56`		`- "state" : "translated",`
`57`		`- "value" : "%d artículos"`
`58`		`- }`
`59`		`- },`
`60`		`- "zero" : {`
`61`		`- "stringUnit" : {`
`62`		`- "state" : "translated",`
`63`		`- "value" : "Sin artículos"`
`64`		`- }`
`65`		`- }`
`66`		`- }`
`67`		`- }`
`68`	`44`	`}`
`69`	`45`	`}`
`70`	`46`	`},`
`@@ -81,7 +57,7 @@`
`81`	`57`	`"es" : {`
`82`	`58`	`"stringUnit" : {`
`83`	`59`	`"state" : "translated",`
`84`		`- "value" : "¡Hola, mundo!"`
	`60`	`+ "value" : "Hello, world!"`
`85`	`61`	`}`
`86`	`62`	`}`
`87`	`63`	`}`