@x18n/node 0.0.13 → 0.0.15

package/dist/index.mjs

@@ -3,18 +3,90 @@ import { existsSync, readFileSync } from "node:fs";
 import { mkdir, readFile, readdir, rm, writeFile } from "node:fs/promises";
 import { dirname, isAbsolute, join, relative, resolve, sep } from "node:path";
 import { fileURLToPath, pathToFileURL } from "node:url";
-import { compileYamlPlugin } from "@x18n/builtins/yaml-plugin";
 import { PluginFileSchema, createProject, errors, hashText, isX18nError, resolveConfig, validate } from "@x18n/core";
 import { createJiti } from "jiti";
 import { glob } from "tinyglobby";
 import { parse, stringify } from "yaml";
+import { placeholderFromShape } from "@x18n/builtins/placeholders";
+import regexScopes from "@x18n/builtins/scanners/regex-scopes";
+import { execFile, spawn } from "node:child_process";
 import process from "node:process";
 import { watch } from "chokidar";
 import ignore from "ignore";
 import { createBuiltins } from "@x18n/builtins";
 import { Buffer } from "node:buffer";
-import { execFile, spawn } from "node:child_process";
+import { yamlReviewStore } from "@x18n/builtins/reviews";
 import { applyEdits, modify, parse as parse$1 } from "jsonc-parser";
+//#region src/yaml-plugin.ts
+/**
+* Compiles a validated YAML plugin into plugin objects. Each section maps to the
+* options of a built-in factory, so moving to a TS plugin is a small change.
+*/
+function compileYamlPlugin(data) {
+	const replacements = (data.normalizeKey ?? []).map((rule) => ({
+		from: new RegExp(rule.replace.pattern, "g"),
+		to: rule.replace.with
+	}));
+	const localeInfo = data.localeInfo;
+	const plugin = {
+		name: data.name,
+		config(draft) {
+			const defaults = data.config;
+			if (defaults?.sourceLocale) draft.sourceLocale = defaults.sourceLocale;
+			if (defaults?.locales) draft.locales = defaults.locales;
+			if (defaults?.resources && draft.resources.length === 0) draft.resources = defaults.resources;
+			if (defaults?.keyStyle) draft.keyStyle = defaults.keyStyle;
+			if (defaults?.namespace) draft.namespace = {
+				separator: defaults.namespace.separator ?? draft.namespace.separator,
+				default: defaults.namespace.default ?? draft.namespace.default,
+				fallback: defaults.namespace.fallback ?? draft.namespace.fallback,
+				byFile: {
+					...draft.namespace.byFile,
+					...defaults.namespace.byFile
+				},
+				fromPath: defaults.namespace.fromPath ?? draft.namespace.fromPath
+			};
+			draft.usage = {
+				...draft.usage,
+				calls: [...draft.usage.calls, ...data.scanners?.calls ?? []],
+				regex: [...draft.usage.regex, ...data.scanners?.regex ?? []]
+			};
+			if (data.extract?.templates) draft.extract = {
+				...draft.extract,
+				templates: [...draft.extract.templates ?? [], ...data.extract.templates]
+			};
+		},
+		derivedKeys: data.derivedKeys,
+		placeholders: data.placeholders?.map(placeholderFromShape),
+		normalizeKey: replacements.length > 0 ? (raw) => replacements.reduce((text, rule) => text.replace(rule.from, rule.to), raw) : void 0,
+		localeInfo: localeInfo ? (code) => {
+			const info = localeInfo[code];
+			return info ? {
+				...info.flag ? { flag: info.flag } : {},
+				...info.displayName ? { displayName: info.displayName } : {}
+			} : void 0;
+		} : void 0
+	};
+	const plugins = [plugin, ...data.scopes ? [regexScopes(data.scopes.regex, `${data.name}-scopes`)] : []];
+	const detect = data.detect;
+	if (!detect) return plugins.length === 1 ? plugin : {
+		name: data.name,
+		plugins
+	};
+	return {
+		name: data.name,
+		exclusive: data.exclusive,
+		plugins,
+		async detect(ctx) {
+			const deps = detect.dependencies;
+			if (deps?.any && !ctx.hasAnyDependency(deps.any)) return false;
+			if (deps?.all && !deps.all.every(ctx.hasDependency)) return false;
+			for (const pattern of detect.files ?? []) if (!await ctx.fileExists(pattern)) return false;
+			return true;
+		}
+	};
+}
+//#endregion
 //#region src/config.ts
 const configFileNames = [
 	"x18n.config.ts",
@@ -43,6 +115,15 @@ function findConfigUpward(cwd) {
 		dir = parent;
 	}
 }
+/** One config file per directory below `dir`, shallowest first. */
+async function findConfigsBelow(dir) {
+	const files = await glob(configFileNames.map((name) => `**/${name}`), {
+		cwd: dir,
+		absolute: true,
+		ignore: ["**/node_modules/**"]
+	});
+	return [...new Set(files.map((file) => dirname(file)))].sort((a, b) => a.split("/").length - b.split("/").length || a.localeCompare(b)).flatMap((found) => findConfigFile(found) ?? []);
+}
 function resolveOwn(specifier) {
 	try {
 		return fileURLToPath(import.meta.resolve(specifier));
@@ -153,7 +234,9 @@ async function manifestRootsOf(root, gitRoot) {
 }
 //#endregion
 //#region src/host.ts
-const toPosix = (path) => sep === "\\" ? path.replace(/\\/g, "/") : path;
+function toPosix(path) {
+	return sep === "\\" ? path.replace(/\\/g, "/") : path;
+}
 function isNotFound(error) {
 	return error instanceof Error && "code" in error && (error.code === "ENOENT" || error.code === "EISDIR");
 }
@@ -205,6 +288,24 @@ async function loadGitignore(root) {
 		});
 	};
 }
+function gitConfig(cwd, key) {
+	return new Promise((resolve) => {
+		execFile("git", ["config", key], {
+			cwd,
+			encoding: "utf8"
+		}, (error, stdout) => {
+			resolve(error ? void 0 : stdout.trim() || void 0);
+		});
+	});
+}
+/** The git `user.name` and `user.email`, or undefined without git or a configured user. */
+async function gitIdentity(cwd) {
+	const [name, email] = await Promise.all([gitConfig(cwd, "user.name"), gitConfig(cwd, "user.email")]);
+	return name === void 0 && email === void 0 ? void 0 : {
+		...name !== void 0 && { name },
+		...email !== void 0 && { email }
+	};
+}
 /** A persistent cache in one JSON file. Only entries used in this session are written back, so it stays bounded. */
 function createFileCache(dir) {
 	const file = join(dir, "cache.json");
@@ -242,6 +343,7 @@ function createNodeHost(root, options = {}) {
 	const cacheDir = options.cacheDir === false ? void 0 : options.cacheDir ?? join(absoluteRoot, "node_modules/.cache/x18n");
 	const cache = cacheDir ? createFileCache(join(cacheDir, hashText(absoluteRoot))) : void 0;
 	const full = (path) => resolve(absoluteRoot, path);
+	let identity;
 	return {
 		root: absoluteRoot,
 		logger: options.logger,
@@ -301,6 +403,7 @@ function createNodeHost(root, options = {}) {
 				watcher.close();
 			} };
 		},
+		identity: () => identity ??= gitIdentity(absoluteRoot),
 		flush: async () => cache?.flush()
 	};
 }
@@ -686,7 +789,7 @@ const frameworkPresets = {
 	"ui5": "ui5",
 	"lingui": "lingui",
 	"jekyll": "jekyll",
-	"i18n-js": "i18n-js"
+	"i18n-js": "ruby-i18n-js"
 };
 const languageExtensions = {
 	javascript: [
@@ -759,7 +862,9 @@ async function readFirst(root, paths) {
 function isRecord(value) {
 	return typeof value === "object" && value !== null && !Array.isArray(value);
 }
-const asStrings = (value) => (Array.isArray(value) ? value : value === void 0 ? [] : [value]).filter((v) => typeof v === "string");
+function asStrings(value) {
+	return (Array.isArray(value) ? value : value === void 0 ? [] : [value]).filter((v) => typeof v === "string");
+}
 /** Setting prefixes by priority: the i18n-ally-next fork renames `i18n-ally.*` keys, so its value is the newest. */
 const settingPrefixes = [
 	"i18n-ally-next",
@@ -928,7 +1033,7 @@ function presetsOf(r, notes) {
 }
 function notesOf(settings, notes) {
 	if ([...settings.keys()].some((key) => key.startsWith("translate."))) notes.push("`translate.*` settings were dropped: x18n writes translate prompts instead (`x18n prompt translate --to <locale>`).");
-	if ([...settings.keys()].some((key) => key.startsWith("review."))) notes.push("Review settings move to `review.*` once reviews ship (1.x); they were not migrated yet.");
+	if (settings.has("review.removeCommentOnResolved")) notes.push("`i18n-ally.review.removeCommentOnResolved` was dropped: x18n keeps resolved reviews and hides them with `x18n review list --open`.");
 	for (const key of handledByDefaults) if (settings.has(key)) notes.push(`\`i18n-ally.${key}\` is handled by defaults or dropped.`);
 }
 function mapConfig(settings, parts, notes) {
@@ -975,8 +1080,85 @@ function mapConfig(settings, parts, notes) {
 		...r.str("defaultNamespace") ? { namespace: { default: r.str("defaultNamespace") } } : {},
 		...Object.keys(usage).length ? { usage } : {},
 		...write ? { write } : {},
-		...Object.keys(extract).length ? { extract } : {}
+		...Object.keys(extract).length ? { extract } : {},
+		...reviewOf(r)
+	};
+}
+function reviewOf(r) {
+	const enabled = r.get("review.enabled");
+	const author = {
+		...r.str("review.user.name") && { name: r.str("review.user.name") },
+		...r.str("review.user.email") && { email: r.str("review.user.email") }
+	};
+	const review = {
+		...typeof enabled === "boolean" && { enabled },
+		...Object.keys(author).length > 0 && { author }
 	};
+	return Object.keys(review).length > 0 ? { review } : {};
+}
+const reviewTypes = {
+	comment: "comment",
+	approve: "approve",
+	request_change: "request-change"
+};
+function str(value) {
+	return typeof value === "string" ? value : void 0;
+}
+function recordOf(value) {
+	return isRecord(value) ? value : {};
+}
+/** One i18n-ally comment; one with a `suggestion` becomes a suggestion. */
+function convertComment(comment) {
+	const user = recordOf(comment.user);
+	const name = str(user.name);
+	const email = str(user.email);
+	const text = str(comment.comment);
+	const suggestion = str(comment.suggestion);
+	return {
+		id: str(comment.id) ?? hashText(JSON.stringify(comment)).slice(0, 6),
+		type: suggestion === void 0 ? reviewTypes[str(comment.type) ?? "comment"] ?? "comment" : "suggestion",
+		...(name !== void 0 || email !== void 0) && { author: {
+			...name !== void 0 && { name },
+			...email !== void 0 && { email }
+		} },
+		time: str(comment.time) ?? (/* @__PURE__ */ new Date(0)).toISOString(),
+		...text !== void 0 && { text },
+		...suggestion !== void 0 && { suggestion },
+		...comment.resolved === true && { resolved: true }
+	};
+}
+/** The comments of one key and locale, with the translation candidate as a last suggestion. */
+function convertLocale(key, locale, item) {
+	const comments = (Array.isArray(item.comments) ? item.comments : []).filter(isRecord).map(convertComment);
+	const candidate = recordOf(item.translation_candidate);
+	const text = str(candidate.text);
+	if (text !== void 0) comments.push({
+		id: hashText(`${key}:${locale}:${text}`).slice(0, 6),
+		type: "suggestion",
+		time: str(candidate.time) ?? (/* @__PURE__ */ new Date(0)).toISOString(),
+		text: "Translation candidate from i18n-ally",
+		suggestion: text
+	});
+	return comments;
+}
+/** i18n-ally's `reviews.<key>.locales.<locale>.comments` as x18n threads; translation candidates become suggestions. */
+function convertI18nAllyReviews(text, notes) {
+	const reviews = recordOf(recordOf(parse(text)).reviews);
+	const threads = {};
+	let descriptions = 0;
+	for (const [key, entry] of Object.entries(reviews)) {
+		const { description, locales } = recordOf(entry);
+		if (description !== void 0) descriptions++;
+		for (const [locale, item] of Object.entries(recordOf(locales))) {
+			const comments = convertLocale(key, locale, recordOf(item));
+			if (comments.length > 0) (threads[key] ??= {})[locale] = comments;
+		}
+	}
+	if (descriptions > 0) notes.push(`${descriptions} key description${descriptions === 1 ? " was" : "s were"} dropped: x18n reviews have no key descriptions.`);
+	return yamlReviewStore.serialize({
+		threads,
+		sources: {}
+	});
 }
 /** The x18n config that a project's i18n-ally settings and custom framework mean, or undefined without any. */
 async function readI18nAllyConfig(root) {
@@ -1023,15 +1205,15 @@ async function migrateI18nAlly(root, options = {}) {
 	};
 	const { config, plugin } = found;
 	const notes = [...found.notes];
-	const reviews = (await readFirst(root, [".vscode/i18n-ally-next-reviews.yml", ".vscode/i18n-ally-reviews.yml"]))?.text;
+	const reviews = await readFirst(root, [".vscode/i18n-ally-next-reviews.yml", ".vscode/i18n-ally-reviews.yml"]);
 	const files = [];
 	const finalConfig = plugin !== void 0 ? {
 		...config,
-		plugins: ["./x18n/custom.x18n-plugin.yml"]
+		plugins: ["./.x18n/custom.x18n-plugin.yml"]
 	} : config;
 	files.push(configFile(finalConfig, options.format ?? "ts"));
 	if (plugin) files.push({
-		path: "x18n/custom.x18n-plugin.yml",
+		path: ".x18n/custom.x18n-plugin.yml",
 		content: `# yaml-language-server: $schema=../node_modules/@x18n/core/schema/plugin.json\n${stringify(plugin)}`
 	});
 	let vscodeText = await readText(join(root, ".vscode/settings.json"));
@@ -1052,14 +1234,18 @@ async function migrateI18nAlly(root, options = {}) {
 	if (reviews !== void 0 && !existsSync(join(root, ".x18n/reviews.yml"))) {
 		files.push({
 			path: ".x18n/reviews.yml",
-			content: reviews
+			content: convertI18nAllyReviews(reviews.text, notes)
 		});
-		notes.push("Reviews were copied to `.x18n/reviews.yml`; x18n reads them once reviews ship (1.x).");
+		notes.push("Reviews were converted to `.x18n/reviews.yml`.");
 	}
 	return {
 		files,
 		notes,
-		removable: [...keys, ...found.customFramework ? [found.customFramework] : []]
+		removable: [
+			...keys,
+			...found.customFramework ? [found.customFramework] : [],
+			...reviews ? [reviews.path] : []
+		]
 	};
 }
 //#endregion
@@ -1127,6 +1313,15 @@ function applyDefaults(draft, config) {
 }
 async function projectSpecs(rootConfigFile, cwd, upward) {
 	if (!rootConfigFile) {
+		const nested = await findConfigsBelow(cwd);
+		if (nested.length) {
+			const specs = [];
+			for (const file of nested) if (!specs.some((spec) => spec.configFile === file)) specs.push(...(await projectSpecs(file, cwd, false)).specs);
+			return {
+				root: resolve(cwd),
+				specs
+			};
+		}
 		const settingsRoot = findI18nAllyRoot(cwd, upward);
 		const fallback = settingsRoot && await i18nAllyFallback(settingsRoot);
 		if (settingsRoot && fallback) return {
@@ -1179,7 +1374,7 @@ async function loadWorkspace(options) {
 	const configFile = options.configFile ? resolve(options.cwd, options.configFile) : options.upward === false ? findConfigFile(resolve(options.cwd)) : findConfigUpward(options.cwd);
 	const { root, specs } = await projectSpecs(configFile, options.cwd, options.upward !== false);
 	const gitRoot = findGitRoot(root);
-	const defaults = options.builtins ?? createBuiltins();
+	const defaults = options.builtins ?? await createBuiltins();
 	const builtins = gitRoot ? {
 		...defaults,
 		plugins: [...defaults.plugins, gitHistory()]

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@x18n/node",
   "type": "module",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "Node.js host for x18n: file system access, config and plugin loading",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -25,8 +25,8 @@
     "node": ">=22"
   },
   "dependencies": {
-    "@x18n/builtins": "0.0.13",
-    "@x18n/core": "0.0.13",
+    "@x18n/builtins": "0.0.15",
+    "@x18n/core": "0.0.15",
     "chokidar": "^6.0.0",
     "ignore": "^7.0.13",
     "jiti": "^2.7.0",