@chipmobilesdk/rn-i18n 0.1.1 → 0.1.3

package/src/tooling/index.ts

@@ -1,32 +1,27 @@
-/**
- * Programmatic surface of the Node-only extraction and synchronization
- * tooling, exposed as `@chipmobilesdk/rn-i18n/tooling`. This entrypoint must
- * never be imported from React Native code; the runtime API lives at the
- * package root (LIB-003).
- */
-
-export { globToRegExp, listSourceFiles, scanSource } from './scan.ts';
-export { flattenTranslations, nestTranslations, syncLocaleFiles } from './sync.ts';
-export { buildReport, renderReport } from './report.ts';
-export { generateKeysFile, renderKeysModule } from './generateKeys.ts';
-export type { GenerateKeysResult } from './generateKeys.ts';
-export {
-	SyncConfigError,
-	loadRuntimeEntries,
-	runSync,
-	validateSyncConfig,
-} from './runner.ts';
-export type { SyncRunResult } from './runner.ts';
-export type {
-	AmbiguousUsage,
-	ExtractionReport,
-	KeyConflict,
-	LocaleSyncResult,
-	PatternConfig,
-	ReportOutcome,
-	RuntimeEntryConfig,
-	SourceLocation,
-	SyncConfig,
-	TemplateKey,
-	TranslationTemplate,
-} from './types.ts';
+/**
+ * Programmatic surface of the Node-only extraction and synchronization
+ * tooling, exposed as `@chipmobilesdk/rn-i18n/tooling`. This entrypoint must
+ * never be imported from React Native code; the runtime API lives at the
+ * package root (LIB-003).
+ */
+
+export { globToRegExp, listSourceFiles, scanSource } from './scan.ts';
+export { flattenTranslations, nestTranslations, syncLocaleFiles } from './sync.ts';
+export { buildReport, renderReport } from './report.ts';
+export { generateKeysFile, renderKeysModule } from './generateKeys.ts';
+export type { GenerateKeysResult } from './generateKeys.ts';
+export { SyncConfigError, loadRuntimeEntries, runSync, validateSyncConfig } from './runner.ts';
+export type { SyncRunResult } from './runner.ts';
+export type {
+	AmbiguousUsage,
+	ExtractionReport,
+	KeyConflict,
+	LocaleSyncResult,
+	PatternConfig,
+	ReportOutcome,
+	RuntimeEntryConfig,
+	SourceLocation,
+	SyncConfig,
+	TemplateKey,
+	TranslationTemplate,
+} from './types.ts';

package/src/tooling/report.ts

@@ -1,117 +1,109 @@
-import type {
-	ExtractionReport,
-	LocaleSyncResult,
-	ReportOutcome,
-	RuntimeEntryConfig,
-	TranslationTemplate,
-} from './types.ts';
-
-function perLocale(
-	results: readonly LocaleSyncResult[],
-	select: (result: LocaleSyncResult) => string[],
-): Record<string, string[]> {
-	const record: Record<string, string[]> = {};
-	for (const result of results) {
-		record[result.locale] = select(result);
-	}
-	return record;
-}
-
-/**
- * Assembles the extraction/synchronization report distinguishing scanned
- * template keys, runtime-only keys, stale removals, ambiguous usages, and
- * conflicts (FR-026, FR-036).
- */
-export function buildReport(
-	template: TranslationTemplate,
-	syncResults: readonly LocaleSyncResult[],
-	runtimeEntries: readonly RuntimeEntryConfig[],
-): ExtractionReport {
-	const errors = syncResults
-		.filter(result => result.error)
-		.map(result => result.error!);
-
-	let outcome: ReportOutcome = 'success';
-	if (
-		template.ambiguous.length > 0 ||
-		syncResults.some(
-			result => result.addedKeys.length > 0 || result.runtimeReported.length > 0,
-		)
-	) {
-		outcome = 'completedWithWarnings';
-	}
-	if (errors.length > 0 || template.conflicts.length > 0) {
-		outcome = 'failed';
-	}
-
-	return {
-		outcome,
-		discovered: template.keys.map(key => ({
-			key: key.key,
-			defaultText: key.defaultText,
-			locations: key.locations.map(
-				location => `${location.file}:${location.line}`,
-			),
-		})),
-		createdLocaleFiles: syncResults
-			.filter(result => result.created && !result.error)
-			.map(result => ({ locale: result.locale, filePath: result.filePath })),
-		addedKeys: perLocale(syncResults, result => result.addedKeys),
-		preservedKeys: perLocale(syncResults, result => result.preservedKeys),
-		removedStaleKeys: perLocale(syncResults, result => result.removedKeys),
-		missingPerLocale: perLocale(syncResults, result =>
-			[...result.addedKeys, ...result.runtimeAdded, ...result.runtimeReported].sort(
-				(a, b) => a.localeCompare(b, 'en'),
-			),
-		),
-		runtimeOnly: {
-			declared: runtimeEntries.map(entry => entry.key),
-			preserved: perLocale(syncResults, result => result.runtimePreserved),
-			added: perLocale(syncResults, result => result.runtimeAdded),
-			reported: perLocale(syncResults, result => result.runtimeReported),
-		},
-		ambiguous: template.ambiguous,
-		conflicts: template.conflicts,
-		errors,
-	};
-}
-
-/** Renders the report as readable text for CLI output. */
-export function renderReport(report: ExtractionReport): string {
-	const lines: string[] = [];
-	lines.push(`i18n sync outcome: ${report.outcome}`);
-	lines.push(`Discovered keys: ${report.discovered.length}`);
-	for (const created of report.createdLocaleFiles) {
-		lines.push(`Created locale file: ${created.locale} -> ${created.filePath}`);
-	}
-	for (const [locale, keys] of Object.entries(report.addedKeys)) {
-		if (keys.length > 0) {
-			lines.push(`Added [${locale}]: ${keys.join(', ')}`);
-		}
-	}
-	for (const [locale, keys] of Object.entries(report.removedStaleKeys)) {
-		if (keys.length > 0) {
-			lines.push(`Removed stale [${locale}]: ${keys.join(', ')}`);
-		}
-	}
-	for (const [locale, keys] of Object.entries(report.runtimeOnly.reported)) {
-		if (keys.length > 0) {
-			lines.push(`Runtime-only missing [${locale}]: ${keys.join(', ')}`);
-		}
-	}
-	for (const usage of report.ambiguous) {
-		lines.push(
-			`Ambiguous usage at ${usage.file}:${usage.line}: ${usage.snippet}`,
-		);
-	}
-	for (const conflict of report.conflicts) {
-		const sources = conflict.values
-			.map(value => `"${value.text}" (${value.location.file}:${value.location.line})`)
-			.join(' vs ');
-		lines.push(`Conflict for key "${conflict.key}": ${sources}`);
-	}
-	for (const error of report.errors) {
-		lines.push(`Error: ${error}`);
-	}
-	return lines.join('\n');
-}
+import type {
+	ExtractionReport,
+	LocaleSyncResult,
+	ReportOutcome,
+	RuntimeEntryConfig,
+	TranslationTemplate,
+} from './types.ts';
+
+function perLocale(
+	results: readonly LocaleSyncResult[],
+	select: (result: LocaleSyncResult) => string[],
+): Record<string, string[]> {
+	const record: Record<string, string[]> = {};
+	for (const result of results) {
+		record[result.locale] = select(result);
+	}
+	return record;
+}
+
+/**
+ * Assembles the extraction/synchronization report distinguishing scanned
+ * template keys, runtime-only keys, stale removals, ambiguous usages, and
+ * conflicts (FR-026, FR-036).
+ */
+export function buildReport(
+	template: TranslationTemplate,
+	syncResults: readonly LocaleSyncResult[],
+	runtimeEntries: readonly RuntimeEntryConfig[],
+): ExtractionReport {
+	const errors = syncResults.filter(result => result.error).map(result => result.error!);
+
+	let outcome: ReportOutcome = 'success';
+	if (
+		template.ambiguous.length > 0 ||
+		syncResults.some(result => result.addedKeys.length > 0 || result.runtimeReported.length > 0)
+	) {
+		outcome = 'completedWithWarnings';
+	}
+	if (errors.length > 0 || template.conflicts.length > 0) {
+		outcome = 'failed';
+	}
+
+	return {
+		outcome,
+		discovered: template.keys.map(key => ({
+			key: key.key,
+			defaultText: key.defaultText,
+			locations: key.locations.map(location => `${location.file}:${location.line}`),
+		})),
+		createdLocaleFiles: syncResults
+			.filter(result => result.created && !result.error)
+			.map(result => ({ locale: result.locale, filePath: result.filePath })),
+		addedKeys: perLocale(syncResults, result => result.addedKeys),
+		preservedKeys: perLocale(syncResults, result => result.preservedKeys),
+		removedStaleKeys: perLocale(syncResults, result => result.removedKeys),
+		missingPerLocale: perLocale(syncResults, result =>
+			[...result.addedKeys, ...result.runtimeAdded, ...result.runtimeReported].sort((a, b) =>
+				a.localeCompare(b, 'en'),
+			),
+		),
+		runtimeOnly: {
+			declared: runtimeEntries.map(entry => entry.key),
+			preserved: perLocale(syncResults, result => result.runtimePreserved),
+			added: perLocale(syncResults, result => result.runtimeAdded),
+			reported: perLocale(syncResults, result => result.runtimeReported),
+		},
+		ambiguous: template.ambiguous,
+		conflicts: template.conflicts,
+		errors,
+	};
+}
+
+/** Renders the report as readable text for CLI output. */
+export function renderReport(report: ExtractionReport): string {
+	const lines: string[] = [];
+	lines.push(`i18n sync outcome: ${report.outcome}`);
+	lines.push(`Discovered keys: ${report.discovered.length}`);
+	for (const created of report.createdLocaleFiles) {
+		lines.push(`Created locale file: ${created.locale} -> ${created.filePath}`);
+	}
+	for (const [locale, keys] of Object.entries(report.addedKeys)) {
+		if (keys.length > 0) {
+			lines.push(`Added [${locale}]: ${keys.join(', ')}`);
+		}
+	}
+	for (const [locale, keys] of Object.entries(report.removedStaleKeys)) {
+		if (keys.length > 0) {
+			lines.push(`Removed stale [${locale}]: ${keys.join(', ')}`);
+		}
+	}
+	for (const [locale, keys] of Object.entries(report.runtimeOnly.reported)) {
+		if (keys.length > 0) {
+			lines.push(`Runtime-only missing [${locale}]: ${keys.join(', ')}`);
+		}
+	}
+	for (const usage of report.ambiguous) {
+		lines.push(`Ambiguous usage at ${usage.file}:${usage.line}: ${usage.snippet}`);
+	}
+	for (const conflict of report.conflicts) {
+		const sources = conflict.values
+			.map(value => `"${value.text}" (${value.location.file}:${value.location.line})`)
+			.join(' vs ');
+		lines.push(`Conflict for key "${conflict.key}": ${sources}`);
+	}
+	for (const error of report.errors) {
+		lines.push(`Error: ${error}`);
+	}
+	return lines.join('\n');
+}

package/src/tooling/runner.ts

@@ -1,126 +1,111 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import { pathToFileURL } from 'node:url';
-import { scanSource } from './scan.ts';
-import { syncLocaleFiles } from './sync.ts';
-import { buildReport } from './report.ts';
-import { generateKeysFile } from './generateKeys.ts';
-import type {
-	ExtractionReport,
-	RuntimeEntryConfig,
-	SyncConfig,
-} from './types.ts';
-
-export class SyncConfigError extends Error {
-	constructor(message: string) {
-		super(message);
-		this.name = 'SyncConfigError';
-	}
-}
-
-export function validateSyncConfig(config: SyncConfig): void {
-	const issues: string[] = [];
-	if (!Array.isArray(config.sourceGlobs) || config.sourceGlobs.length === 0) {
-		issues.push('`sourceGlobs` must list at least one glob.');
-	}
-	if (!Array.isArray(config.patterns) || config.patterns.length === 0) {
-		issues.push('`patterns` must list at least one regex pattern.');
-	} else {
-		for (const pattern of config.patterns) {
-			if (!pattern.regex?.includes('(?<key>')) {
-				issues.push(
-					`Pattern "${pattern.regex}" must contain a named (?<key>...) capture group.`,
-				);
-			}
-		}
-	}
-	if (!config.localesDir) {
-		issues.push('`localesDir` is required.');
-	}
-	if (!Array.isArray(config.locales) || config.locales.length === 0) {
-		issues.push('`locales` must list every supported locale.');
-	}
-	if (issues.length > 0) {
-		throw new SyncConfigError(
-			`Invalid i18n sync configuration:\n- ${issues.join('\n- ')}`,
-		);
-	}
-}
-
-/**
- * Loads declared runtime-only entries from the configured module. Accepts a
- * default export or a named `runtimeEntries` export. The module must use
- * type-only imports so it can run under Node's TypeScript type stripping.
- */
-export async function loadRuntimeEntries(
-	rootDir: string,
-	runtimeEntriesFile: string | undefined,
-): Promise<RuntimeEntryConfig[]> {
-	if (!runtimeEntriesFile) {
-		return [];
-	}
-	const absolutePath = path.resolve(rootDir, runtimeEntriesFile);
-	if (!fs.existsSync(absolutePath)) {
-		throw new SyncConfigError(
-			`Runtime entries file not found: ${runtimeEntriesFile}`,
-		);
-	}
-	const module = (await import(pathToFileURL(absolutePath).href)) as {
-		default?: RuntimeEntryConfig[];
-		runtimeEntries?: RuntimeEntryConfig[];
-	};
-	const entries = module.default ?? module.runtimeEntries;
-	if (!Array.isArray(entries)) {
-		throw new SyncConfigError(
-			`Runtime entries file must export an entry array (default or \`runtimeEntries\`): ${runtimeEntriesFile}`,
-		);
-	}
-	return entries;
-}
-
-export interface SyncRunResult {
-	report: ExtractionReport;
-	generatedKeysChanged: boolean;
-}
-
-/**
- * Full pipeline: scan the source tree, synchronize every locale JSON file,
- * regenerate the typed key artifact, and assemble the report.
- */
-export async function runSync(
-	rootDir: string,
-	config: SyncConfig,
-	runtimeEntriesOverride?: readonly RuntimeEntryConfig[],
-): Promise<SyncRunResult> {
-	validateSyncConfig(config);
-	const runtimeEntries =
-		runtimeEntriesOverride ??
-		(await loadRuntimeEntries(rootDir, config.runtimeEntriesFile));
-
-	const template = scanSource(rootDir, config.sourceGlobs, config.patterns);
-	const syncResults = syncLocaleFiles(rootDir, config, template, runtimeEntries);
-	const report = buildReport(template, syncResults, runtimeEntries);
-
-	let generatedKeysChanged = false;
-	if (config.generateKeysFile) {
-		generatedKeysChanged = generateKeysFile(
-			rootDir,
-			config.generateKeysFile,
-			template,
-			runtimeEntries,
-			config.keysTypeName,
-		).changed;
-	}
-
-	if (config.reportPath) {
-		const reportPath = path.resolve(rootDir, config.reportPath);
-		fs.mkdirSync(path.dirname(reportPath), { recursive: true });
-		fs.writeFileSync(
-			reportPath,
-			`${JSON.stringify(report, null, '\t')}\n`,
-			'utf8',
-		);
-	}
-
-	return { report, generatedKeysChanged };
-}
+import fs from 'node:fs';
+import path from 'node:path';
+import { pathToFileURL } from 'node:url';
+import { scanSource } from './scan.ts';
+import { syncLocaleFiles } from './sync.ts';
+import { buildReport } from './report.ts';
+import { generateKeysFile } from './generateKeys.ts';
+import type { ExtractionReport, RuntimeEntryConfig, SyncConfig } from './types.ts';
+
+export class SyncConfigError extends Error {
+	constructor(message: string) {
+		super(message);
+		this.name = 'SyncConfigError';
+	}
+}
+
+export function validateSyncConfig(config: SyncConfig): void {
+	const issues: string[] = [];
+	if (!Array.isArray(config.sourceGlobs) || config.sourceGlobs.length === 0) {
+		issues.push('`sourceGlobs` must list at least one glob.');
+	}
+	if (!Array.isArray(config.patterns) || config.patterns.length === 0) {
+		issues.push('`patterns` must list at least one regex pattern.');
+	} else {
+		for (const pattern of config.patterns) {
+			if (!pattern.regex?.includes('(?<key>')) {
+				issues.push(`Pattern "${pattern.regex}" must contain a named (?<key>...) capture group.`);
+			}
+		}
+	}
+	if (!config.localesDir) {
+		issues.push('`localesDir` is required.');
+	}
+	if (!Array.isArray(config.locales) || config.locales.length === 0) {
+		issues.push('`locales` must list every supported locale.');
+	}
+	if (issues.length > 0) {
+		throw new SyncConfigError(`Invalid i18n sync configuration:\n- ${issues.join('\n- ')}`);
+	}
+}
+
+/**
+ * Loads declared runtime-only entries from the configured module. Accepts a
+ * default export or a named `runtimeEntries` export. The module must use
+ * type-only imports so it can run under Node's TypeScript type stripping.
+ */
+export async function loadRuntimeEntries(
+	rootDir: string,
+	runtimeEntriesFile: string | undefined,
+): Promise<RuntimeEntryConfig[]> {
+	if (!runtimeEntriesFile) {
+		return [];
+	}
+	const absolutePath = path.resolve(rootDir, runtimeEntriesFile);
+	if (!fs.existsSync(absolutePath)) {
+		throw new SyncConfigError(`Runtime entries file not found: ${runtimeEntriesFile}`);
+	}
+	const module = (await import(pathToFileURL(absolutePath).href)) as {
+		default?: RuntimeEntryConfig[];
+		runtimeEntries?: RuntimeEntryConfig[];
+	};
+	const entries = module.default ?? module.runtimeEntries;
+	if (!Array.isArray(entries)) {
+		throw new SyncConfigError(
+			`Runtime entries file must export an entry array (default or \`runtimeEntries\`): ${runtimeEntriesFile}`,
+		);
+	}
+	return entries;
+}
+
+export interface SyncRunResult {
+	report: ExtractionReport;
+	generatedKeysChanged: boolean;
+}
+
+/**
+ * Full pipeline: scan the source tree, synchronize every locale JSON file,
+ * regenerate the typed key artifact, and assemble the report.
+ */
+export async function runSync(
+	rootDir: string,
+	config: SyncConfig,
+	runtimeEntriesOverride?: readonly RuntimeEntryConfig[],
+): Promise<SyncRunResult> {
+	validateSyncConfig(config);
+	const runtimeEntries =
+		runtimeEntriesOverride ?? (await loadRuntimeEntries(rootDir, config.runtimeEntriesFile));
+
+	const template = scanSource(rootDir, config.sourceGlobs, config.patterns);
+	const syncResults = syncLocaleFiles(rootDir, config, template, runtimeEntries);
+	const report = buildReport(template, syncResults, runtimeEntries);
+
+	let generatedKeysChanged = false;
+	if (config.generateKeysFile) {
+		generatedKeysChanged = generateKeysFile(
+			rootDir,
+			config.generateKeysFile,
+			template,
+			runtimeEntries,
+			config.keysTypeName,
+		).changed;
+	}
+
+	if (config.reportPath) {
+		const reportPath = path.resolve(rootDir, config.reportPath);
+		fs.mkdirSync(path.dirname(reportPath), { recursive: true });
+		fs.writeFileSync(reportPath, `${JSON.stringify(report, null, '\t')}\n`, 'utf8');
+	}
+
+	return { report, generatedKeysChanged };
+}