@i18n-micro/cli 0.0.0-stage → 2.0.0

package/dist/chunks/spec-BwZlT28L.mjs

@@ -0,0 +1,507 @@
+// src/spec.ts
+var COMMAND_GROUPS = [
+	"Inspect",
+	"Translation workflow",
+	"Refactoring",
+	"Exchange"
+];
+/** Translation services of `translate`. A test keeps this equal to the drivers. */
+var SERVICES = [
+	"ai",
+	"azure",
+	"deepl",
+	"google",
+	"libretranslate",
+	"yandexcloud"
+];
+/** What `check` looks for. `duplicates` is off by default: the same word under two keys is often fine. */
+var CHECK_TYPES = [
+	"missing",
+	"empty",
+	"extra",
+	"placeholders",
+	"undefined",
+	"unused",
+	"duplicates"
+];
+var LINT_RULES = [
+	{
+		name: "no-trailing-spaces",
+		description: "Spaces at the end of a value or a line",
+		fixable: true
+	},
+	{
+		name: "no-multiple-spaces",
+		description: "Two or more spaces in a row",
+		fixable: true
+	},
+	{
+		name: "no-empty-translation",
+		description: "An empty or blank value",
+		fixable: false
+	}
+];
+/** Commands that went away, and what to run instead. */
+var REMOVED_COMMANDS = {
+	validate: "check",
+	diff: "check --only missing",
+	"check-duplicates": "check --only duplicates",
+	"export-csv": "export --format csv",
+	"import-csv": "import --format csv",
+	estimate: "translate --dryRun",
+	optimize: "check --only duplicates",
+	backup: "git, which already keeps your locale files",
+	restore: "git, which already keeps your locale files",
+	init: "nuxi init, then add nuxt-i18n-micro to modules",
+	split: "nothing: the module does not read split files",
+	"replace-values": "your editor or sed",
+	glossary: "editing .i18n-glossary.json by hand"
+};
+var shared = {
+	cwd: {
+		type: "string",
+		description: "Project directory",
+		defaultHint: "current directory"
+	},
+	logLevel: {
+		type: "string",
+		description: "Output level",
+		values: ["silent", "info"],
+		default: "info"
+	},
+	debug: {
+		type: "boolean",
+		description: "Print a stack trace when a command fails",
+		default: false
+	}
+};
+var translationDir = {
+	type: "string",
+	description: "Translation directory, relative to the project",
+	defaultHint: "`i18n.translationDir` of nuxt.config"
+};
+var projectArgs = {
+	...shared,
+	translationDir
+};
+var json = {
+	type: "boolean",
+	description: "Print JSON instead of text",
+	default: false
+};
+var ignore = {
+	type: "string",
+	description: "Comma-separated globs of source files to skip, relative to the project"
+};
+var commands = {
+	info: {
+		group: "Inspect",
+		description: "Print the resolved i18n configuration of the project",
+		args: {
+			...shared,
+			json
+		},
+		load: () => import("./info-rYas4Yw3.mjs")
+	},
+	check: {
+		group: "Inspect",
+		description: "The CI gate: fail on missing, empty, extra, undefined or unused keys and broken placeholders",
+		args: {
+			...projectArgs,
+			only: {
+				type: "string",
+				description: `Comma-separated checks to run: ${CHECK_TYPES.join(", ")}. \`unused\` named here fails when it cannot run`,
+				defaultHint: "all but duplicates"
+			},
+			duplicates: {
+				type: "boolean",
+				description: "Also report the same text under different keys",
+				default: false
+			},
+			ignore,
+			json
+		},
+		examples: ["i18n-micro check", "i18n-micro check --only missing,placeholders --json"],
+		load: () => import("./check-BaP_H-mS.mjs")
+	},
+	stats: {
+		group: "Inspect",
+		description: "Show translation completion per locale",
+		args: {
+			...projectArgs,
+			html: {
+				type: "string",
+				description: "Also write an HTML report to this file"
+			},
+			json,
+			baseRef: {
+				type: "string",
+				description: "Git ref to compare completion with, e.g. HEAD~1 or main"
+			}
+		},
+		examples: ["i18n-micro stats --baseRef main", "i18n-micro stats --html reports/i18n.html"],
+		load: () => import("./stats-BU-SmrVR.mjs")
+	},
+	lint: {
+		group: "Inspect",
+		description: "Check the text of translations; fails when issues remain",
+		args: {
+			...projectArgs,
+			rules: {
+				type: "string",
+				description: `Comma-separated rules to run: ${LINT_RULES.map((rule) => rule.name).join(", ")}, or a custom one`,
+				defaultHint: "all, or `enabledRules` of .i18n-lintrc.json"
+			},
+			fix: {
+				type: "boolean",
+				description: "Fix what can be fixed: spaces, and custom rules with a replacement",
+				default: false
+			},
+			json
+		},
+		examples: ["i18n-micro lint --rules no-trailing-spaces --fix"],
+		load: () => import("./lint-BaEIQGMl.mjs")
+	},
+	search: {
+		group: "Inspect",
+		description: "Search keys and values, and show where each key is used",
+		args: {
+			...projectArgs,
+			query: {
+				type: "positional",
+				description: "Text or key to search for",
+				required: false
+			},
+			caseSensitive: {
+				type: "boolean",
+				description: "Match case",
+				default: false
+			},
+			onlyUnused: {
+				type: "boolean",
+				description: "Only keys `clean` would remove; the query becomes optional",
+				default: false
+			},
+			scope: {
+				type: "string",
+				description: "Where to search",
+				values: [
+					"global",
+					"pages",
+					"all"
+				],
+				default: "all"
+			},
+			limit: {
+				type: "string",
+				description: "Return at most this many keys",
+				numeric: "int"
+			},
+			ignore,
+			json
+		},
+		examples: ["i18n-micro search \"Welcome\"", "i18n-micro search --onlyUnused"],
+		load: () => import("./search-Dj_Ynq_x.mjs")
+	},
+	extract: {
+		group: "Translation workflow",
+		description: "List the keys source files use that have no text yet, and add those with a default text to the default locale",
+		args: {
+			...projectArgs,
+			ignore
+		},
+		examples: ["i18n-micro extract"],
+		load: () => import("./extract-CJ8UfrVJ.mjs")
+	},
+	translate: {
+		group: "Translation workflow",
+		description: "Fill missing translations from the default locale through a translation service",
+		args: {
+			...projectArgs,
+			service: {
+				type: "string",
+				description: `Translation service: ${SERVICES.join(", ")}`
+			},
+			token: {
+				type: "string",
+				description: "API key. Prefer the I18N_TRANSLATE_TOKEN environment variable: flags end up in shell history"
+			},
+			options: {
+				type: "string",
+				description: "Service options as key:value pairs, separated by commas"
+			},
+			locale: {
+				type: "string",
+				description: "Comma-separated locales to fill",
+				defaultHint: "every locale but the default one"
+			},
+			replace: {
+				type: "boolean",
+				description: "Translate every key again, replacing existing values",
+				default: false
+			},
+			dryRun: {
+				type: "boolean",
+				description: "Count keys and characters per locale; send nothing",
+				default: false
+			},
+			chunkSize: {
+				type: "string",
+				description: "Strings per request; capped at what the service accepts",
+				numeric: "int"
+			},
+			pluralSeparator: {
+				type: "string",
+				description: "Separator of plural forms in messages",
+				default: "|"
+			},
+			glossaryFile: {
+				type: "string",
+				description: "Glossary file, used by the `ai` service",
+				defaultHint: "`.i18n-glossary.json` when it exists"
+			}
+		},
+		examples: [
+			"i18n-micro translate --dryRun",
+			"I18N_TRANSLATE_TOKEN=... i18n-micro translate --service deepl --locale de,fr",
+			"i18n-micro translate --service ai --options provider:openai,model:gpt-4o-mini",
+			"i18n-micro translate --service libretranslate --options baseUrl:https://translate.example.com"
+		],
+		load: () => import("./translate-CmnmgAHX.mjs")
+	},
+	sync: {
+		group: "Translation workflow",
+		description: "Remove keys the default locale does not have; stops when that cannot be proven safe. Missing keys stay missing",
+		args: {
+			...projectArgs,
+			ignore,
+			dryRun: {
+				type: "boolean",
+				description: "List what would be removed; write nothing",
+				default: false
+			},
+			force: {
+				type: "boolean",
+				description: "Remove keys even though it cannot be proven safe",
+				default: false
+			}
+		},
+		examples: ["i18n-micro sync --dryRun"],
+		load: () => import("./sync-BY2EFEda.mjs")
+	},
+	clean: {
+		group: "Translation workflow",
+		description: "Remove keys nothing in the project uses; stops when that cannot be proven",
+		args: {
+			...projectArgs,
+			include: {
+				type: "string",
+				description: "Regular expression: consider only matching keys for removal"
+			},
+			exclude: {
+				type: "string",
+				description: "Regular expression: never remove matching keys"
+			},
+			ignore,
+			dryRun: {
+				type: "boolean",
+				description: "List what would be removed; write nothing",
+				default: false
+			},
+			force: {
+				type: "boolean",
+				description: "Remove keys even though usage cannot be proven for all of them",
+				default: false
+			}
+		},
+		examples: ["i18n-micro clean --dryRun", `i18n-micro clean --exclude '^errors\\.'`],
+		load: () => import("./clean-bQVjG_2M.mjs")
+	},
+	"text-to-i18n": {
+		group: "Refactoring",
+		description: "Replace hardcoded text in Vue templates with translation calls, and report hardcoded text in code",
+		args: {
+			...shared,
+			translationFile: {
+				type: "string",
+				description: "File the new keys go to",
+				defaultHint: "`<translationDir>/<defaultLocale>.json`"
+			},
+			path: {
+				type: "string",
+				description: "File or directory to process",
+				defaultHint: "the whole project"
+			},
+			context: {
+				type: "string",
+				description: "Prefix for generated keys"
+			},
+			ignore,
+			dryRun: {
+				type: "boolean",
+				description: "Show what would change; write nothing",
+				default: false
+			},
+			interactive: {
+				type: "boolean",
+				description: "Confirm or edit every generated key",
+				default: false
+			}
+		},
+		examples: ["i18n-micro text-to-i18n --dryRun", "i18n-micro text-to-i18n --path components --context ui"],
+		load: () => import("./text-to-i18n-DweavFLm.mjs")
+	},
+	rename: {
+		group: "Refactoring",
+		description: "Rename a key or a namespace in every locale and in source files",
+		args: {
+			...projectArgs,
+			from: {
+				type: "string",
+				description: "Current key or namespace",
+				required: true
+			},
+			to: {
+				type: "string",
+				description: "New key or namespace",
+				required: true
+			},
+			ignore,
+			dryRun: {
+				type: "boolean",
+				description: "Report the changes; write nothing",
+				default: false
+			}
+		},
+		examples: ["i18n-micro rename --from common.save --to actions.save"],
+		load: () => import("./rename-uJnBX86A.mjs")
+	},
+	pseudo: {
+		group: "Refactoring",
+		description: "Fill a locale with pseudo-translations to find layout and hardcoded-text issues",
+		args: {
+			...projectArgs,
+			sourceLocale: {
+				type: "string",
+				description: "Locale to read",
+				defaultHint: "the default locale"
+			},
+			targetLocale: {
+				type: "string",
+				description: "Locale to fill",
+				required: true
+			},
+			replace: {
+				type: "boolean",
+				description: "Overwrite existing values",
+				default: false
+			}
+		},
+		load: () => import("./pseudo-oXBaONgF.mjs")
+	},
+	format: {
+		group: "Refactoring",
+		description: "Rewrite locale files with sorted keys and uniform indentation",
+		args: {
+			...projectArgs,
+			indent: {
+				type: "string",
+				description: "Spaces of indentation",
+				default: "2",
+				numeric: "int"
+			},
+			sortKeys: {
+				type: "boolean",
+				description: "Sort keys; use --no-sortKeys to keep their order",
+				default: true
+			},
+			check: {
+				type: "boolean",
+				description: "Fail if a file would change; write nothing",
+				default: false
+			}
+		},
+		examples: ["i18n-micro format --check"],
+		load: () => import("./format-6CtMgO-M.mjs")
+	},
+	export: {
+		group: "Exchange",
+		description: "Export locale files to PO or CSV, with the default-locale text as the source",
+		args: {
+			...projectArgs,
+			format: {
+				type: "string",
+				description: "File format",
+				values: ["po", "csv"],
+				default: "po"
+			},
+			dir: {
+				type: "string",
+				description: "Output directory, relative to the project",
+				defaultHint: "`pots` for po, `csv_exports` for csv"
+			},
+			force: {
+				type: "boolean",
+				description: "Overwrite files changed since the last export and never imported",
+				default: false
+			}
+		},
+		examples: ["i18n-micro export --format csv"],
+		load: () => import("./export-usBaNIpp.mjs")
+	},
+	import: {
+		group: "Exchange",
+		description: "Merge PO or CSV files into the locale files",
+		args: {
+			...projectArgs,
+			format: {
+				type: "string",
+				description: "File format",
+				values: ["po", "csv"],
+				default: "po"
+			},
+			dir: {
+				type: "string",
+				description: "Input directory, relative to the project",
+				defaultHint: "`pots` for po, `csv_exports` for csv"
+			},
+			dryRun: {
+				type: "boolean",
+				description: "Report what would be imported; write nothing",
+				default: false
+			}
+		},
+		examples: ["i18n-micro import --format csv --dryRun"],
+		load: () => import("./import-CnL8U6Za.mjs")
+	},
+	"sync-remote": {
+		group: "Exchange",
+		description: "Pull global translations from, or push them to, the HTTP endpoint in .i18n-remote.json",
+		args: {
+			...projectArgs,
+			pull: {
+				type: "boolean",
+				description: "Pull from the remote",
+				default: true
+			},
+			push: {
+				type: "boolean",
+				description: "Push to the remote",
+				default: false
+			},
+			force: {
+				type: "boolean",
+				description: "On a pull, take the remote value; on a push, overwrite text only the remote holds",
+				default: false
+			},
+			dryRun: {
+				type: "boolean",
+				description: "Report what a pull would change; write and push nothing",
+				default: false
+			}
+		},
+		examples: ["i18n-micro sync-remote --dryRun", "i18n-micro sync-remote --no-pull --push"],
+		load: () => import("./sync-remote-y3ZATbF2.mjs")
+	}
+};
+export { commands as a, REMOVED_COMMANDS as i, COMMAND_GROUPS as n, LINT_RULES as r, CHECK_TYPES as t };

package/dist/chunks/stats-BU-SmrVR.mjs

@@ -0,0 +1,156 @@
+import { A as log, P as style, S as validationError, a as flattenStrings, d as ownValue, l as isObject } from "./json-BV_apCMu.mjs";
+import { h as writeFileAtomic, u as relativePath } from "./nuxt-dKxG087V.mjs";
+import { t as Project } from "./project-DgWgr7pF.mjs";
+import { join, resolve } from "node:path";
+import { execFileSync } from "node:child_process";
+// src/commands/stats.ts
+var HTML_ESCAPES = {
+	"&": "&",
+	"<": "&lt;",
+	">": "&gt;",
+	"\"": "&quot;",
+	"'": "&#39;"
+};
+/** Locale codes come from the project, but a report is opened in a browser. */
+var esc = (text) => text.replace(/[&<>"']/g, (char) => HTML_ESCAPES[char]);
+var percent = (value) => `${value.toFixed(2)}%`;
+var scopeKeys = (tree) => Object.keys(flattenStrings(tree));
+function completionOf(code, trees, reference) {
+	const scopes = ["", ...Object.keys(reference.pages)];
+	const treeOf = (source, scope) => scope === "" ? source.global : ownValue(source.pages, scope) ?? {};
+	let totalKeys = 0;
+	let translatedKeys = 0;
+	for (const scope of scopes) {
+		const strings = flattenStrings(treeOf(trees, scope));
+		const keys = scopeKeys(treeOf(reference, scope));
+		totalKeys += keys.length;
+		translatedKeys += keys.filter((key) => Boolean(strings[key])).length;
+	}
+	return {
+		code,
+		totalKeys,
+		translatedKeys,
+		completion: totalKeys === 0 ? 100 : translatedKeys / totalKeys * 100
+	};
+}
+var reportOf = (byCode, defaultLocale) => [...byCode].map(([code, trees]) => completionOf(code, trees, byCode.get(defaultLocale)));
+function git(rootDir, args, input) {
+	return execFileSync("git", args, {
+		cwd: rootDir,
+		encoding: "utf8",
+		input,
+		stdio: [
+			"pipe",
+			"pipe",
+			"ignore"
+		],
+		maxBuffer: Number.POSITIVE_INFINITY
+	});
+}
+/**
+* The object at a path of a ref, with links followed as the project loader follows them: `git show`
+* would give a link's target as its text. `null`: no such path at that ref.
+*/
+function gitObject(rootDir, ref, path) {
+	const gitPath = relativePath(rootDir, path);
+	const answer = git(rootDir, [
+		"cat-file",
+		"--batch",
+		"--follow-symlinks"
+	], `${ref}:./${gitPath}\n`);
+	const header = answer.slice(0, answer.indexOf("\n"));
+	const found = /^(\S+) (blob|tree) \d+$/.exec(header);
+	if (found) return {
+		oid: found[1],
+		type: found[2],
+		body: answer.slice(header.length + 1)
+	};
+	if (header.endsWith(" missing") || header.startsWith("notdir ")) return null;
+	throw validationError(`Cannot read ${gitPath} at ${ref}: it is a link to something outside that commit.`);
+}
+function gitShow(rootDir, ref, path) {
+	const found = gitObject(rootDir, ref, path);
+	if (!found) return {};
+	try {
+		const parsed = JSON.parse(found.body);
+		return isObject(parsed) ? parsed : {};
+	} catch {
+		throw validationError(`Invalid JSON at ${ref}: ${relativePath(rootDir, path)}`);
+	}
+}
+function gitPageScopes(rootDir, ref, translationDir) {
+	const pages = gitObject(rootDir, ref, join(translationDir, "pages"));
+	if (pages?.type !== "tree") return [];
+	const scopes = git(rootDir, [
+		"ls-tree",
+		"-r",
+		"--name-only",
+		pages.oid
+	]).split("\n").filter((line) => line.endsWith(".json") && line.includes("/")).map((line) => line.slice(0, line.lastIndexOf("/")));
+	return [...new Set(scopes)];
+}
+function assertRef(rootDir, ref) {
+	try {
+		git(rootDir, [
+			"rev-parse",
+			"--verify",
+			`${ref}^{commit}`
+		]);
+	} catch {
+		throw validationError(`Unknown git ref: ${ref}`, ["Pass a branch, tag or commit of this repository."]);
+	}
+}
+function treesAtRef(project, ref) {
+	const { rootDir, translationDir } = project.config;
+	assertRef(rootDir, ref);
+	const scopes = project.config.disablePageLocales ? [] : [.../* @__PURE__ */ new Set([...project.reference.pageScopes, ...gitPageScopes(rootDir, ref, translationDir)])];
+	return new Map(project.codes.map((code) => [code, {
+		global: gitShow(rootDir, ref, join(translationDir, `${code}.json`)),
+		pages: Object.fromEntries(scopes.map((scope) => [scope, gitShow(rootDir, ref, join(translationDir, "pages", scope, `${code}.json`))]))
+	}]));
+}
+/** Git knows the project's own files, so the comparison is between own files: no layer on either side. */
+function buildDiff(project, ref) {
+	const current = new Map(project.codes.map((code) => [code, project.locale(code).own]));
+	const before = new Map(reportOf(treesAtRef(project, ref), project.config.defaultLocale).map((entry) => [entry.code, entry]));
+	return reportOf(current, project.config.defaultLocale).map((entry) => {
+		const base = before.get(entry.code);
+		return {
+			code: entry.code,
+			completionDelta: entry.completion - base.completion,
+			translatedKeysDelta: entry.translatedKeys - base.translatedKeys,
+			totalKeysDelta: entry.totalKeys - base.totalKeys
+		};
+	});
+}
+var htmlReport = (locales) => {
+	return `<!doctype html><meta charset="utf-8"><title>i18n completion</title><table><tr><th>Locale</th><th>Keys</th><th>Completion</th></tr>${locales.map(({ code, translatedKeys, totalKeys, completion }) => `<tr><td>${esc(code)}</td><td>${translatedKeys}/${totalKeys}</td><td>${percent(completion)}</td></tr>`).join("")}</table>\n`;
+};
+async function run(args) {
+	const project = await Project.load(args);
+	const { rootDir, defaultLocale } = project.config;
+	const locales = reportOf(new Map(project.codes.map((code) => [code, project.locale(code)])), defaultLocale);
+	const diff = args.baseRef ? {
+		baseRef: args.baseRef,
+		locales: buildDiff(project, args.baseRef)
+	} : void 0;
+	const htmlReportPath = args.html ? resolve(rootDir, args.html) : void 0;
+	if (htmlReportPath) writeFileAtomic(htmlReportPath, htmlReport(locales));
+	if (args.json) {
+		log.json({
+			locales,
+			diff,
+			htmlReportPath
+		});
+		return;
+	}
+	log.section("Completion Summary");
+	const tone = (completion) => completion >= 100 ? "green" : completion >= 50 ? "yellow" : "red";
+	log.rows(locales.map(({ code, translatedKeys, totalKeys, completion }) => [code, `${translatedKeys}/${totalKeys} (${style(tone(completion), percent(completion))})`]));
+	if (diff) {
+		log.section(`Diff vs ${diff.baseRef}`);
+		log.rows(diff.locales.map(({ code, completionDelta }) => [code, `${completionDelta >= 0 ? "+" : ""}${percent(completionDelta)}`]));
+	}
+	if (htmlReportPath) log.success(`HTML report generated: ${htmlReportPath}`);
+}
+export { run as default };

package/dist/chunks/sync-BY2EFEda.mjs

@@ -0,0 +1 @@
+export { n as default, t as extraKeys } from "./sync-C0NVDabK.mjs";