82 lines
4.8 KiB
TypeScript
82 lines
4.8 KiB
TypeScript
/** Check shipped-language coverage of package metadata and plugin templates without loading plugins. */
|
|
import { existsSync, globSync, readFileSync } from 'node:fs'
|
|
import { basename, posix, join, resolve } from 'node:path'
|
|
import { detailPath } from '../packages/util/plugin-detail/src/document.ts'
|
|
import { PRODUCT_PACKAGE_POLICY } from './product-package-policy.ts'
|
|
import { SHIPPED_LOCALE_IDS, localeTokens, hasInvisibleLocaleCharacters } from './shipped-locales.ts'
|
|
import { collectConfigCatalog } from './gen-config-catalog.ts'
|
|
|
|
/** Flatten metadata strings and reject values that cannot be translated. */
|
|
function strings(value: unknown, key = ''): Record<string, string> {
|
|
if (typeof value === 'string' && value.trim() !== '') return { [key]: value }
|
|
if (typeof value !== 'object' || value === null || Array.isArray(value)) throw new Error(`${key}: expected non-empty text`)
|
|
return Object.fromEntries(Object.entries(value).flatMap(([name, child]) => Object.entries(strings(child, key ? `${key}.${name}` : name))))
|
|
}
|
|
|
|
/**
|
|
* Compare shipped-language metadata with every field supplied by English or Chinese.
|
|
* @param root - repository or fixture root.
|
|
* @returns actionable missing-file, field, placeholder and resource diagnostics.
|
|
*/
|
|
export function localeMetadataProblems(root: string): string[] {
|
|
const directories = new Set(globSync('packages/**/locale/**/*.json', {
|
|
cwd: root, exclude: ['packages/**/node_modules/**', 'packages/**/lib/**', 'packages/**/tests/**'],
|
|
}).map(file => file.replaceAll('\\', '/')).filter(file => SHIPPED_LOCALE_IDS.some(language => basename(file) === `${language}.json`)).map(file => posix.dirname(file)))
|
|
for (const entry of collectConfigCatalog(root)) {
|
|
const dir = entry.dir.replaceAll('\\', '/')
|
|
if (PRODUCT_PACKAGE_POLICY[dir]?.category === 'test') continue
|
|
if (entry.kind !== 'config' && entry.kind !== 'no-config') continue
|
|
const directory = `${dir}/locale`
|
|
directories.add(directory)
|
|
}
|
|
const problems: string[] = []
|
|
if (directories.size === 0) return ['no package locale metadata found']
|
|
for (const directory of [...directories].sort()) {
|
|
try {
|
|
const read = (language: string): Record<string, string> => {
|
|
const file = join(root, directory, `${language}.json`)
|
|
const source = readFileSync(file, 'utf8')
|
|
if (hasInvisibleLocaleCharacters(source) || /\\u(?:200b|feff)/iu.test(source)) throw new Error(`${language}.json: invisible locale character`)
|
|
const value: unknown = JSON.parse(source)
|
|
const dictionary = strings(value)
|
|
const detail = detailPath(dictionary['meta.detail'], `${directory}/${language}.json: meta.detail`)
|
|
const packageDir = directory.slice(0, directory.lastIndexOf('/locale'))
|
|
if (detail !== undefined && !existsSync(resolve(root, packageDir, detail))) {
|
|
throw new Error(`missing detail resource ${detail}`)
|
|
}
|
|
return dictionary
|
|
}
|
|
const en = read('en')
|
|
const zh = existsSync(join(root, directory, 'zh.json')) ? read('zh') : {}
|
|
const description = en['meta.description']
|
|
if (description !== undefined && !/[.!?]$/u.test(description)) problems.push(`${directory}/en.json: meta.description must end with sentence punctuation`)
|
|
const expected = { ...zh, ...en }
|
|
for (const language of SHIPPED_LOCALE_IDS.filter(id => id !== 'en' && id !== 'zh')) {
|
|
const translated = read(language)
|
|
for (const key of new Set([...Object.keys(expected), ...Object.keys(translated)])) {
|
|
if (translated[key] === undefined) problems.push(`${directory}/${language}.json: missing ${key}`)
|
|
else if (expected[key] === undefined) problems.push(`${directory}/${language}.json: unexpected ${key}`)
|
|
else {
|
|
if (language !== 'ja' && key === 'meta.description' && ((zh[key] !== undefined && /\p{Script=Han}/u.test(zh[key]) && translated[key] === zh[key])
|
|
|| (en[key] !== undefined && translated[key] === en[key]))) {
|
|
problems.push(`${directory}/${language}.json: ${key} contains untranslated source text`)
|
|
}
|
|
const placeholders = (text: string): string => localeTokens(text).join(',')
|
|
if (placeholders(translated[key]) !== placeholders(expected[key])) problems.push(`${directory}/${language}.json: ${key} changes placeholders or literal tokens`)
|
|
}
|
|
}
|
|
}
|
|
} catch (error) {
|
|
problems.push(`${directory}: ${error instanceof Error ? error.message : String(error)}`)
|
|
}
|
|
}
|
|
return problems
|
|
}
|
|
|
|
if (import.meta.filename === resolve(process.argv[1] ?? '')) {
|
|
const problems = localeMetadataProblems(resolve(import.meta.dirname, '..'))
|
|
for (const problem of problems) console.error(problem)
|
|
if (problems.length > 0) process.exitCode = 1
|
|
else console.log('verify-locale-metadata: all package and template metadata has complete shipped-language translations.')
|
|
}
|