@verbaly/compiler 0.21.0 → 0.23.0

package/dist/index.d.ts

@@ -189,9 +189,12 @@ declare function doctor(cfg: ResolvedConfig): Promise<DoctorResult>;
 //#endregion
 //#region src/exchange.d.ts
 type ExchangeFormat = 'xliff' | 'csv';
+type MobileFormat = 'android-xml' | 'ios-strings';
+type ExportFormat = ExchangeFormat | MobileFormat;
+declare function isMobileFormat(format: ExportFormat): format is MobileFormat;
 interface ExportOptions {
   locales?: string[];
-  format?: ExchangeFormat;
+  format?: ExportFormat;
   out?: string;
   missing?: boolean;
 }
@@ -202,7 +205,7 @@ interface ExportedFile {
   untranslated: number;
 }
 interface ExportResult {
-  format: ExchangeFormat;
+  format: ExportFormat;
   dir: string;
   files: ExportedFile[];
 }
@@ -309,5 +312,25 @@ interface RenderSiteResult {
 }
 declare function renderSite(cfg: ResolvedConfig, options?: RenderSiteOptions): Promise<RenderSiteResult>;
 //#endregion
-export { type Alternate, type Analysis, type AnalyzeOptions, type Catalog, type Catalogs, type CheckResult, type ClaudeProviderOptions, type DoctorEntry, type DoctorResult, type ExchangeFormat, type ExportOptions, type ExportResult, type ExportedFile, type ImportOptions, type ImportResult, type InitOptions, type InitResult, LOCALE_MODULE_PREFIX, MessageRegistry, type MissingEntry, PSEUDO_LOCALE, type ParamType, type PluginOptions, RESOLVED_VIRTUAL_ID, type RenderConfig, type RenderHtmlOptions, type RenderHtmlResult, type RenderSiteOptions, type RenderSiteResult, type ResolvedConfig, type RuntimeModuleOptions, SFC_FILE_RE, SOURCE_FILE_RE, type SyncResult, type TaggedMessage, type TaggedParam, type TransComponent, type TransformResult, type TranslateConfig, type TranslateOptions, type TranslateProvider, type TranslateRequest, type TranslateResult, type UnknownEntry, type UsedKey, VIRTUAL_ID, type VerbalyConfig, analyze, analyzeFile, analyzeSfc, catalogPath, check, claudeProvider, collectParams, detectBundler, doctor, exportCatalogs, extractProject, findConfigFile, formatCheckResult, generateDts, generateLocaleModule, generateRuntimeModule, importCatalogs, init, isTransformTarget, loadCatalogs, loadConfig, loadConfigFile, loadVirtualModule, parseExchangeFile, pruneCatalogs, pseudoCatalogs, pseudoLocalize, readCatalog, renderHtml, renderParamType, renderSite, resolveConfig, resolveVirtualId, runBuildGate, serializeCatalog, stableKey, structureMatches, syncCatalogs, targetLocales, transformCode, transformSource, translateCatalogs, writeCatalog, writeDts };
+//#region src/status.d.ts
+interface LocaleStatus {
+  locale: string;
+  translated: number;
+  total: number;
+}
+interface StatusResult {
+  messages: number;
+  source: string;
+  locales: LocaleStatus[];
+}
+declare function status(cfg: ResolvedConfig, catalogs: Catalogs, registry: MessageRegistry): StatusResult;
+declare function formatStatusResult(result: StatusResult): string;
+//#endregion
+//#region src/watch.d.ts
+interface WatchProjectOptions {
+  debounce?: number;
+}
+declare function watchProject(cfg: ResolvedConfig, run: () => Promise<void>, options?: WatchProjectOptions): () => void;
+//#endregion
+export { type Alternate, type Analysis, type AnalyzeOptions, type Catalog, type Catalogs, type CheckResult, type ClaudeProviderOptions, type DoctorEntry, type DoctorResult, type ExchangeFormat, type ExportFormat, type ExportOptions, type ExportResult, type ExportedFile, type ImportOptions, type ImportResult, type InitOptions, type InitResult, LOCALE_MODULE_PREFIX, type LocaleStatus, MessageRegistry, type MissingEntry, type MobileFormat, PSEUDO_LOCALE, type ParamType, type PluginOptions, RESOLVED_VIRTUAL_ID, type RenderConfig, type RenderHtmlOptions, type RenderHtmlResult, type RenderSiteOptions, type RenderSiteResult, type ResolvedConfig, type RuntimeModuleOptions, SFC_FILE_RE, SOURCE_FILE_RE, type StatusResult, type SyncResult, type TaggedMessage, type TaggedParam, type TransComponent, type TransformResult, type TranslateConfig, type TranslateOptions, type TranslateProvider, type TranslateRequest, type TranslateResult, type UnknownEntry, type UsedKey, VIRTUAL_ID, type VerbalyConfig, type WatchProjectOptions, analyze, analyzeFile, analyzeSfc, catalogPath, check, claudeProvider, collectParams, detectBundler, doctor, exportCatalogs, extractProject, findConfigFile, formatCheckResult, formatStatusResult, generateDts, generateLocaleModule, generateRuntimeModule, importCatalogs, init, isMobileFormat, isTransformTarget, loadCatalogs, loadConfig, loadConfigFile, loadVirtualModule, parseExchangeFile, pruneCatalogs, pseudoCatalogs, pseudoLocalize, readCatalog, renderHtml, renderParamType, renderSite, resolveConfig, resolveVirtualId, runBuildGate, serializeCatalog, stableKey, status, structureMatches, syncCatalogs, targetLocales, transformCode, transformSource, translateCatalogs, watchProject, writeCatalog, writeDts };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,6 +1,6 @@
 import { parse } from "@babel/parser";
 import { createHash } from "node:crypto";
-import { existsSync, mkdirSync, readFileSync, readdirSync, rmSync, writeFileSync } from "node:fs";
+import { existsSync, mkdirSync, readFileSync, readdirSync, rmSync, watch, writeFileSync } from "node:fs";
 import { basename, dirname, join, relative, resolve } from "node:path";
 import { RICH_TAGS, createVerbaly, parse as parse$1, parseTags, safeHref } from "verbaly";
 import { pathToFileURL } from "node:url";
@@ -382,11 +382,17 @@ function catalogPath(cfg, locale) {
 	return join(cfg.dir, `${locale}.json`);
 }
 function readCatalog(cfg, locale) {
+	let content;
 	try {
-		return JSON.parse(readFileSync(catalogPath(cfg, locale), "utf8"));
+		content = readFileSync(catalogPath(cfg, locale), "utf8");
 	} catch {
 		return {};
 	}
+	try {
+		return JSON.parse(content.replace(/^\uFEFF/, ""));
+	} catch (error) {
+		throw new Error(`[verbaly] ${catalogPath(cfg, locale)} is not valid JSON, fix or delete the file`, { cause: error });
+	}
 }
 function loadCatalogs(cfg) {
 	const catalogs = {};
@@ -403,8 +409,13 @@ function serializeCatalog(catalog) {
 }
 function writeCatalog(cfg, locale, catalog) {
 	const serialized = serializeCatalog(catalog);
-	mkdirSync(cfg.dir, { recursive: true });
-	writeFileSync(catalogPath(cfg, locale), serialized);
+	const path = catalogPath(cfg, locale);
+	try {
+		if (readFileSync(path, "utf8") === serialized) return serialized;
+	} catch {
+		mkdirSync(cfg.dir, { recursive: true });
+	}
+	writeFileSync(path, serialized);
 	return serialized;
 }
 //#endregion
@@ -1124,6 +1135,45 @@ function readDeps(root) {
 	}
 }
 //#endregion
+//#region src/mobile.ts
+function androidValuesDir(locale, sourceLocale) {
+	if (locale === sourceLocale) return "values";
+	const parts = locale.split("-");
+	if (parts.length === 1) return `values-${locale}`;
+	if (parts.length === 2 && /^[a-zA-Z]{2}$/.test(parts[1])) return `values-${parts[0]}-r${parts[1].toUpperCase()}`;
+	return `values-b+${parts.join("+")}`;
+}
+function toAndroidXml(entries) {
+	const names = /* @__PURE__ */ new Map();
+	return [
+		"<?xml version=\"1.0\" encoding=\"UTF-8\"?>",
+		"<resources>",
+		...entries.map(({ key, text }) => {
+			const name = androidName(key);
+			const clash = names.get(name);
+			if (clash !== void 0) throw new Error(`[verbaly] android-xml: keys "${clash}" and "${key}" both become resource name "${name}", rename one of them.`);
+			names.set(name, key);
+			return `  <string name="${name}">${androidText(text)}</string>`;
+		}),
+		"</resources>",
+		""
+	].join("\n");
+}
+function toIosStrings(entries) {
+	return [...entries.map(({ key, text }) => `"${iosText(key)}" = "${iosText(text)}";`), ""].join("\n");
+}
+function androidName(key) {
+	const name = key.replace(/[^A-Za-z0-9_]/g, "_");
+	return /^[0-9]/.test(name) ? `_${name}` : name;
+}
+function androidText(text) {
+	const escaped = text.replace(/\\/g, "\\\\").replace(/'/g, "\\'").replace(/"/g, "\\\"").replace(/\n/g, "\\n").replace(/\t/g, "\\t").replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
+	return /^[@?]/.test(escaped) ? `\\${escaped}` : escaped;
+}
+function iosText(text) {
+	return text.replace(/\\/g, "\\\\").replace(/"/g, "\\\"").replace(/\n/g, "\\n").replace(/\t/g, "\\t");
+}
+//#endregion
 //#region src/translate.ts
 async function translateCatalogs(cfg, catalogs, provider, options = {}) {
 	const batchSize = options.batchSize ?? 20;
@@ -1182,11 +1232,15 @@ function sameMembers(a, b) {
 }
 //#endregion
 //#region src/exchange.ts
+function isMobileFormat(format) {
+	return format === "android-xml" || format === "ios-strings";
+}
 function exportCatalogs(cfg, catalogs, options = {}) {
 	const format = options.format ?? "xliff";
 	const dir = resolve(cfg.root, options.out ?? "verbaly-export");
 	const source = catalogs[cfg.sourceLocale] ?? {};
 	const targets = targetLocales(cfg, options.locales);
+	if (isMobileFormat(format)) return exportMobile(cfg, catalogs, format, dir, source, targets);
 	const files = [];
 	mkdirSync(dir, { recursive: true });
 	for (const locale of targets) {
@@ -1213,6 +1267,31 @@ function exportCatalogs(cfg, catalogs, options = {}) {
 		files
 	};
 }
+function exportMobile(cfg, catalogs, format, dir, source, targets) {
+	const keys = Object.keys(source).filter((key) => source[key]).sort();
+	const files = [];
+	for (const locale of [cfg.sourceLocale, ...targets]) {
+		const catalog = locale === cfg.sourceLocale ? source : catalogs[locale] ?? {};
+		const entries = keys.map((key) => ({
+			key,
+			text: catalog[key] ?? ""
+		})).filter((entry) => entry.text);
+		const path = join(dir, format === "android-xml" ? join(androidValuesDir(locale, cfg.sourceLocale), "strings.xml") : join(`${locale}.lproj`, "Localizable.strings"));
+		mkdirSync(dirname(path), { recursive: true });
+		writeFileSync(path, format === "android-xml" ? toAndroidXml(entries) : toIosStrings(entries));
+		files.push({
+			locale,
+			path,
+			total: entries.length,
+			untranslated: keys.length - entries.length
+		});
+	}
+	return {
+		format,
+		dir,
+		files
+	};
+}
 function importCatalogs(cfg, catalogs, files, options = {}) {
 	const source = catalogs[cfg.sourceLocale] ?? {};
 	const result = {
@@ -1683,6 +1762,82 @@ function decodeEntities(text) {
 	return text.replace(/&quot;/g, "\"").replace(/&#39;/g, "'").replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&amp;/g, "&");
 }
 //#endregion
-export { LOCALE_MODULE_PREFIX, MessageRegistry, PSEUDO_LOCALE, RESOLVED_VIRTUAL_ID, SFC_FILE_RE, SOURCE_FILE_RE, VIRTUAL_ID, analyze, analyzeFile, analyzeSfc, catalogPath, check, claudeProvider, collectParams, detectBundler, doctor, exportCatalogs, extractProject, findConfigFile, formatCheckResult, generateDts, generateLocaleModule, generateRuntimeModule, importCatalogs, init, isTransformTarget, loadCatalogs, loadConfig, loadConfigFile, loadVirtualModule, parseExchangeFile, pruneCatalogs, pseudoCatalogs, pseudoLocalize, readCatalog, renderHtml, renderParamType, renderSite, resolveConfig, resolveVirtualId, runBuildGate, serializeCatalog, stableKey, structureMatches, syncCatalogs, targetLocales, transformCode, transformSource, translateCatalogs, writeCatalog, writeDts };
+//#region src/status.ts
+function status(cfg, catalogs, registry) {
+	const source = catalogs[cfg.sourceLocale] ?? {};
+	const needed = /* @__PURE__ */ new Set([...registry.messages().keys(), ...Object.keys(source)]);
+	const locales = [];
+	for (const locale of cfg.locales) {
+		if (locale === cfg.sourceLocale) continue;
+		let translated = 0;
+		for (const key of needed) if (catalogs[locale]?.[key]) translated += 1;
+		locales.push({
+			locale,
+			translated,
+			total: needed.size
+		});
+	}
+	return {
+		messages: needed.size,
+		source: cfg.sourceLocale,
+		locales
+	};
+}
+function formatStatusResult(result) {
+	const lines = [`[verbaly] ${result.messages} messages · source: ${result.source}`];
+	if (result.locales.length === 0) {
+		lines.push("  no target locales (add locales to your config)");
+		return lines.join("\n");
+	}
+	for (const { locale, translated, total } of result.locales) {
+		const pct = total === 0 ? 100 : Math.floor(translated / total * 100);
+		const mark = translated === total ? " ✓" : "";
+		lines.push(`  ${locale}: ${translated}/${total} translated (${pct}%)${mark}`);
+	}
+	return lines.join("\n");
+}
+//#endregion
+//#region src/watch.ts
+function watchProject(cfg, run, options = {}) {
+	const catalogDir = relative(cfg.root, cfg.dir).replaceAll("\\", "/");
+	let timer;
+	let running = false;
+	let queued = false;
+	async function refresh() {
+		if (running) {
+			queued = true;
+			return;
+		}
+		running = true;
+		try {
+			await run();
+		} catch (error) {
+			console.warn("[verbaly] watch run failed:", error);
+		} finally {
+			running = false;
+			if (queued) {
+				queued = false;
+				schedule();
+			}
+		}
+	}
+	function schedule() {
+		clearTimeout(timer);
+		timer = setTimeout(() => void refresh(), options.debounce ?? 150);
+	}
+	const watcher = watch(cfg.root, { recursive: true }, (_event, filename) => {
+		if (!filename) return;
+		const file = filename.replaceAll("\\", "/");
+		if (file.includes("node_modules/") || file.endsWith(".d.ts")) return;
+		if (catalogDir && file.startsWith(`${catalogDir}/`)) return;
+		if (SOURCE_FILE_RE.test(file)) schedule();
+	});
+	return () => {
+		clearTimeout(timer);
+		watcher.close();
+	};
+}
+//#endregion
+export { LOCALE_MODULE_PREFIX, MessageRegistry, PSEUDO_LOCALE, RESOLVED_VIRTUAL_ID, SFC_FILE_RE, SOURCE_FILE_RE, VIRTUAL_ID, analyze, analyzeFile, analyzeSfc, catalogPath, check, claudeProvider, collectParams, detectBundler, doctor, exportCatalogs, extractProject, findConfigFile, formatCheckResult, formatStatusResult, generateDts, generateLocaleModule, generateRuntimeModule, importCatalogs, init, isMobileFormat, isTransformTarget, loadCatalogs, loadConfig, loadConfigFile, loadVirtualModule, parseExchangeFile, pruneCatalogs, pseudoCatalogs, pseudoLocalize, readCatalog, renderHtml, renderParamType, renderSite, resolveConfig, resolveVirtualId, runBuildGate, serializeCatalog, stableKey, status, structureMatches, syncCatalogs, targetLocales, transformCode, transformSource, translateCatalogs, watchProject, writeCatalog, writeDts };
 
 //# sourceMappingURL=index.js.map