@chipmobilesdk/rn-i18n 0.1.2 → 0.2.0

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

package/src/tooling/scan.ts

@@ -1,210 +1,193 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import type {
-	AmbiguousUsage,
-	KeyConflict,
-	PatternConfig,
-	SourceLocation,
-	TemplateKey,
-	TranslationTemplate,
-} from './types.ts';
-
-const IGNORED_DIRECTORIES = new Set([
-	'node_modules',
-	'.git',
-	'build',
-	'dist',
-	'Pods',
-]);
-
-/** Converts a glob (`**`, `*`, `?`, `{a,b}`) to an anchored RegExp. */
-export function globToRegExp(glob: string): RegExp {
-	let source = '';
-	let index = 0;
-	while (index < glob.length) {
-		const char = glob[index];
-		if (char === '*') {
-			if (glob[index + 1] === '*') {
-				// `**/` matches zero or more directories; trailing `**` matches all.
-				if (glob[index + 2] === '/') {
-					source += '(?:.*/)?';
-					index += 3;
-				} else {
-					source += '.*';
-					index += 2;
-				}
-				continue;
-			}
-			source += '[^/]*';
-		} else if (char === '?') {
-			source += '[^/]';
-		} else if (char === '{') {
-			const end = glob.indexOf('}', index);
-			if (end === -1) {
-				source += '\\{';
-			} else {
-				const alternatives = glob
-					.slice(index + 1, end)
-					.split(',')
-					.map(alternative =>
-						alternative.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'),
-					);
-				source += `(?:${alternatives.join('|')})`;
-				index = end;
-			}
-		} else {
-			source += char.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
-		}
-		index += 1;
-	}
-	return new RegExp(`^${source}$`);
-}
-
-function walkDirectory(rootDir: string, current: string, files: string[]): void {
-	for (const entry of fs.readdirSync(current, { withFileTypes: true })) {
-		if (entry.isDirectory()) {
-			if (!IGNORED_DIRECTORIES.has(entry.name)) {
-				walkDirectory(rootDir, path.join(current, entry.name), files);
-			}
-			continue;
-		}
-		if (entry.isFile()) {
-			files.push(
-				path.relative(rootDir, path.join(current, entry.name)).replace(/\\/g, '/'),
-			);
-		}
-	}
-}
-
-/** Lists project-relative source files matching the configured globs. */
-export function listSourceFiles(
-	rootDir: string,
-	sourceGlobs: readonly string[],
-): string[] {
-	const allFiles: string[] = [];
-	walkDirectory(rootDir, rootDir, allFiles);
-	const matchers = sourceGlobs.map(globToRegExp);
-	return allFiles
-		.filter(file => matchers.some(matcher => matcher.test(file)))
-		.sort();
-}
-
-function lineOfIndex(text: string, index: number): number {
-	let line = 1;
-	for (let position = 0; position < index && position < text.length; position += 1) {
-		if (text[position] === '\n') {
-			line += 1;
-		}
-	}
-	return line;
-}
-
-interface CompiledPattern {
-	keyRegex: RegExp;
-	ambiguousRegex?: RegExp;
-}
-
-function compilePatterns(patterns: readonly PatternConfig[]): CompiledPattern[] {
-	return patterns.map(pattern => {
-		const flags = [...new Set(`g${pattern.flags ?? ''}`)].join('');
-		return {
-			keyRegex: new RegExp(pattern.regex, flags),
-			ambiguousRegex: pattern.ambiguousRegex
-				? new RegExp(pattern.ambiguousRegex, flags)
-				: undefined,
-		};
-	});
-}
-
-/**
- * Scans the source tree with the app-configured i18n usage regex patterns and
- * builds the source-of-truth translation template: discovered keys with
- * default text and `file:line` locations, ambiguous dynamic usages, and
- * conflicting duplicate keys (FR-024…FR-026, FR-031).
- */
-export function scanSource(
-	rootDir: string,
-	sourceGlobs: readonly string[],
-	patterns: readonly PatternConfig[],
-): TranslationTemplate {
-	const compiled = compilePatterns(patterns);
-	const files = listSourceFiles(rootDir, sourceGlobs);
-	const keys = new Map<string, TemplateKey>();
-	const valuesByKey = new Map<string, { text: string; location: SourceLocation }[]>();
-	const ambiguous: AmbiguousUsage[] = [];
-
-	for (const file of files) {
-		const text = fs.readFileSync(path.join(rootDir, file), 'utf8');
-		const matchedSpans: [number, number][] = [];
-
-		for (const pattern of compiled) {
-			pattern.keyRegex.lastIndex = 0;
-			for (const match of text.matchAll(pattern.keyRegex)) {
-				const key = match.groups?.key;
-				if (!key) {
-					continue;
-				}
-				const startIndex = match.index ?? 0;
-				matchedSpans.push([startIndex, startIndex + match[0].length]);
-				const location: SourceLocation = {
-					file,
-					line: lineOfIndex(text, startIndex),
-				};
-				const existing = keys.get(key);
-				if (existing) {
-					existing.locations.push(location);
-				} else {
-					keys.set(key, { key, locations: [location] });
-				}
-				const defaultText = match.groups?.defaultText;
-				if (defaultText !== undefined) {
-					const values = valuesByKey.get(key) ?? [];
-					values.push({ text: defaultText, location });
-					valuesByKey.set(key, values);
-				}
-			}
-		}
-
-		for (const pattern of compiled) {
-			if (!pattern.ambiguousRegex) {
-				continue;
-			}
-			pattern.ambiguousRegex.lastIndex = 0;
-			for (const match of text.matchAll(pattern.ambiguousRegex)) {
-				const start = match.index ?? 0;
-				const overlapsKeyMatch = matchedSpans.some(
-					([from, to]) => start >= from && start < to,
-				);
-				if (overlapsKeyMatch) {
-					continue;
-				}
-				const lineNumber = lineOfIndex(text, start);
-				ambiguous.push({
-					file,
-					line: lineNumber,
-					snippet: text.split('\n')[lineNumber - 1]?.trim() ?? match[0],
-				});
-			}
-		}
-	}
-
-	const conflicts: KeyConflict[] = [];
-	for (const [key, values] of valuesByKey) {
-		const distinct = [...new Set(values.map(value => value.text))];
-		if (distinct.length > 1) {
-			conflicts.push({ key, values });
-		} else {
-			const templateKey = keys.get(key);
-			if (templateKey) {
-				templateKey.defaultText = values[0].text;
-			}
-		}
-	}
-
-	return {
-		keys: [...keys.values()].sort((a, b) => a.key.localeCompare(b.key)),
-		ambiguous,
-		conflicts: conflicts.sort((a, b) => a.key.localeCompare(b.key)),
-		scannedFiles: files.length,
-	};
-}
+import fs from 'node:fs';
+import path from 'node:path';
+import type {
+	AmbiguousUsage,
+	KeyConflict,
+	PatternConfig,
+	SourceLocation,
+	TemplateKey,
+	TranslationTemplate,
+} from './types.ts';
+
+const IGNORED_DIRECTORIES = new Set(['node_modules', '.git', 'build', 'dist', 'Pods']);
+
+/** Converts a glob (`**`, `*`, `?`, `{a,b}`) to an anchored RegExp. */
+export function globToRegExp(glob: string): RegExp {
+	let source = '';
+	let index = 0;
+	while (index < glob.length) {
+		const char = glob[index];
+		if (char === '*') {
+			if (glob[index + 1] === '*') {
+				// `**/` matches zero or more directories; trailing `**` matches all.
+				if (glob[index + 2] === '/') {
+					source += '(?:.*/)?';
+					index += 3;
+				} else {
+					source += '.*';
+					index += 2;
+				}
+				continue;
+			}
+			source += '[^/]*';
+		} else if (char === '?') {
+			source += '[^/]';
+		} else if (char === '{') {
+			const end = glob.indexOf('}', index);
+			if (end === -1) {
+				source += '\\{';
+			} else {
+				const alternatives = glob
+					.slice(index + 1, end)
+					.split(',')
+					.map(alternative => alternative.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'));
+				source += `(?:${alternatives.join('|')})`;
+				index = end;
+			}
+		} else {
+			source += char.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+		}
+		index += 1;
+	}
+	return new RegExp(`^${source}$`);
+}
+
+function walkDirectory(rootDir: string, current: string, files: string[]): void {
+	for (const entry of fs.readdirSync(current, { withFileTypes: true })) {
+		if (entry.isDirectory()) {
+			if (!IGNORED_DIRECTORIES.has(entry.name)) {
+				walkDirectory(rootDir, path.join(current, entry.name), files);
+			}
+			continue;
+		}
+		if (entry.isFile()) {
+			files.push(path.relative(rootDir, path.join(current, entry.name)).replace(/\\/g, '/'));
+		}
+	}
+}
+
+/** Lists project-relative source files matching the configured globs. */
+export function listSourceFiles(rootDir: string, sourceGlobs: readonly string[]): string[] {
+	const allFiles: string[] = [];
+	walkDirectory(rootDir, rootDir, allFiles);
+	const matchers = sourceGlobs.map(globToRegExp);
+	return allFiles.filter(file => matchers.some(matcher => matcher.test(file))).sort();
+}
+
+function lineOfIndex(text: string, index: number): number {
+	let line = 1;
+	for (let position = 0; position < index && position < text.length; position += 1) {
+		if (text[position] === '\n') {
+			line += 1;
+		}
+	}
+	return line;
+}
+
+interface CompiledPattern {
+	keyRegex: RegExp;
+	ambiguousRegex?: RegExp;
+}
+
+function compilePatterns(patterns: readonly PatternConfig[]): CompiledPattern[] {
+	return patterns.map(pattern => {
+		const flags = [...new Set(`g${pattern.flags ?? ''}`)].join('');
+		return {
+			keyRegex: new RegExp(pattern.regex, flags),
+			ambiguousRegex: pattern.ambiguousRegex
+				? new RegExp(pattern.ambiguousRegex, flags)
+				: undefined,
+		};
+	});
+}
+
+/**
+ * Scans the source tree with the app-configured i18n usage regex patterns and
+ * builds the source-of-truth translation template: discovered keys with
+ * default text and `file:line` locations, ambiguous dynamic usages, and
+ * conflicting duplicate keys (FR-024…FR-026, FR-031).
+ */
+export function scanSource(
+	rootDir: string,
+	sourceGlobs: readonly string[],
+	patterns: readonly PatternConfig[],
+): TranslationTemplate {
+	const compiled = compilePatterns(patterns);
+	const files = listSourceFiles(rootDir, sourceGlobs);
+	const keys = new Map<string, TemplateKey>();
+	const valuesByKey = new Map<string, { text: string; location: SourceLocation }[]>();
+	const ambiguous: AmbiguousUsage[] = [];
+
+	for (const file of files) {
+		const text = fs.readFileSync(path.join(rootDir, file), 'utf8');
+		const matchedSpans: [number, number][] = [];
+
+		for (const pattern of compiled) {
+			pattern.keyRegex.lastIndex = 0;
+			for (const match of text.matchAll(pattern.keyRegex)) {
+				const key = match.groups?.key;
+				if (!key) {
+					continue;
+				}
+				const startIndex = match.index ?? 0;
+				matchedSpans.push([startIndex, startIndex + match[0].length]);
+				const location: SourceLocation = {
+					file,
+					line: lineOfIndex(text, startIndex),
+				};
+				const existing = keys.get(key);
+				if (existing) {
+					existing.locations.push(location);
+				} else {
+					keys.set(key, { key, locations: [location] });
+				}
+				const defaultText = match.groups?.defaultText;
+				if (defaultText !== undefined) {
+					const values = valuesByKey.get(key) ?? [];
+					values.push({ text: defaultText, location });
+					valuesByKey.set(key, values);
+				}
+			}
+		}
+
+		for (const pattern of compiled) {
+			if (!pattern.ambiguousRegex) {
+				continue;
+			}
+			pattern.ambiguousRegex.lastIndex = 0;
+			for (const match of text.matchAll(pattern.ambiguousRegex)) {
+				const start = match.index ?? 0;
+				const overlapsKeyMatch = matchedSpans.some(([from, to]) => start >= from && start < to);
+				if (overlapsKeyMatch) {
+					continue;
+				}
+				const lineNumber = lineOfIndex(text, start);
+				ambiguous.push({
+					file,
+					line: lineNumber,
+					snippet: text.split('\n')[lineNumber - 1]?.trim() ?? match[0],
+				});
+			}
+		}
+	}
+
+	const conflicts: KeyConflict[] = [];
+	for (const [key, values] of valuesByKey) {
+		const distinct = [...new Set(values.map(value => value.text))];
+		if (distinct.length > 1) {
+			conflicts.push({ key, values });
+		} else {
+			const templateKey = keys.get(key);
+			if (templateKey) {
+				templateKey.defaultText = values[0].text;
+			}
+		}
+	}
+
+	return {
+		keys: [...keys.values()].sort((a, b) => a.key.localeCompare(b.key)),
+		ambiguous,
+		conflicts: conflicts.sort((a, b) => a.key.localeCompare(b.key)),
+		scannedFiles: files.length,
+	};
+}