import { mkdir, readFile, readdir } from "node:fs/promises"; import { i18nReportArtifactSchema } from "./contracts/release-artifacts.ts"; import { writeValidatedJsonArtifact } from "./lib/validated-json-artifact.ts"; import path from "node:path"; import { EN_MESSAGES, KO_MESSAGES, MESSAGE_CATALOGS } from "../src/presentation/i18n/catalog.ts"; const fixtureMode = process.argv.includes("--fixture"); const failures: string[] = []; const sourceExtensions = /\.(?:ts|tsx|mts|cts)$/; const rawFailureRender = /(? { const result: string[] = []; for (const entry of await readdir(directory, { withFileTypes: true })) { const target = path.join(directory, entry.name); if (entry.isDirectory()) result.push(...(await listSourceFiles(target))); else if (sourceExtensions.test(entry.name)) result.push(target); } return result; } function placeholders(template: string): string[] { return [...template.matchAll(/\{([a-zA-Z][a-zA-Z0-9]*)\}/g)] .map((match) => match[1]) .sort(); } if (!fixtureMode) { const canonicalKeys = Object.keys(KO_MESSAGES).sort(); for (const [locale, catalog] of Object.entries(MESSAGE_CATALOGS)) { const readableCatalog = catalog as Readonly>; const canonicalCatalog = KO_MESSAGES as Readonly>; const keys = Object.keys(catalog).sort(); if (JSON.stringify(keys) !== JSON.stringify(canonicalKeys)) { failures.push(`${locale} catalog keys do not match ko-KR`); } for (const key of canonicalKeys) { if ( JSON.stringify(placeholders(readableCatalog[key] ?? "")) !== JSON.stringify(placeholders(canonicalCatalog[key] ?? "")) ) { failures.push(`${locale}:${key} interpolation parameters do not match`); } } } if (Object.keys(EN_MESSAGES).length !== canonicalKeys.length) { failures.push("en-US catalog key count does not match ko-KR"); } } // 0929/08-02. Whether screen code takes its words from the catalog is an // ESLint rule now (eslint.config.ts, screenTextSelectors): this script looked // for Hangul anywhere in a file, so it rejected Korean comments and let English // copy through. Raw HTML is the FE-OC-019 ESLint rule. What stays here is // catalog parity and rendering a backend message, which a selector cannot tell // from an ordinary `.message` read. Fixture mode runs the ESLint rule on the // fixture trees too, so this one gate shows the whole i18n contract rejecting // every forbidden file and passing the allowed one. // `src/presentation/examples` (the platform overview) and the stories are // workshop code and stay out of the ESLint rule's scope on purpose. const forbiddenFixtureRoot = "tests/fixtures/i18n/forbidden"; const allowedFixtureRoot = "tests/fixtures/i18n/allowed"; const sourceRoot = fixtureMode ? forbiddenFixtureRoot : "."; const commonDirectories = [ "src/presentation/boundaries", "src/presentation/components", "src/presentation/design-system", "src/presentation/forms", "src/presentation/layouts", "src/presentation/pages", "src/presentation/routes", "src/presentation/templates", ]; async function featurePresentationDirectories(root: string): Promise { const features = path.join(root, "src/features"); const entries = await readdir(features, { withFileTypes: true }).catch( () => [], ); return entries .filter((entry) => entry.isDirectory()) .map((entry) => path.join("src/features", entry.name, "presentation")); } async function existingSourceFiles(directory: string): Promise { return listSourceFiles(directory).catch((error: NodeJS.ErrnoException) => { if (error.code === "ENOENT") return []; throw error; }); } const sourceDirectories = [ ...commonDirectories, ...(await featurePresentationDirectories(sourceRoot)), ].map((directory) => path.join(sourceRoot, directory)); const sources = ( await Promise.all(sourceDirectories.map(existingSourceFiles)) ).flat(); async function rawFailureRenders(files: readonly string[]): Promise { const found: string[] = []; for (const file of files) { if (rawFailureRender.test(await readFile(file, "utf8"))) { found.push(`raw backend/error message rendered in ${file}`); } } return found; } /** ESLint errors in a fixture tree, one entry per error, ending in the file. */ async function lintErrors(root: string): Promise { const { ESLint } = await import("eslint"); const results = await new ESLint({ ignore: false }).lintFiles([root]); return results.flatMap((result) => result.messages .filter((message) => message.severity === 2) .map( (message) => `${message.ruleId ?? "eslint"} ${message.line}:${message.column} ${message.message} in ${path.relative(process.cwd(), result.filePath)}`, ), ); } failures.push(...(await rawFailureRenders(sources))); if (fixtureMode) failures.push(...(await lintErrors(forbiddenFixtureRoot))); const allowedFixtureFailures = fixtureMode ? [ ...(await rawFailureRenders(await listSourceFiles(allowedFixtureRoot))), ...(await lintErrors(allowedFixtureRoot)), ] : []; const report = i18nReportArtifactSchema.parse({ schemaVersion: 1, mode: fixtureMode ? "negative-fixture" : "source", localeCount: Object.keys(MESSAGE_CATALOGS).length + 1, messageKeyCount: Object.keys(KO_MESSAGES).length, checkedFiles: sources.length, failures, passed: failures.length === 0, }); await mkdir("artifacts/quality", { recursive: true }); await writeValidatedJsonArtifact({ path: fixtureMode ? "artifacts/quality/i18n-fixture.json" : "artifacts/quality/i18n.json", schema: i18nReportArtifactSchema, value: report, }); // Every fixture file must be rejected on its own; one rejected file must not // hide a directory the discovery above stopped reaching. const fixtureFiles = fixtureMode ? await listSourceFiles(sourceRoot) : []; const unrejectedFixtures = fixtureFiles.filter( (file) => !failures.some((failure) => failure.endsWith(file)), ); if (fixtureMode && (fixtureFiles.length === 0 || unrejectedFixtures.length > 0)) { process.stderr.write( `I18n fixture was not rejected:\n${unrejectedFixtures.join("\n") || "(no fixture files found)"}\n`, ); process.exit(2); } // A comment, punctuation or catalog words must not be rejected (0929/08-02). if (allowedFixtureFailures.length > 0) { process.stderr.write( `I18n allowed fixture was rejected:\n${allowedFixtureFailures.join("\n")}\n`, ); process.exit(2); } if (failures.length > 0) { process.stderr.write(`I18n contract failed:\n${failures.join("\n")}\n`); process.exit(1); } process.stdout.write( `I18n contract: ${report.messageKeyCount} keys across ${report.localeCount} locales PASS\n`, );