@chipmobilesdk/rn-i18n 0.1.2 → 0.2.0

package/src/tooling/generateKeys.ts

@@ -1,68 +1,62 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import type { RuntimeEntryConfig, TranslationTemplate } from './types.ts';
-
-/**
- * Renders the typed key contract: the union of scanned template keys and
- * declared runtime-only keys (FR-041). Apps bind lookups to the generated
- * type so `tsc --noEmit` reports invalid or stale key usage before release.
- */
-export function renderKeysModule(
-	template: TranslationTemplate,
-	runtimeEntries: readonly RuntimeEntryConfig[],
-	typeName = 'AppI18nKey',
-): string {
-	const templateKeys = template.keys
-		.map(key => key.key)
-		.sort((a, b) => a.localeCompare(b, 'en'));
-	const runtimeKeys = runtimeEntries
-		.map(entry => entry.key)
-		.sort((a, b) => a.localeCompare(b, 'en'));
-
-	const renderList = (keys: readonly string[]) =>
-		keys.length === 0
-			? '[]'
-			: `[\n${keys.map(key => `\t'${key}',`).join('\n')}\n]`;
-
-	return [
-		'// AUTO-GENERATED by @chipmobilesdk/rn-i18n tooling. Do not edit by hand.',
-		'// Regenerate with: npm run i18n:sync',
-		'',
-		`export const I18N_TEMPLATE_KEYS = ${renderList(templateKeys)} as const;`,
-		'',
-		`export const I18N_RUNTIME_ONLY_KEYS = ${renderList(runtimeKeys)} as const;`,
-		'',
-		'export const I18N_KEYS = [',
-		'\t...I18N_TEMPLATE_KEYS,',
-		'\t...I18N_RUNTIME_ONLY_KEYS,',
-		'] as const;',
-		'',
-		`export type ${typeName} = (typeof I18N_KEYS)[number];`,
-		'',
-	].join('\n');
-}
-
-export interface GenerateKeysResult {
-	filePath: string;
-	changed: boolean;
-}
-
-/** Writes the typed key artifact and reports whether it changed (staleness). */
-export function generateKeysFile(
-	rootDir: string,
-	relativePath: string,
-	template: TranslationTemplate,
-	runtimeEntries: readonly RuntimeEntryConfig[],
-	typeName?: string,
-): GenerateKeysResult {
-	const filePath = path.join(rootDir, relativePath);
-	const content = renderKeysModule(template, runtimeEntries, typeName);
-	const previous = fs.existsSync(filePath)
-		? fs.readFileSync(filePath, 'utf8')
-		: undefined;
-	if (previous !== content) {
-		fs.mkdirSync(path.dirname(filePath), { recursive: true });
-		fs.writeFileSync(filePath, content, 'utf8');
-	}
-	return { filePath, changed: previous !== content };
-}
+import fs from 'node:fs';
+import path from 'node:path';
+import type { RuntimeEntryConfig, TranslationTemplate } from './types.ts';
+
+/**
+ * Renders the typed key contract: the union of scanned template keys and
+ * declared runtime-only keys (FR-041). Apps bind lookups to the generated
+ * type so `tsc --noEmit` reports invalid or stale key usage before release.
+ */
+export function renderKeysModule(
+	template: TranslationTemplate,
+	runtimeEntries: readonly RuntimeEntryConfig[],
+	typeName = 'AppI18nKey',
+): string {
+	const templateKeys = template.keys.map(key => key.key).sort((a, b) => a.localeCompare(b, 'en'));
+	const runtimeKeys = runtimeEntries
+		.map(entry => entry.key)
+		.sort((a, b) => a.localeCompare(b, 'en'));
+
+	const renderList = (keys: readonly string[]) =>
+		keys.length === 0 ? '[]' : `[\n${keys.map(key => `\t'${key}',`).join('\n')}\n]`;
+
+	return [
+		'// AUTO-GENERATED by @chipmobilesdk/rn-i18n tooling. Do not edit by hand.',
+		'// Regenerate with: npm run i18n:sync',
+		'',
+		`export const I18N_TEMPLATE_KEYS = ${renderList(templateKeys)} as const;`,
+		'',
+		`export const I18N_RUNTIME_ONLY_KEYS = ${renderList(runtimeKeys)} as const;`,
+		'',
+		'export const I18N_KEYS = [',
+		'\t...I18N_TEMPLATE_KEYS,',
+		'\t...I18N_RUNTIME_ONLY_KEYS,',
+		'] as const;',
+		'',
+		`export type ${typeName} = (typeof I18N_KEYS)[number];`,
+		'',
+	].join('\n');
+}
+
+export interface GenerateKeysResult {
+	filePath: string;
+	changed: boolean;
+}
+
+/** Writes the typed key artifact and reports whether it changed (staleness). */
+export function generateKeysFile(
+	rootDir: string,
+	relativePath: string,
+	template: TranslationTemplate,
+	runtimeEntries: readonly RuntimeEntryConfig[],
+	typeName?: string,
+): GenerateKeysResult {
+	const filePath = path.join(rootDir, relativePath);
+	const content = renderKeysModule(template, runtimeEntries, typeName);
+	const previous = fs.existsSync(filePath) ? fs.readFileSync(filePath, 'utf8') : undefined;
+	if (previous !== content) {
+		fs.mkdirSync(path.dirname(filePath), { recursive: true });
+		fs.writeFileSync(filePath, content, 'utf8');
+	}
+	return { filePath, changed: previous !== content };
+}

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');
+}