locale-ai 0.6.4 → 0.6.6

package/README.md

@@ -31,8 +31,8 @@ Download 577 MB? (Y/n)
 - **Layouts**: `locales/en/*.json` (nested folders too) → `locales/fr/...`, or `messages/en.json` → `messages/fr.json`. `.json`, `.yaml`, `.yml`, `.po` (gettext), `.arb` (Flutter) and `.strings` (Apple) are all supported, mixed freely in the same project. Common folders (`locales`, `src/locales`, `public/locales`, `src/i18n`, `messages`, `lang`, ...) are found automatically, or pass `--input`.
 - **Placeholders are never translated or lost**: `{name}`, `{{count}}`, `%s`, `%1$s`, `%(name)s`, `%{name}`, `${name}`, `:attribute`, `$t(key)`, `@:key`, `<b>…</b>`, `<0>…</0>`, `&nbsp;`, URLs, e-mails.
 - **ICU MessageFormat**: `{count, plural, one {# file} other {# files}}`, `select`, nesting. Only the text is translated.
-- **i18next plurals**: adds the forms the target language needs (`_few`, `_many` for Arabic, Russian, Polish...), so the app doesn't fall back to the English string — each added form copies the `_other` translation verbatim rather than inflecting it, so review and adjust the wording of `_zero`/`_two`/`_few`/`_many` by hand for languages where those forms use a different noun/adjective form.
-- **Incremental**: only missing keys are translated, existing translations are kept, re-runs are no-ops. `--overwrite` re-translates everything.
+- **i18next plurals**: adds the forms the target language needs (`_few`, `_many` for Arabic, Russian, Polish...), so the app doesn't fall back to the English string — each added form copies the `_other` translation verbatim rather than inflecting it, so review and adjust the wording of `_zero`/`_two`/`_few`/`_many` by hand for languages where those forms use a different noun/adjective form. The `_one` form is translated with its `{{count}}` temporarily replaced by a literal "1", since the model otherwise sometimes picks the target's plural noun form despite the English source being grammatically singular.
+- **Incremental, and edit-aware**: only missing or changed keys are translated; untouched translations are kept, so re-runs are no-ops. A small `locale-ai.lock.json` (commit it, like a package lock) remembers a hash of each source string and of the output last written for it per target locale — so editing a source string gets it re-translated automatically (it isn't enough for the target to already hold *some* text), while editing a target string by hand is detected and reported for review instead of being silently overwritten on the next run. `--overwrite` bypasses the lock and re-translates everything.
 - **Structure**: key order, numbers, booleans, arrays, indentation and trailing newline are preserved.
 
 **Format notes**: for `.po`, `msgid` is the stable key (never changed) and `msgstr` is the translated value, as gettext expects — the English `.po` file's `msgstr` must hold the source text (most generators already fill it; an empty `msgstr` is treated as empty, not inherited from `msgid`). `msgid_plural`/`msgstr[n]` plural entries are translated too (the singular and plural source forms), then expanded to however many `msgstr[n]` the target language's plural rules need (6 for Arabic, 1 for Japanese, ...) — not full grammatical inflection for in-between categories (`few`/`many`/...), which get the plural-sourced translation verbatim, the same simplification `addPluralForms` makes for i18next. `Plural-Forms` in the header is computed for the target language, not copied from the source; an existing target file's header is otherwise left as you last edited it (a hand-fixed `Plural-Forms`, `Last-Translator`, ...) instead of being regenerated on every rerun. For `.arb`, `@key` metadata and `@@locale` are never translated; `@@locale` is set to the target locale on output.
@@ -41,7 +41,7 @@ Download 577 MB? (Y/n)
 
 - **No API keys, no cloud bill.** Google/DeepL/OpenAI-based translation tools work well but mean an account, a key, a per-character cost, and your strings leaving your machine. locale-ai runs the model on your own CPU.
 - **Built for i18n files, not plain text.** General MT tools translate strings; they don't know that `{count}`, `<0>bold</0>`, or `$t(common.footer.tagline)` must survive untouched. locale-ai is built around i18next/ICU conventions specifically, so placeholders, plurals, and nested references come out intact instead of mangled or dropped.
-- **Incremental by default.** Add one new key to `en.json` and only that key gets translated — existing translations in `fr.json`/`es.json`/etc. are left alone, so re-runs are cheap and safe to automate in CI.
+- **Incremental by default.** Add one new key to `en.json` and only that key gets translated; edit an existing one and the lockfile catches it and re-translates just that key — existing, unrelated translations are left alone, so re-runs are cheap and safe to automate in CI.
 - **Honest about quality.** The [Languages](#languages) section tells you which pairs are review-light vs. which need a human pass, instead of presenting every language as equally production-ready.
 
 **When *not* to use it**: if you need professional/legal-grade translation, or languages outside the [supported list](#languages), use a human translator or a larger cloud model instead — locale-ai is built for keeping UI strings in sync across languages during development, with a review pass before shipping.
@@ -69,6 +69,7 @@ Models are cached once per machine in `~/.cache/locale-ai` (`LOCALE_AI_CACHE` to
 ```json
 {
   "doNotTranslate": ["Acme", "Acme Pro"],
+  "doNotTranslateKeys": ["brand.name", "config.statusEnum"],
   "glossary": {
     "fr": { "Workspace": "Espace de travail" },
     "de": { "Sign in": "Einloggen" }
@@ -78,6 +79,8 @@ Models are cached once per machine in `~/.cache/locale-ai` (`LOCALE_AI_CACHE` to
 
 `glossary` entries replace whole strings. `models` adds your own translation models (next section). A built-in glossary covers ~60 standard UI labels ("Sign in", "Settings", "Log out", ...) for fr, es, de, it, pt-BR, nl and ar, because one-to-three word labels are where sentence-level MT is weakest.
 
+`doNotTranslate` protects a term everywhere it appears in any string. `doNotTranslateKeys` instead protects a key path (dot/`[i]` notation, e.g. `brand.name`, `items[0]`) — the whole value at that path, and everything nested under it if it's an object or array, is copied to every target verbatim. Use it for an enum array (`"statusEnum": ["ACTIVE", "PENDING"]`, which you'd otherwise have to list value-by-value in `doNotTranslate`) or a field a model might respell or inflect even when the word is listed in `doNotTranslate` elsewhere in the same string.
+
 ## Add a language, or a better model
 
 Any [MarianMT / OPUS-MT](https://huggingface.co/Helsinki-NLP) model on Hugging Face can be used. Convert it once (needs Python):

package/dist/cli.js

@@ -9,7 +9,8 @@ import { CATALOG, customEntries, findById, reachableTargets, resolveRoute, } fro
 import { translateStrings } from "./engine.js";
 import { CONFIG_FILE, glossaryLookup, loadConfig, protectRegex } from "./glossary.js";
 import { intlCode, parseLocale } from "./lang.js";
-import { addPluralForms, buildTarget, detectLayout, existingTargets, flattenStrings, pendingStrings, readLocaleDoc, sourceFiles, targetFile, } from "./locales.js";
+import { editedPaths, isSourceStale, LOCK_FILENAME, loadLock, recordEntries, saveLock } from "./lock.js";
+import { addPluralForms, buildTarget, detectLayout, existingTargets, flattenStrings, keyPathProtect, pendingStrings, pluralOneStrings, readLocaleDoc, sourceFiles, targetFile, } from "./locales.js";
 import { cacheRoot, install, isInstalled, loadTranslator, localModelProblem, planInstall, readManifest, uninstall, } from "./models.js";
 import { mask } from "./placeholders.js";
 /** Read from package.json so `npm version` is the single source of truth. */
@@ -54,6 +55,8 @@ const endStatus = () => {
 };
 const mb = (bytes) => `${Math.round(bytes / 1e6)} MB`;
 const rel = (p) => path.relative(process.cwd(), p) || ".";
+/** Portable lock-file key: forward slashes regardless of platform. */
+const fileKey = (p) => rel(p).split(path.sep).join("/");
 /**
  * `Number("abc")` is NaN, and NaN silently poisons everything downstream (an
  * all-garbage translation batch, or a raw ONNX crash deep in the model) instead of
@@ -158,8 +161,12 @@ async function cmdTranslate(argv) {
     const config = loadConfig(process.cwd(), values.config);
     const catalog = catalogFor(config);
     const protect = protectRegex(config);
+    const isProtectedKey = keyPathProtect(config.doNotTranslateKeys);
     const layout = detectLayout(process.cwd(), from.tag, values.input);
+    const lockPath = path.resolve(process.cwd(), LOCK_FILENAME);
+    const lock = loadLock(lockPath);
     const sources = sourceFiles(layout, from.tag).map((f) => ({ file: f, doc: readLocaleDoc(f, from.tag) }));
+    const singularHints = new Set(sources.flatMap(({ doc }) => [...pluralOneStrings(doc.data)]));
     log(`locale-ai ${VERSION}`);
     log(`Found ${sources.length} ${from.tag} file${sources.length === 1 ? "" : "s"} in ${rel(layout.root)}/` +
         (layout.kind === "dir" ? `${from.tag}/` : ""));
@@ -177,7 +184,14 @@ async function cmdTranslate(argv) {
         const files = sources.map(({ file, doc }) => {
             const target = targetFile(layout, from.tag, locale.tag, file);
             const existing = fs.existsSync(target) ? readLocaleDoc(target, locale.tag).data : undefined;
-            return { source: file, target, doc, existing, pending: pendingStrings(doc.data, existing, values.overwrite) };
+            const isStale = (p, s) => isSourceStale(lock, fileKey(file), p, s);
+            return {
+                source: file,
+                target,
+                doc,
+                existing,
+                pending: pendingStrings(doc.data, existing, values.overwrite, isProtectedKey, isStale),
+            };
         });
         const unique = new Set(files.flatMap((f) => f.pending)).size;
         jobs.push({ locale, route, files, unique });
@@ -219,6 +233,7 @@ async function cmdTranslate(argv) {
                 batchSize,
                 protect,
                 lookup: glossaryLookup(from, job.locale, config),
+                singularHints,
                 onProgress: makeProgress((d, t) => `${job.locale.tag}: translating ${bar(d, t)} ${d}/${t}`),
             });
             endStatus();
@@ -235,7 +250,14 @@ async function cmdTranslate(argv) {
         let written = 0;
         let pluralsAdded = 0;
         for (const f of job.files) {
-            const built = buildTarget(f.doc.data, f.existing, (s) => translations.get(s) ?? s, values.overwrite);
+            const lockKey = fileKey(f.source);
+            const isStale = (p, s) => isSourceStale(lock, lockKey, p, s);
+            if (f.existing !== undefined) {
+                for (const editedPath of editedPaths(lock, lockKey, job.locale.tag, flattenStrings(f.existing))) {
+                    allIssues.push({ source: editedPath, kind: "edited", locale: job.locale.tag });
+                }
+            }
+            const built = buildTarget(f.doc.data, f.existing, (s) => translations.get(s) ?? s, values.overwrite, isProtectedKey, isStale);
             const { doc, added } = addPluralForms(built, intlCode(job.locale));
             pluralsAdded += added;
             const before = fs.existsSync(f.target) ? fs.readFileSync(f.target, "utf8") : undefined;
@@ -245,6 +267,8 @@ async function cmdTranslate(argv) {
                 fs.writeFileSync(f.target, text);
                 written++;
             }
+            const outFlat = new Map(flattenStrings(doc).map((e) => [e.path, e.value]));
+            recordEntries(lock, lockKey, job.locale.tag, flattenStrings(f.doc.data).map(({ path: p, value }) => ({ path: p, source: value, written: outFlat.get(p) ?? "" })));
         }
         const secs = ((Date.now() - started) / 1000).toFixed(1);
         const issues = allIssues.filter((i) => i.locale === job.locale.tag).length;
@@ -255,6 +279,8 @@ async function cmdTranslate(argv) {
     }
     for (const t of loaded.values())
         await t.dispose();
+    if (jobs.length)
+        saveLock(lockPath, lock);
     if (allIssues.length) {
         log();
         log(`${allIssues.length} string${allIssues.length === 1 ? "" : "s"} worth a quick review:`);

package/dist/engine.js

@@ -208,6 +208,36 @@ async function splitFallback(units, hops, opts, progress, issues) {
         issues.push({ source: unit.owner, kind: "placeholder-fallback", output: unit.result });
     }
 }
+const COUNT_PLACEHOLDER = /\{\{\s*count\s*\}\}/;
+/**
+ * A "_one" key's source is grammatically singular ("You have {{count}} file"), but the
+ * masked marker that stands in for {{count}} carries no number of its own, so the model
+ * sometimes still produces the target's PLURAL noun form (confirmed: en→fr "fileCount_one"
+ * came back "Vous avez {{count}} fichiers"). Retranslating with a literal "1" in place of
+ * {{count}} gives the model the real grammatical cue; only applied when {{count}} is the
+ * string's only placeholder (anything else needs the normal masking pipeline to survive),
+ * and only kept when the "1" survives translation intact enough to restore {{count}}.
+ */
+async function fixSingularGrammar(translations, singularHints, remaining, hops, opts, progress) {
+    for (const s of singularHints) {
+        if (!remaining.has(s) || translations.get(s) === undefined)
+            continue;
+        const tokens = mask(s, "natural").tokens;
+        if (tokens.length !== 1 || !COUNT_PLACEHOLDER.test(tokens[0]))
+            continue;
+        const m = COUNT_PLACEHOLDER.exec(s);
+        const pinned = s.slice(0, m.index) + "1" + s.slice(m.index + m[0].length);
+        const prepared = prepare(pinned);
+        const out = (await runModels(new Set([prepared]), hops, opts, progress)).get(prepared) ?? "";
+        if (isDegenerate(pinned, out))
+            continue;
+        const post = postprocess(pinned, out, opts.targetLang);
+        const restored = /(?<![\d.])1(?![\d.])/.exec(post);
+        if (!restored)
+            continue; // can't confirm the "1" survived: keep the original translation
+        translations.set(s, post.slice(0, restored.index) + m[0] + post.slice(restored.index + 1));
+    }
+}
 export async function translateStrings(strings, hops, opts) {
     const issues = [];
     const progress = { done: 0, total: 0 };
@@ -236,5 +266,7 @@ export async function translateStrings(strings, hops, opts) {
         const parts = p.units.map((u) => u.result ?? u.text);
         translations.set(p.source, p.split ? p.split.rebuild(parts) : parts[0]);
     }
+    if (opts.singularHints?.size)
+        await fixSingularGrammar(translations, opts.singularHints, new Set(remaining), hops, opts, progress);
     return { translations, issues };
 }

package/dist/glossary.js

@@ -84,6 +84,8 @@ export function loadConfig(cwd, file) {
         const cfg = JSON.parse(fs.readFileSync(p, "utf8"));
         if (cfg.doNotTranslate && !Array.isArray(cfg.doNotTranslate))
             throw new Error('"doNotTranslate" must be an array');
+        if (cfg.doNotTranslateKeys && !Array.isArray(cfg.doNotTranslateKeys))
+            throw new Error('"doNotTranslateKeys" must be an array');
         if (cfg.models && !Array.isArray(cfg.models))
             throw new Error('"models" must be an array');
         return { ...cfg, dir: path.dirname(p) };

package/dist/locales.js

@@ -448,47 +448,96 @@ export function flattenStrings(data, prefix = "", out = []) {
             flattenStrings(data[k], prefix ? `${prefix}.${k}` : k, out);
     return out;
 }
-export function pendingStrings(source, existing, overwrite, out = []) {
-    if (typeof source === "string") {
-        if (needsTranslation(existing, overwrite))
-            out.push(source);
-    }
-    else if (Array.isArray(source)) {
-        source.forEach((v, i) => pendingStrings(v, Array.isArray(existing) ? existing[i] : undefined, overwrite, out));
-    }
-    else if (isObj(source)) {
-        for (const k of Object.keys(source))
-            pendingStrings(source[k], isObj(existing) ? existing[k] : undefined, overwrite, out);
-    }
+/**
+ * True when `path` is, or is nested under, one of `doNotTranslateKeys` — the same
+ * dot/`[i]` notation flattenStrings produces (e.g. "brand.name", "config.statusEnum").
+ * Protecting a path that points at an object or array protects every string nested
+ * under it too, which is what makes an enum array ("statusEnum": ["ACTIVE", ...])
+ * protectable without enumerating each value as a doNotTranslate term.
+ */
+export function keyPathProtect(doNotTranslateKeys) {
+    const keys = (doNotTranslateKeys ?? []).filter(Boolean);
+    if (!keys.length)
+        return undefined;
+    return (path) => keys.some((k) => path === k || path.startsWith(`${k}.`) || path.startsWith(`${k}[`));
+}
+export function pendingStrings(source, existing, overwrite, isProtected, isStale) {
+    const out = [];
+    const visit = (s, e, path) => {
+        if (typeof s === "string") {
+            if (!isProtected?.(path) && (needsTranslation(e, overwrite) || !!isStale?.(path, s)))
+                out.push(s);
+        }
+        else if (Array.isArray(s)) {
+            s.forEach((v, i) => visit(v, Array.isArray(e) ? e[i] : undefined, `${path}[${i}]`));
+        }
+        else if (isObj(s)) {
+            for (const k of Object.keys(s))
+                visit(s[k], isObj(e) ? e[k] : undefined, path ? `${path}.${k}` : k);
+        }
+    };
+    visit(source, existing, "");
     return out;
 }
 /**
  * Builds the target document: source structure and key order, existing
- * translations kept (unless overwrite), new strings from `translate`, and keys
- * that only exist in the target preserved at the end.
+ * translations kept (unless overwrite or stale), new strings from `translate`,
+ * and keys that only exist in the target preserved at the end. A string at a
+ * protected path (see keyPathProtect) is always copied from the source
+ * verbatim. `isStale` (see the lock module) forces re-translation of a
+ * non-empty target when its source string has changed since it was last
+ * translated.
  */
-export function buildTarget(source, existing, translate, overwrite) {
-    if (typeof source === "string") {
-        return needsTranslation(existing, overwrite) ? translate(source) : existing;
-    }
-    if (Array.isArray(source)) {
-        return source.map((v, i) => buildTarget(v, Array.isArray(existing) ? existing[i] : undefined, translate, overwrite));
-    }
-    if (isObj(source)) {
-        const out = newObj();
-        for (const k of Object.keys(source)) {
-            out[k] = buildTarget(source[k], isObj(existing) ? existing[k] : undefined, translate, overwrite);
+export function buildTarget(source, existing, translate, overwrite, isProtected, isStale) {
+    const visit = (s, e, path) => {
+        if (typeof s === "string") {
+            if (isProtected?.(path))
+                return s;
+            return needsTranslation(e, overwrite) || isStale?.(path, s) ? translate(s) : e;
         }
-        if (isObj(existing))
-            for (const k of Object.keys(existing))
-                if (!(k in out))
-                    out[k] = existing[k];
-        return out;
-    }
-    return source;
+        if (Array.isArray(s))
+            return s.map((v, i) => visit(v, Array.isArray(e) ? e[i] : undefined, `${path}[${i}]`));
+        if (isObj(s)) {
+            const out = newObj();
+            for (const k of Object.keys(s))
+                out[k] = visit(s[k], isObj(e) ? e[k] : undefined, path ? `${path}.${k}` : k);
+            if (isObj(e))
+                for (const k of Object.keys(e))
+                    if (!(k in out))
+                        out[k] = e[k];
+            return out;
+        }
+        return s;
+    };
+    return visit(source, existing, "");
 }
 const CATEGORIES = ["zero", "one", "two", "few", "many", "other"];
 const PLURAL_KEY = /^(.+?)(_ordinal)?_(zero|one|two|few|many|other)$/;
+/**
+ * Source strings at a cardinal i18next "_one" plural key ("itemCount_one": "{{count}}
+ * item"). These are grammatically singular in English, but the model sometimes infers
+ * the TARGET's plural form anyway because {{count}} reads as an opaque marker rather
+ * than a concrete number — the engine uses this set to retranslate with a real "1" in
+ * place of {{count}} and recover the correct grammatical number (see engine.ts).
+ */
+export function pluralOneStrings(data, out = new Set()) {
+    const visit = (v) => {
+        if (Array.isArray(v)) {
+            v.forEach(visit);
+            return;
+        }
+        if (!isObj(v))
+            return;
+        for (const k of Object.keys(v)) {
+            const m = PLURAL_KEY.exec(k);
+            if (m && !m[2] && m[3] === "one" && typeof v[k] === "string")
+                out.add(v[k]);
+            visit(v[k]);
+        }
+    };
+    visit(data);
+    return out;
+}
 /**
  * i18next stores plurals as `key_one` / `key_other`. Languages such as Arabic,
  * Russian or Polish need more forms (`_few`, `_many` ...) and i18next does not fall

package/dist/lock.js

@@ -0,0 +1,56 @@
+import crypto from "node:crypto";
+import fs from "node:fs";
+export const LOCK_FILENAME = "locale-ai.lock.json";
+export function hashOf(s) {
+    return crypto.createHash("sha256").update(s, "utf8").digest("hex").slice(0, 16);
+}
+export function loadLock(file) {
+    try {
+        const parsed = JSON.parse(fs.readFileSync(file, "utf8"));
+        if (parsed && typeof parsed === "object" && parsed.files)
+            return { version: 1, files: parsed.files };
+    }
+    catch {
+        // Missing or invalid: start fresh rather than fail the run.
+    }
+    return { version: 1, files: {} };
+}
+export function saveLock(file, lock) {
+    fs.writeFileSync(file, `${JSON.stringify(lock, null, 2)}\n`);
+}
+/**
+ * True when `path`'s source string in `fileKey` has changed since it was last
+ * translated — meaning the existing target text is stale and needs redoing
+ * even though it's non-empty. False for a path the lock has never seen (new
+ * adoption, or a brand-new key, both already handled by the empty-target check).
+ */
+export function isSourceStale(lock, fileKey, path, source) {
+    const entry = lock.files[fileKey]?.[path];
+    return entry !== undefined && entry.source !== hashOf(source);
+}
+/**
+ * Key paths whose existing target text no longer matches the output this tool
+ * last wrote there for `targetTag` — i.e. a translator edited it since. Only
+ * reported; the edit is never overwritten.
+ */
+export function editedPaths(lock, fileKey, targetTag, entries) {
+    const file = lock.files[fileKey];
+    if (!file)
+        return [];
+    const out = [];
+    for (const { path, value } of entries) {
+        const mt = file[path]?.mt[targetTag];
+        if (mt !== undefined && mt !== hashOf(value))
+            out.push(path);
+    }
+    return out;
+}
+/** Records, for every path translated this run, the current source hash and the hash of what ended up on disk. */
+export function recordEntries(lock, fileKey, targetTag, entries) {
+    const file = (lock.files[fileKey] ??= {});
+    for (const { path, source, written } of entries) {
+        const entry = (file[path] ??= { source: hashOf(source), mt: {} });
+        entry.source = hashOf(source);
+        entry.mt[targetTag] = hashOf(written);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "locale-ai",
-  "version": "0.6.4",
+  "version": "0.6.6",
   "description": "Translate your i18n locale files locally on CPU. Free, offline, no API keys.",
   "author": "Taha KHABOUSS",
   "repository": {