@verbaly/compiler 0.24.0 → 0.25.0

package/README.md

@@ -50,11 +50,11 @@ Catalogs are **flat JSON**: most TMS platforms (Crowdin, Lokalise, Phrase, …)
 
 ```bash
 npx verbaly export                    # verbaly-export/<locale>.xlf (XLIFF 2.0, source + target per unit)
-npx verbaly export --format csv       # spreadsheet-friendly: key,source,target
+npx verbaly export --format csv       # spreadsheet-friendly: key,source,target,location
 npx verbaly import verbaly-export/es.xlf   # fill the catalog back
 ```
 
-`export` writes one file per target locale with the source text alongside the current translation (`--missing` exports only the untranslated entries). `import` reads XLIFF 2.0/1.2 or CSV back and **validates every entry like `translate` does**: a translation that drops a `{param}`, a variant block or an `<em>` tag is rejected and reported, so a translator's typo can't break your UI. Existing translations are kept unless `--overwrite`; `--dry-run` previews everything.
+`export` writes one file per target locale with the source text alongside the current translation (`--missing` exports only the untranslated entries). Every entry carries **where the text lives in your source** (XLIFF `location` notes, a `location` column in CSV), so translators and TMS tools see the context instead of guessing it. `import` reads XLIFF 2.0/1.2 or CSV back and **validates every entry like `translate` does**: a translation that drops a `{param}`, a variant block or an `<em>` tag is rejected and reported, so a translator's typo can't break your UI. Existing translations are kept unless `--overwrite`; `--dry-run` previews everything.
 
 ## 📱 Mobile resources
 

package/dist/cli.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
+import { basename, dirname, join, relative, resolve } from "node:path";
 import { parseArgs } from "node:util";
 import { existsSync, mkdirSync, readFileSync, readdirSync, rmSync, watch, writeFileSync } from "node:fs";
-import { basename, dirname, join, relative, resolve } from "node:path";
-import { RICH_TAGS, createVerbaly, normalizeLink, parse, parseTags, safeAttribute } from "verbaly";
+import { RICH_TAGS, createVerbaly, localeDirection, normalizeLink, parse, parseTags, safeAttribute } from "verbaly";
 import { pathToFileURL } from "node:url";
 import { glob } from "tinyglobby";
 import { parse as parse$1 } from "@babel/parser";
@@ -427,6 +427,15 @@ var MessageRegistry = class {
 		}
 		return out;
 	}
+	origins() {
+		const out = this.usedKeys();
+		for (const analysis of this.files.values()) for (const msg of analysis.tagged) {
+			const files = out.get(msg.key) ?? [];
+			if (!files.includes(msg.file)) files.push(msg.file);
+			out.set(msg.key, files);
+		}
+		return out;
+	}
 };
 //#endregion
 //#region src/key.ts
@@ -1128,7 +1137,8 @@ function exportCatalogs(cfg, catalogs, options = {}) {
 		const all = Object.keys(source).filter((key) => source[key]).sort().map((key) => ({
 			key,
 			source: source[key],
-			target: catalog[key] ?? ""
+			target: catalog[key] ?? "",
+			location: options.origins?.[key]
 		}));
 		const untranslated = all.filter((entry) => !entry.target);
 		const entries = options.missing ? untranslated : all;
@@ -1224,8 +1234,13 @@ function parseExchangeFile(file, localeOverride) {
 	throw new Error(`[verbaly] ${file}: unsupported format, expected .xlf, .xliff or .csv.`);
 }
 function toXliff(sourceLocale, locale, entries) {
-	const units = entries.map(({ key, source, target }) => [
+	const units = entries.map(({ key, source, target, location }) => [
 		`    <unit id="${escapeXml(key)}">`,
+		...location?.length ? [
+			"      <notes>",
+			...location.map((file) => `        <note category="location">${escapeXml(file)}</note>`),
+			"      </notes>"
+		] : [],
 		`      <segment state="${target ? "translated" : "initial"}">`,
 		`        <source>${escapeXml(source)}</source>`,
 		`        <target>${escapeXml(target)}</target>`,
@@ -1275,8 +1290,8 @@ function unescapeXml(text) {
 }
 function toCsv(entries) {
 	return [
-		"key,source,target",
-		...entries.map(({ key, source, target }) => `${csvField(key)},${csvField(source)},${csvField(target)}`),
+		"key,source,target,location",
+		...entries.map(({ key, source, target, location }) => `${csvField(key)},${csvField(source)},${csvField(target)},${csvField(location?.join("; ") ?? "")}`),
 		""
 	].join("\r\n");
 }
@@ -1378,6 +1393,7 @@ function renderHtml(html, options) {
 		const chunkStart = m.index + 1 + rawName.length;
 		if (tagName === "html" && options.setLang !== false) {
 			setAttribute(ms, html, chunkStart, openEnd, attrChunk, "lang", options.locale);
+			setAttribute(ms, html, chunkStart, openEnd, attrChunk, "dir", localeDirection(options.locale));
 			continue;
 		}
 		const attrs = parseAttrs(attrChunk);
@@ -1876,7 +1892,8 @@ async function runCli(args = process.argv.slice(2)) {
 			locales: values.locales?.split(","),
 			format,
 			out: values.out,
-			missing: values.missing
+			missing: values.missing,
+			origins: isMobileFormat(format) ? void 0 : await collectOrigins(cfg)
 		});
 		if (result.files.length === 0) {
 			console.log("[verbaly] no target locales to export (add locales to your config)");
@@ -1982,6 +1999,12 @@ function rejectStrayFlags(command, values) {
 	process.exitCode = 1;
 	return true;
 }
+async function collectOrigins(cfg) {
+	const registry = await extractProject(cfg);
+	const origins = {};
+	for (const [key, files] of registry.origins()) origins[key] = files.map((file) => relative(cfg.root, file).replaceAll("\\", "/"));
+	return origins;
+}
 async function resolveProvider(cfg, model) {
 	const configured = cfg.translate.provider;
 	if (typeof configured === "function") return configured;