@x18n/cli 0.0.6 → 0.0.8

package/dist/cli.mjs

@@ -1,8 +1,11 @@
-import { a as openWorkspace, c as readInput, d as stdinArg, f as useColor, i as exitCodeOf, l as runPlan, n as displayPath, o as out, p as wireDiagnostics, r as errorInfo, s as printJson, t as cwd, u as singleProject } from "./context-Za_ea1Nk.mjs";
+import { a as out, c as runPlan, d as useColor, f as wireDiagnostics, i as openWorkspace, l as singleProject, n as displayPath, o as printJson, r as exitCodeOf, s as readInput, t as cwd, u as stdinArg } from "./context-j5IMF1tl.mjs";
 import { createRequire } from "node:module";
-import { PluginFileSchema, X18nError, isJsonObject, parseMessageBatch, placeholderProblems, renderPrompt, toWireRange, validate } from "@x18n/core";
+import { PluginFileSchema, errors, isJsonObject, isX18nError, parseMessageBatch, placeholderProblems, renderPrompt, toErrorInfo, toWireRange, validate } from "@x18n/core";
 import process from "node:process";
+import { styleText } from "node:util";
 import cac from "cac";
+import { formatDiagnostic } from "nostics";
+import { ansiFormatter } from "nostics/formatters/ansi";
 import { mkdir, readFile, writeFile } from "node:fs/promises";
 import { dirname, join, resolve } from "node:path";
 import { createInterface } from "node:readline/promises";
@@ -12,14 +15,14 @@ import { existsSync } from "node:fs";
 import { namespaceFromPath } from "@x18n/builtins/finders";
 import { parse, stringify } from "yaml";
 //#region package.json
-var version = "0.0.6";
+var version = "0.0.8";
 //#endregion
 //#region src/commands/change.ts
 async function project(options) {
 	return singleProject(await openWorkspace(options));
 }
 async function set(key, options) {
-	if (options.value === void 0) throw new X18nError("X18N4008", "pass --value <text> (or --value - to read stdin)");
+	if (options.value === void 0) throw errors.X18N4008({ reason: "pass --value <text> (or --value - to read stdin)" });
 	const loaded = await project(options);
 	const value = options.value === "\0stdin" ? (await readInput(stdinArg)).replace(/\r?\n$/, "") : String(options.value);
 	const locale = options.locale ?? loaded.project.sourceLocale;
@@ -37,7 +40,10 @@ async function apply(source, options) {
 	try {
 		data = JSON.parse(await readInput(source));
 	} catch (error) {
-		throw new X18nError("X18N4008", `${source} is not JSON: ${error instanceof Error ? error.message : String(error)}`);
+		throw errors.X18N4008({
+			reason: `${source} is not JSON: ${error instanceof Error ? error.message : String(error)}`,
+			cause: error
+		});
 	}
 	const ops = parseMessageBatch(p, data);
 	const rejected = placeholderProblems(p, ops);
@@ -46,7 +52,7 @@ async function apply(source, options) {
 			printJson("apply", {
 				applied: false,
 				rejected
-			}, [], [new X18nError("X18N4007", `${rejected.length} values`).toJSON()]);
+			}, [], [toErrorInfo(errors.X18N4007({ count: rejected.length }))]);
 			return 1;
 		}
 		for (const r of rejected) out(`rejected ${r.locale} ${r.key}: ${[r.missing.length ? `missing ${r.missing.join(", ")}` : "", r.extra.length ? `unexpected ${r.extra.join(", ")}` : ""].filter(Boolean).join("; ")}`);
@@ -144,7 +150,7 @@ async function report(workspace, options) {
 	const roots = new Map(workspace.projects.map((p) => [p.name, p.root]));
 	for (const [i, id] of ids.entries()) {
 		const reporter = available.get(id);
-		if (!reporter) throw new X18nError("X18N0001", `unknown reporter "${id}" (${[...available.keys()].join(", ")})`);
+		if (!reporter) throw errors.X18N0001({ issue: `unknown reporter "${id}" (${[...available.keys()].join(", ")})` });
 		const text = await reporter.report(inputs, {
 			color: !outputs[i] && useColor(options) && id === "pretty",
 			displayPath: (path, project) => displayPath(roots.get(project) ?? "", path)
@@ -152,10 +158,10 @@ async function report(workspace, options) {
 		if (outputs[i]) await writeFile(outputs[i], text);
 		else if (text) process.stdout.write(text);
 	}
-	const errors = inputs.reduce((sum, input) => sum + input.summary.errors, 0);
+	const errorCount = inputs.reduce((sum, input) => sum + input.summary.errors, 0);
 	const warnings = inputs.reduce((sum, input) => sum + input.summary.warnings, 0);
 	const tooManyWarnings = options.maxWarnings !== void 0 && warnings > Number(options.maxWarnings);
-	return errors > 0 || tooManyWarnings ? 1 : 0;
+	return errorCount > 0 || tooManyWarnings ? 1 : 0;
 }
 async function check(options) {
 	const workspace = await openWorkspace(options);
@@ -191,7 +197,7 @@ function isPlanItem(value) {
 }
 async function readPlan(file) {
 	const data = JSON.parse(await readFile(file, "utf8"));
-	if (!isJsonObject(data) || !Array.isArray(data.items) || !data.items.every(isPlanItem)) throw new X18nError("X18N4008", `${file} is not an extraction plan`);
+	if (!isJsonObject(data) || !Array.isArray(data.items) || !data.items.every(isPlanItem)) throw errors.X18N4008({ reason: `${file} is not an extraction plan` });
 	return data.items;
 }
 /** One question per string in a TTY: extract with the proposed key, a typed key, or skip. */
@@ -467,7 +473,7 @@ async function doctor(options) {
 		out("scanners:");
 		for (const s of e.scanners) out(`  ${s.id} (${s.extensions.join(", ") || "none"}): ${s.files} files`);
 		if (e.conflicts.length) out(`conflicts:\n${e.conflicts.map((c) => `  .${c.extension}: ${c.winner} wins over ${c.loser}`).join("\n")}`);
-		if (e.errors.length) out(`errors:\n${e.errors.map((err) => `  ${err.code} ${err.message}`).join("\n")}`);
+		if (e.errors.length) out(`errors:\n${e.errors.map((err) => `  ${err.name} ${err.why}`).join("\n")}`);
 		out("config origins:");
 		for (const [key, origin] of Object.entries(e.config.origins)) out(`  ${key}: ${origin}`);
 	}
@@ -475,11 +481,11 @@ async function doctor(options) {
 //#endregion
 //#region src/commands/migrate.ts
 async function migrate(source, options) {
-	if (source !== "i18n-ally") throw new X18nError("X18N0001", `unknown migration source "${source}" (i18n-ally)`);
+	if (source !== "i18n-ally") throw errors.X18N0001({ issue: `unknown migration source "${source}" (i18n-ally)` });
 	const root = resolve(options.root ?? cwd());
 	const result = await migrateI18nAlly(root, { format: options.format });
 	const existing = findConfigFile(root);
-	if (existing && !options.force && !options.dryRun && result.files.length > 0) throw new X18nError("X18N0001", `${existing} already exists (pass --force to replace it)`);
+	if (existing && !options.force && !options.dryRun && result.files.length > 0) throw errors.X18N0001({ issue: `${existing} already exists (pass --force to replace it)` });
 	if (!options.dryRun) for (const file of result.files) {
 		const path = join(root, file.path);
 		await mkdir(dirname(path), { recursive: true });
@@ -500,9 +506,9 @@ async function migrate(source, options) {
 //#endregion
 //#region src/commands/prompt.ts
 async function prompt(kind, options) {
-	if (kind !== "translate" && kind !== "review") throw new X18nError("X18N0001", `unknown prompt "${kind}" (translate, review)`);
+	if (kind !== "translate" && kind !== "review") throw errors.X18N0001({ issue: `unknown prompt "${kind}" (translate, review)` });
 	const locale = kind === "translate" ? options.to : options.locale ?? options.to;
-	if (!locale) throw new X18nError("X18N0001", kind === "translate" ? "pass --to <locale>" : "pass --locale <locale>");
+	if (!locale) throw errors.X18N0001({ issue: kind === "translate" ? "pass --to <locale>" : "pass --locale <locale>" });
 	const { project, host } = singleProject(await openWorkspace(options));
 	if (options.stale) {
 		await project.loadHistory();
@@ -523,7 +529,7 @@ async function prompt(kind, options) {
 //#region src/commands/setup.ts
 async function schema(name, options) {
 	const which = name ?? "config";
-	if (which !== "config" && which !== "plugin") throw new X18nError("X18N0001", `unknown schema "${which}" (config, plugin)`);
+	if (which !== "config" && which !== "plugin") throw errors.X18N0001({ issue: `unknown schema "${which}" (config, plugin)` });
 	const require = createRequire(import.meta.url);
 	const text = await readFile(require.resolve(`@x18n/core/schema/${which}.json`), "utf8");
 	if (options.json) printJson("schema", {
@@ -550,7 +556,7 @@ function patternOf(resource, fromPath) {
 async function init(options) {
 	const root = resolve(options.root ?? cwd());
 	const existing = findConfigFile(root);
-	if (existing && !options.force) throw new X18nError("X18N0001", `${existing} already exists (pass --force to replace it)`);
+	if (existing && !options.force) throw errors.X18N0001({ issue: `${existing} already exists (pass --force to replace it)` });
 	const { project } = (await loadWorkspace({
 		cwd: root,
 		cache: false
@@ -578,7 +584,7 @@ async function init(options) {
 		const body = JSON.stringify(config, null, 2).replace(/"(\w+)":/g, "$1:").replace(/"/g, "'");
 		content = `import { defineConfig } from '@x18n/core'\n\n// Detected presets: ${detected.join(", ") || "none"}. They apply automatically.\nexport default defineConfig(${body})\n`;
 	}
-	if (!configFileNames.some((name) => file.endsWith(name))) throw new X18nError("X18N0001", `unknown format "${format}" (ts, yml, json)`);
+	if (!configFileNames.some((name) => file.endsWith(name))) throw errors.X18N0001({ issue: `unknown format "${format}" (ts, yml, json)` });
 	await writeFile(file, content);
 	if (options.json) printJson("init", {
 		file,
@@ -622,9 +628,15 @@ function ejectPlugin(data) {
 }
 async function eject(file, options) {
 	const path = resolve(cwd(), file);
-	if (!existsSync(path)) throw new X18nError("X18N1001", path);
+	if (!existsSync(path)) throw errors.X18N1001({
+		specifier: path,
+		reason: "the file does not exist"
+	});
 	const result = validate(PluginFileSchema, parse(await readFile(path, "utf8")));
-	if (!result.success) throw new X18nError("X18N1004", result.issues.map((i) => `${i.path}: ${i.message}`).join("; "));
+	if (!result.success) throw errors.X18N1004({
+		file: path,
+		issues: result.issues.map((i) => `${i.path}: ${i.message}`).join("; ")
+	});
 	const code = ejectPlugin(result.output);
 	if (options.json) printJson("plugin eject", {
 		file: path,
@@ -634,8 +646,17 @@ async function eject(file, options) {
 }
 //#endregion
 //#region src/cli.ts
-const uiCommands = () => import("./ui-Bp3xyqr_.mjs");
-/** Runs a command and turns errors into the JSON envelope or a printed hint, with the matching exit code. */
+const uiCommands = () => import("./ui-tfQlhxh6.mjs");
+const paint = (format) => (text) => styleText(format, text, { validateStream: false });
+const formatColored = ansiFormatter({
+	red: paint("red"),
+	yellow: paint("yellow"),
+	cyan: paint("cyan"),
+	gray: paint("gray"),
+	bold: paint("bold"),
+	dim: paint("dim")
+});
+/** Runs a command and turns errors into the JSON envelope or a printed diagnostic, with the matching exit code. */
 function run(command, action) {
 	return async (...args) => {
 		const options = args.at(-1);
@@ -643,13 +664,9 @@ function run(command, action) {
 			const code = await action(...args);
 			process.exitCode = code ?? 0;
 		} catch (error) {
-			const info = errorInfo(error);
-			if (options.json) printJson(command, null, [], [info]);
-			else {
-				process.stderr.write(`error ${info.code}: ${info.message}\n`);
-				if (info.hint) process.stderr.write(`  ${info.hint}\n`);
-				if (!(error instanceof Error && "code" in error) && error instanceof Error && process.env.DEBUG) process.stderr.write(`${error.stack}\n`);
-			}
+			if (options.json) printJson(command, null, [], [toErrorInfo(error)]);
+			else if (isX18nError(error)) process.stderr.write(`${(useColor(options) ? formatColored : formatDiagnostic)(error)}\n`);
+			else process.stderr.write(`${error instanceof Error && process.env.DEBUG ? error.stack : `error: ${toErrorInfo(error).why}`}\n`);
 			process.exitCode = exitCodeOf(error);
 		}
 	};

package/dist/{context-Za_ea1Nk.mjs → context-j5IMF1tl.mjs}

@@ -1,4 +1,4 @@
-import { X18nError, applyTextEdits, envelope, isX18nError, toWireDiagnostic } from "@x18n/core";
+import { applyTextEdits, envelope, errors, isX18nError, toWireDiagnostic } from "@x18n/core";
 import process from "node:process";
 import { Buffer } from "node:buffer";
 import { readFile } from "node:fs/promises";
@@ -24,7 +24,10 @@ async function openWorkspace(options) {
 }
 /** Write commands work on one project; a monorepo needs `--project`. */
 function singleProject(workspace) {
-	if (workspace.projects.length !== 1) throw new X18nError("X18N0003", `pick one with --project (${workspace.projects.map((p) => p.name).join(", ")})`);
+	if (workspace.projects.length !== 1) throw errors.X18N0003({
+		name: void 0,
+		available: workspace.projects.map((p) => p.name)
+	});
 	return workspace.projects[0];
 }
 function displayPath(root, path) {
@@ -40,21 +43,15 @@ function printJson(command, data, diagnostics = [], errors = []) {
 function wireDiagnostics(loaded, diagnostics) {
 	return diagnostics.map((d) => toWireDiagnostic(loaded.name, d, (path) => loaded.project.text(path)));
 }
-/** Exit code for an error: 2 usage or config, 3 decision needed, 4 stale plan, 1 otherwise. */
-function exitCodeOf(error) {
-	if (!isX18nError(error)) return 2;
-	if (error.code === "X18N4003") return 3;
-	if (error.code === "X18N4004") return 4;
-	return /^X18N[01]/.test(error.code) ? 2 : 1;
+/** Exit code for an error code: 2 usage or config, 3 decision needed, 4 stale plan, 1 otherwise. */
+function exitCodeFor(code) {
+	if (code === "X18N4003") return 3;
+	if (code === "X18N4004") return 4;
+	return /^X18N[01]/.test(code) ? 2 : 1;
 }
-function errorInfo(error) {
-	if (isX18nError(error)) return error.toJSON();
-	return {
-		code: "X18N0002",
-		message: error instanceof Error ? error.message : String(error),
-		hint: "",
-		docs: ""
-	};
+/** Errors without an x18n code exit with 2. */
+function exitCodeOf(error) {
+	return isX18nError(error) ? exitCodeFor(error.code) : 2;
 }
 /** Stands for a lone `-` argument (stdin). */
 const stdinArg = "\0stdin";
@@ -72,7 +69,7 @@ async function answer(plan, options) {
 		for (const decision of plan.decisions) answers[decision.id] = decision.default;
 		return answers;
 	}
-	if (options.json || !process.stdin.isTTY) throw new X18nError("X18N4003", plan.decisions.map((d) => `${d.message} (${d.options.map((o) => o.id).join(" | ")})`).join(" "), plan.decisions.map((d) => d.id));
+	if (options.json || !process.stdin.isTTY) throw errors.X18N4003({ decisions: plan.decisions.map((d) => `${d.message} (${d.options.map((o) => o.id).join(" | ")})`) });
 	const rl = createInterface({
 		input: process.stdin,
 		output: process.stderr
@@ -145,4 +142,4 @@ async function runPlan(command, loaded, plan, options) {
 	else out(preview);
 }
 //#endregion
-export { openWorkspace as a, readInput as c, stdinArg as d, useColor as f, exitCodeOf as i, runPlan as l, displayPath as n, out as o, wireDiagnostics as p, errorInfo as r, printJson as s, cwd as t, singleProject as u };
+export { out as a, runPlan as c, useColor as d, wireDiagnostics as f, openWorkspace as i, singleProject as l, displayPath as n, printJson as o, exitCodeOf as r, readInput as s, cwd as t, stdinArg as u };

package/dist/{ui-Bp3xyqr_.mjs → ui-tfQlhxh6.mjs}

@@ -1,4 +1,4 @@
-import { a as openWorkspace, o as out, s as printJson, t as cwd } from "./context-Za_ea1Nk.mjs";
+import { a as out, i as openWorkspace, o as printJson, t as cwd } from "./context-j5IMF1tl.mjs";
 import process from "node:process";
 import { join, resolve } from "node:path";
 import { createX18nDevframe } from "@x18n/ui";
@@ -13,8 +13,8 @@ import { launchEditor } from "devframe/utils/launch-editor";
 async function ui(options) {
 	const workspace = await openWorkspace(options);
 	workspace.projects.forEach((p) => p.project.watch());
-	const editor = process.env.LAUNCH_EDITOR || process.env.VISUAL || process.env.EDITOR;
-	const definition = createX18nDevframe(workspace.projects, { openInEditor: editor ? async ({ project, path, line, column }) => launchEditor(`${join(project.root, path)}:${line}:${column}`, editor) : void 0 });
+	const editor = process.env.LAUNCH_EDITOR || process.env.VISUAL || process.env.EDITOR || void 0;
+	const definition = createX18nDevframe(workspace.projects, { openInEditor: async ({ project, path, line, column }) => launchEditor(`${join(project.root, path)}:${line}:${column}`, editor) });
 	const mcpToken = randomToken();
 	const auth = options.auth !== false;
 	if (!auth) process.stderr.write("warning: --no-auth lets anything that reaches the port edit your files. Use it only in CI and e2e tests.\n");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@x18n/cli",
   "type": "module",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "Manage and view i18n files of any project, for humans and agents",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -38,12 +38,13 @@
     "node": ">=22"
   },
   "dependencies": {
-    "@x18n/builtins": "0.0.6",
-    "@x18n/core": "0.0.6",
-    "@x18n/node": "0.0.6",
-    "@x18n/ui": "0.0.6",
+    "@x18n/builtins": "0.0.8",
+    "@x18n/core": "0.0.8",
+    "@x18n/node": "0.0.8",
+    "@x18n/ui": "0.0.8",
     "cac": "^7.1.0",
     "devframe": "^1.2.6",
+    "nostics": "^1.3.0",
     "yaml": "^2.9.1"
   },
   "scripts": {

package/skills/x18n/SKILL.md

@@ -25,7 +25,7 @@ Batch the questions into one message. Routine work needs no question: adding a k
 - Change locale files through `x18n set`, `x18n apply`, `x18n rename` and `x18n delete`. The config file (`x18n.config.ts`) is the one i18n file you edit by hand.
 - Check a key before you use it in code: `x18n get <key> --json`. Reuse an existing key with the same meaning.
 - Keep every placeholder of the source message (`{name}`, `{{count}}`, `%{name}`, `:name`, `%s`, `@:key`).
-- Pass `--json` and read the envelope `{ "x18n": 1, "command", "data", "diagnostics", "errors" }`.
+- Pass `--json` and read the envelope `{ "x18n": 2, "command", "data", "diagnostics", "errors" }`.
 - Run renames and deletes with `--dry-run` first, and read the plan.
 - Write every key as a full string literal. Do not build keys at runtime (see below).