@verbaly/compiler 0.26.0 → 0.27.0

package/dist/index.d.ts

@@ -48,12 +48,14 @@ interface TranslateRequest {
   sourceLocale: string;
   targetLocale: string;
   messages: Record<string, string>;
+  origins?: Record<string, string[]>;
 }
 type TranslateProvider = (request: TranslateRequest) => Promise<Record<string, string>>;
 interface TranslateOptions {
   locales?: string[];
   batchSize?: number;
   dryRun?: boolean;
+  origins?: Record<string, string[]>;
 }
 interface TranslateResult {
   translated: Record<string, string[]>;
@@ -192,6 +194,15 @@ interface DoctorResult {
 }
 declare function doctor(cfg: ResolvedConfig): Promise<DoctorResult>;
 //#endregion
+//#region src/drafts.d.ts
+declare const DRAFTS_FILE = ".verbaly-drafts.json";
+type Drafts = Record<string, string[]>;
+declare function loadDrafts(cfg: ResolvedConfig): Drafts;
+declare function saveDrafts(cfg: ResolvedConfig, drafts: Drafts): void;
+declare function markDrafts(drafts: Drafts, locale: string, keys: string[]): void;
+declare function clearDrafts(drafts: Drafts, locale: string, keys?: string[]): void;
+declare function effectiveDrafts(drafts: Drafts, catalogs: Catalogs): Drafts;
+//#endregion
 //#region src/exchange.d.ts
 type ExchangeFormat = 'xliff' | 'csv';
 type MobileFormat = 'android-xml' | 'ios-strings';
@@ -323,13 +334,14 @@ interface LocaleStatus {
   locale: string;
   translated: number;
   total: number;
+  drafts: number;
 }
 interface StatusResult {
   messages: number;
   source: string;
   locales: LocaleStatus[];
 }
-declare function status(cfg: ResolvedConfig, catalogs: Catalogs, registry: MessageRegistry): StatusResult;
+declare function status(cfg: ResolvedConfig, catalogs: Catalogs, registry: MessageRegistry, drafts?: Drafts): StatusResult;
 declare function formatStatusResult(result: StatusResult): string;
 //#endregion
 //#region src/watch.d.ts
@@ -369,5 +381,5 @@ interface WrapCodeResult {
 }
 declare function wrapCode(code: string, file: string): WrapCodeResult;
 //#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, type WrapCodeResult, type WrapEntry, type WrapOptions, type WrapResult, type WrapSkip, analyze, analyzeFile, analyzeSfc, catalogPath, check, claudeProvider, collectParams, createSourceFilter, detectBundler, doctor, exportCatalogs, extractProject, findConfigFile, formatCheckResult, formatStatusResult, generateDts, generateLocaleModule, generateRuntimeModule, githubCheckAnnotations, 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, wrapCode, wrapProject, writeCatalog, writeDts };
+export { type Alternate, type Analysis, type AnalyzeOptions, type Catalog, type Catalogs, type CheckResult, type ClaudeProviderOptions, DRAFTS_FILE, type DoctorEntry, type DoctorResult, type Drafts, 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, type WrapCodeResult, type WrapEntry, type WrapOptions, type WrapResult, type WrapSkip, analyze, analyzeFile, analyzeSfc, catalogPath, check, claudeProvider, clearDrafts, collectParams, createSourceFilter, detectBundler, doctor, effectiveDrafts, exportCatalogs, extractProject, findConfigFile, formatCheckResult, formatStatusResult, generateDts, generateLocaleModule, generateRuntimeModule, githubCheckAnnotations, importCatalogs, init, isMobileFormat, isTransformTarget, loadCatalogs, loadConfig, loadConfigFile, loadDrafts, loadVirtualModule, markDrafts, parseExchangeFile, pruneCatalogs, pseudoCatalogs, pseudoLocalize, readCatalog, renderHtml, renderParamType, renderSite, resolveConfig, resolveVirtualId, runBuildGate, saveDrafts, serializeCatalog, stableKey, status, structureMatches, syncCatalogs, targetLocales, transformCode, transformSource, translateCatalogs, watchProject, wrapCode, wrapProject, writeCatalog, writeDts };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -824,7 +824,7 @@ function resolveConfig(config = {}) {
 	const sourceLocale = config.sourceLocale ?? "en";
 	const locales = /* @__PURE__ */ new Set([sourceLocale, ...config.locales ?? []]);
 	if (existsSync(dir)) {
-		for (const file of readdirSync(dir)) if (file.endsWith(".json") && file !== `en-XA.json`) locales.add(file.slice(0, -5));
+		for (const file of readdirSync(dir)) if (file.endsWith(".json") && !file.startsWith(".") && file !== `en-XA.json`) locales.add(file.slice(0, -5));
 	}
 	return {
 		root,
@@ -1211,6 +1211,66 @@ function readDeps(root) {
 	}
 }
 //#endregion
+//#region src/drafts.ts
+const DRAFTS_FILE = ".verbaly-drafts.json";
+function draftsPath(cfg) {
+	return join(cfg.dir, DRAFTS_FILE);
+}
+function loadDrafts(cfg) {
+	let content;
+	try {
+		content = readFileSync(draftsPath(cfg), "utf8");
+	} catch {
+		return {};
+	}
+	try {
+		return JSON.parse(content.replace(/^\uFEFF/, ""));
+	} catch (error) {
+		throw new Error(`[verbaly] ${draftsPath(cfg)} is not valid JSON, fix or delete the file`, { cause: error });
+	}
+}
+function serializeDrafts(drafts) {
+	const sorted = {};
+	for (const locale of Object.keys(drafts).sort()) {
+		const keys = [...new Set(drafts[locale])].sort();
+		if (keys.length) sorted[locale] = keys;
+	}
+	return JSON.stringify(sorted, null, 2) + "\n";
+}
+function saveDrafts(cfg, drafts) {
+	const serialized = serializeDrafts(drafts);
+	const path = draftsPath(cfg);
+	try {
+		if (readFileSync(path, "utf8") === serialized) return;
+	} catch {
+		mkdirSync(cfg.dir, { recursive: true });
+	}
+	writeFileSync(path, serialized);
+}
+function markDrafts(drafts, locale, keys) {
+	if (!keys.length) return;
+	drafts[locale] = [.../* @__PURE__ */ new Set([...drafts[locale] ?? [], ...keys])];
+}
+function clearDrafts(drafts, locale, keys) {
+	if (!drafts[locale]) return;
+	if (!keys) {
+		delete drafts[locale];
+		return;
+	}
+	const drop = new Set(keys);
+	drafts[locale] = drafts[locale].filter((key) => !drop.has(key));
+	if (!drafts[locale].length) delete drafts[locale];
+}
+function effectiveDrafts(drafts, catalogs) {
+	const out = {};
+	for (const [locale, keys] of Object.entries(drafts)) {
+		const catalog = catalogs[locale] ?? {};
+		const live = keys.filter((key) => catalog[key]);
+		if (live.length) out[locale] = live;
+	}
+	return out;
+}
+//#endregion
 //#region src/mobile.ts
 function androidValuesDir(locale, sourceLocale) {
 	if (locale === sourceLocale) return "values";
@@ -1271,10 +1331,12 @@ async function translateCatalogs(cfg, catalogs, provider, options = {}) {
 		for (let i = 0; i < missing.length; i += batchSize) {
 			const keys = missing.slice(i, i + batchSize);
 			const messages = Object.fromEntries(keys.map((key) => [key, source[key]]));
+			const origins = options.origins ? Object.fromEntries(keys.filter((key) => options.origins[key]).map((key) => [key, options.origins[key]])) : void 0;
 			const out = await provider({
 				sourceLocale: cfg.sourceLocale,
 				targetLocale: locale,
-				messages
+				messages,
+				origins
 			});
 			for (const key of keys) {
 				const text = out[key];
@@ -1551,7 +1613,9 @@ function claudeProvider(options = {}) {
 	};
 }
 function buildPrompt(request) {
-	return `Translate each value from "${request.sourceLocale}" to "${request.targetLocale}". Return a JSON object with the same keys and translated values.\n\n` + JSON.stringify(request.messages, null, 2);
+	const origins = request.origins;
+	const context = origins && Object.keys(origins).length ? `\n\nWhere each string appears (context for tone and length, do not translate these paths):\n` + Object.entries(origins).map(([key, files]) => `  ${key}: ${files.join(", ")}`).join("\n") : "";
+	return `Translate each value from "${request.sourceLocale}" to "${request.targetLocale}". Return a JSON object with the same keys and translated values.\n\n` + JSON.stringify(request.messages, null, 2) + context;
 }
 function batchFormat(request) {
 	const keys = Object.keys(request.messages);
@@ -1845,9 +1909,10 @@ function decodeEntities(text) {
 }
 //#endregion
 //#region src/status.ts
-function status(cfg, catalogs, registry) {
+function status(cfg, catalogs, registry, drafts = {}) {
 	const source = catalogs[cfg.sourceLocale] ?? {};
 	const needed = /* @__PURE__ */ new Set([...registry.messages().keys(), ...Object.keys(source)]);
+	const live = effectiveDrafts(drafts, catalogs);
 	const locales = [];
 	for (const locale of cfg.locales) {
 		if (locale === cfg.sourceLocale) continue;
@@ -1856,7 +1921,8 @@ function status(cfg, catalogs, registry) {
 		locales.push({
 			locale,
 			translated,
-			total: needed.size
+			total: needed.size,
+			drafts: live[locale]?.length ?? 0
 		});
 	}
 	return {
@@ -1871,10 +1937,11 @@ function formatStatusResult(result) {
 		lines.push("  no target locales (add locales to your config)");
 		return lines.join("\n");
 	}
-	for (const { locale, translated, total } of result.locales) {
+	for (const { locale, translated, total, drafts } 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}`);
+		const draftNote = drafts > 0 ? `, ${drafts} unreviewed` : "";
+		lines.push(`  ${locale}: ${translated}/${total} translated (${pct}%${draftNote})${mark}`);
 	}
 	return lines.join("\n");
 }
@@ -2132,6 +2199,6 @@ function line(node) {
 	return node.loc?.start?.line ?? 1;
 }
 //#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, createSourceFilter, detectBundler, doctor, exportCatalogs, extractProject, findConfigFile, formatCheckResult, formatStatusResult, generateDts, generateLocaleModule, generateRuntimeModule, githubCheckAnnotations, 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, wrapCode, wrapProject, writeCatalog, writeDts };
+export { DRAFTS_FILE, LOCALE_MODULE_PREFIX, MessageRegistry, PSEUDO_LOCALE, RESOLVED_VIRTUAL_ID, SFC_FILE_RE, SOURCE_FILE_RE, VIRTUAL_ID, analyze, analyzeFile, analyzeSfc, catalogPath, check, claudeProvider, clearDrafts, collectParams, createSourceFilter, detectBundler, doctor, effectiveDrafts, exportCatalogs, extractProject, findConfigFile, formatCheckResult, formatStatusResult, generateDts, generateLocaleModule, generateRuntimeModule, githubCheckAnnotations, importCatalogs, init, isMobileFormat, isTransformTarget, loadCatalogs, loadConfig, loadConfigFile, loadDrafts, loadVirtualModule, markDrafts, parseExchangeFile, pruneCatalogs, pseudoCatalogs, pseudoLocalize, readCatalog, renderHtml, renderParamType, renderSite, resolveConfig, resolveVirtualId, runBuildGate, saveDrafts, serializeCatalog, stableKey, status, structureMatches, syncCatalogs, targetLocales, transformCode, transformSource, translateCatalogs, watchProject, wrapCode, wrapProject, writeCatalog, writeDts };
 
 //# sourceMappingURL=index.js.map