@radicalstorage-lingo/cli 0.3.0 → 0.4.0

package/README.md

@@ -52,6 +52,12 @@ npx lingo pull
 
   Untranslated (missing, empty) values are never written — a key is either
   pulled with real text or omitted entirely.
+- `split` — `none` (default): `{outDir}/{lang}.json`. `namespace`:
+  `{outDir}/{lang}/{namespace}.json` per top-level namespace, keys relative to
+  it, `_root.json` for keys without one (next-i18next's `public/locales`
+  layout).
+- `languageMap` — file/folder names instead of Lingo's codes, e.g.
+  `{ "zh-CN": "zh_cn", "pt-PT": "pt" }`.
 
 ## Commands
 

package/dist/cli.cjs

@@ -21067,6 +21067,31 @@ function getCodec(id) {
 }
 var FORMAT_LABELS = Object.fromEntries(codecs.map((c2) => [c2.id, c2.label]));
 
+// ../formats/src/util/bundle.ts
+var ROOT_NAMESPACE = "_root";
+function bundleMessages(rows, namespace) {
+  const out = {};
+  for (const row of rows) {
+    if (row.value.trim().length === 0) continue;
+    const path = row.namespacePath ?? null;
+    if (namespace === void 0) {
+      out[path ? `${path}.${row.key}` : row.key] = row.value;
+    } else if (namespace === ROOT_NAMESPACE) {
+      if (!path) out[row.key] = row.value;
+    } else if (path === namespace) {
+      out[row.key] = row.value;
+    } else if (path?.startsWith(`${namespace}.`)) {
+      out[`${path.slice(namespace.length + 1)}.${row.key}`] = row.value;
+    }
+  }
+  return out;
+}
+function topLevelNamespaces(rows) {
+  const names = /* @__PURE__ */ new Set();
+  for (const row of rows) names.add(row.namespacePath ? row.namespacePath.split(".")[0] : ROOT_NAMESPACE);
+  return [...names].sort();
+}
+
 // src/api.ts
 var import_node_fs = require("fs");
 var import_node_os = require("os");
@@ -25268,8 +25293,19 @@ var configSchema = external_exports.object({
   languages: external_exports.array(external_exports.string().min(2)).default([]),
   /** Format the pulled files are written in. */
   format: external_exports.enum(["json-nested", "json-flat"]).default("json-nested"),
-  /** Directory for pulled bundles (one file per language). */
+  /** Directory for pulled bundles. */
   outDir: external_exports.string().default("messages"),
+  /**
+   * File layout of `lingo pull`:
+   * - `none` (default): `{outDir}/{lang}.json`, every key under its full path;
+   * - `namespace`: `{outDir}/{lang}/{namespace}.json` per top-level namespace,
+   *   keys relative to it (`_root.json` for keys without one), the layout of
+   *   next-i18next's `public/locales` and i18next namespace loading. Same content
+   *   as the API's `/bundles/{lang}/{namespace}`.
+   */
+  split: external_exports.enum(["none", "namespace"]).default("none"),
+  /** Names to use for language files/folders instead of Lingo's codes, e.g. `{ "zh-CN": "zh_cn", "pt-PT": "pt" }`. */
+  languageMap: external_exports.record(external_exports.string()).default({}),
   /** Where the generated types module is written. */
   typesOut: external_exports.string().default(".lingo/types.ts"),
   /**
@@ -25289,7 +25325,7 @@ function parseConfig(raw) {
 }
 function bundlePath(config, language) {
   const ext = config.format === "json-flat" || config.format === "json-nested" ? ".json" : ".json";
-  return `${config.outDir}/${language}${ext}`;
+  return `${config.outDir}/${config.languageMap[language] ?? language}${ext}`;
 }
 function resolveOutDir(flagOut, config) {
   return flagOut ?? config.outDir;
@@ -26581,11 +26617,12 @@ async function runInitWizard(opts) {
       return;
     }
   }
+  const apiUrlDefault = opts.apiUrl ?? "http://localhost:3000";
   const apiUrl = orExit(
     await text({
       message: "API URL",
-      initialValue: opts.apiUrl ?? "http://localhost:3000",
-      validate: (v) => v?.trim() ? void 0 : "Required"
+      placeholder: apiUrlDefault,
+      defaultValue: apiUrlDefault
     })
   ).trim();
   const existingKey = resolveApiKey();
@@ -26633,9 +26670,10 @@ async function runInitWizard(opts) {
       })
     ).trim();
   }
+  const outDefault = opts.out ?? "messages";
   const outDir = orExit(
-    await text({ message: "Output directory for bundles", initialValue: opts.out ?? "messages" })
-  ).trim() || "messages";
+    await text({ message: "Output directory for bundles", placeholder: outDefault, defaultValue: outDefault })
+  ).trim();
   const format = orExit(
     await select({
       message: "Bundle format",
@@ -26681,6 +26719,31 @@ async function runInitWizard(opts) {
   );
 }
 
+// src/layout.ts
+function localLanguage(config, language) {
+  return config.languageMap[language] ?? language;
+}
+function bundleFiles(config, language, rows, namespaces = topLevelNamespaces(rows)) {
+  const lang = localLanguage(config, language);
+  if (config.split === "namespace") {
+    return namespaces.map((namespace) => ({
+      file: `${config.outDir}/${lang}/${namespace}.json`,
+      namespace,
+      messages: bundleMessages(rows, namespace)
+    }));
+  }
+  return [{ file: bundlePath(config, language), namespace: null, messages: bundleMessages(rows) }];
+}
+function joinNamespaceFiles(files) {
+  const out = {};
+  for (const { namespace, messages } of files) {
+    for (const [key, value] of Object.entries(messages)) {
+      out[namespace && namespace !== ROOT_NAMESPACE ? `${namespace}.${key}` : key] = value;
+    }
+  }
+  return out;
+}
+
 // src/messages.ts
 function fullKey(row) {
   return row.namespacePath ? `${row.namespacePath}.${row.key}` : row.key;
@@ -26716,12 +26779,21 @@ async function resolveProjectLanguages(api, config) {
   const project = await api.getProject(config.projectId);
   return resolveLanguages(config.languages, project);
 }
-function readLocalMap(config, language) {
-  const file = bundlePath(config, language);
-  if (!(0, import_node_fs4.existsSync)(file)) return {};
+function readBundleFile(config, file) {
   const resource = getCodec(config.format).parse((0, import_node_fs4.readFileSync)(file, "utf-8"));
   return Object.fromEntries(resource.messages.map((m) => [m.key, m.value]));
 }
+function readLocalMap(config, language) {
+  if (config.split === "namespace") {
+    const dir = `${config.outDir}/${localLanguage(config, language)}`;
+    if (!(0, import_node_fs4.existsSync)(dir)) return {};
+    return joinNamespaceFiles(
+      (0, import_node_fs4.readdirSync)(dir).filter((f) => f.endsWith(".json")).map((f) => ({ namespace: (0, import_node_path3.basename)(f, ".json"), messages: readBundleFile(config, `${dir}/${f}`) }))
+    );
+  }
+  const file = bundlePath(config, language);
+  return (0, import_node_fs4.existsSync)(file) ? readBundleFile(config, file) : {};
+}
 async function readRemoteMap(api, config, language, status) {
   const rows = await api.listTranslations(config.projectId, language, status);
   return Object.fromEntries(rowsToMessages(rows).map((m) => [m.key, m.value]));
@@ -26791,19 +26863,25 @@ async function pullCommand(opts = {}) {
   if (cfg.languages.length === 0) {
     console.log(import_picocolors.default.dim(`\u2192 pulling all project languages: ${languages.join(", ")}`));
   }
+  const fetched = [];
   for (const language of languages) {
-    const rows = await api.listTranslations(
-      cfg.projectId,
-      language,
-      cfg.pull === "approved" ? "approved" : void 0
-    );
+    const status = cfg.pull === "approved" ? "approved" : void 0;
+    fetched.push({ language, rows: await api.listTranslations(cfg.projectId, language, status) });
+  }
+  const namespaces = [...new Set(fetched.flatMap((f) => topLevelNamespaces(f.rows)))].sort();
+  for (const { language, rows } of fetched) {
     const messages = rowsToMessages(rows);
     const skipped = rows.length - messages.length;
-    const file = bundlePath(cfg, language);
-    (0, import_node_fs4.mkdirSync)((0, import_node_path3.dirname)(file), { recursive: true });
-    (0, import_node_fs4.writeFileSync)(file, codec.serialize({ messages, language }));
+    const files = bundleFiles(cfg, language, rows, namespaces);
+    for (const { file, messages: map } of files) {
+      (0, import_node_fs4.mkdirSync)((0, import_node_path3.dirname)(file), { recursive: true });
+      const list = Object.entries(map).map(([key, value]) => ({ key, value }));
+      (0, import_node_fs4.writeFileSync)(file, codec.serialize({ messages: list, language }));
+    }
     const skippedNote = skipped > 0 ? `, ${skipped} untranslated skipped` : "";
-    console.log(import_picocolors.default.green(`\u2713 ${file} (${messages.length} keys${skippedNote})`));
+    const summary = `${messages.length} keys${skippedNote}`;
+    const line = cfg.split === "namespace" ? `${cfg.outDir}/${localLanguage(cfg, language)}/ \u2014 ${files.length} namespace file${files.length === 1 ? "" : "s"}, ${summary}` : `${files[0].file} (${summary})`;
+    console.log(import_picocolors.default.green(`\u2713 ${line}`));
     if (typeEntries.length === 0) {
       typeEntries = messages.map((m) => ({ key: m.key, sample: m.value }));
     }
@@ -26886,6 +26964,64 @@ async function pushCommand(opts) {
   }
 }
 
+// package.json
+var package_default = {
+  name: "@radicalstorage-lingo/cli",
+  version: "0.4.0",
+  type: "module",
+  description: "Lingo CLI \u2014 pull/push translations as JSON at build time.",
+  license: "MIT",
+  repository: { type: "git", url: "git+https://github.com/CashcallPro/lingo.git", directory: "packages/cli" },
+  homepage: "https://github.com/CashcallPro/lingo#readme",
+  bugs: { url: "https://github.com/CashcallPro/lingo/issues" },
+  author: "Amin Ahrabian",
+  keywords: [
+    "i18n",
+    "internationalization",
+    "localization",
+    "translations",
+    "cli",
+    "deepl",
+    "icu"
+  ],
+  engines: {
+    node: ">=20.12"
+  },
+  bin: {
+    lingo: "./dist/cli.cjs"
+  },
+  files: [
+    "dist"
+  ],
+  publishConfig: {
+    access: "public"
+  },
+  scripts: {
+    build: "tsup",
+    lint: "eslint .",
+    typecheck: "tsc --noEmit",
+    test: "vitest run",
+    prepublishOnly: "pnpm build"
+  },
+  dependencies: {
+    "@clack/prompts": "^1.7.0",
+    commander: "^12.1.0",
+    picocolors: "^1.1.1",
+    zod: "^3.24.1"
+  },
+  devDependencies: {
+    "@eslint/js": "^9.18.0",
+    "@lingo/formats": "workspace:*",
+    "@types/node": "^22.10.5",
+    eslint: "^9.18.0",
+    globals: "^15.14.0",
+    tsup: "^8.3.5",
+    typescript: "^5.6.3",
+    "typescript-eslint": "^8.20.0",
+    vitest: "^2.1.8"
+  }
+};
+
 // src/cli.ts
 async function run(fn) {
   try {
@@ -26896,7 +27032,7 @@ async function run(fn) {
   }
 }
 var program2 = new Command();
-program2.name("lingo").description("Pull/push Lingo translations as JSON at build time.").version("0.0.0");
+program2.name("lingo").description("Pull/push Lingo translations as JSON at build time.").version(package_default.version);
 program2.command("init").description("Create a lingo.config.json (interactive wizard, or --yes for defaults)").option("--project <id>", "project id or slug").option("--api-url <url>", "API base URL").option("--out <dir>", "output directory for pulled bundles").option("-y, --yes", "skip the wizard; write config from flags + defaults").action(
   (opts) => run(() => initCommand({ project: opts.project, apiUrl: opts.apiUrl, out: opts.out, yes: opts.yes }))
 );

package/package.json

@@ -1,11 +1,19 @@
 {
   "name": "@radicalstorage-lingo/cli",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "type": "module",
   "description": "Lingo CLI — pull/push translations as JSON at build time.",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/CashcallPro/lingo.git",
+    "directory": "packages/cli"
+  },
+  "homepage": "https://github.com/CashcallPro/lingo#readme",
+  "bugs": {
+    "url": "https://github.com/CashcallPro/lingo/issues"
+  },
   "author": "Amin Ahrabian",
-  "homepage": "https://lingo-app-amin.fly.dev",
   "keywords": [
     "i18n",
     "internationalization",