@formatjs/cli-lib 8.0.8 → 8.1.1

package/src/pseudo_locale.js

@@ -1,115 +1,231 @@
-import { parse, TYPE, isLiteralElement, isPluralElement, isSelectElement, isTagElement, } from '@formatjs/icu-messageformat-parser';
+import { parse, TYPE, isLiteralElement, isPluralElement, isSelectElement, isTagElement } from "@formatjs/icu-messageformat-parser";
 function forEachLiteralElement(ast, fn) {
-    ast.forEach(el => {
-        if (isLiteralElement(el)) {
-            fn(el);
-        }
-        else if (isPluralElement(el) || isSelectElement(el)) {
-            for (const opt of Object.values(el.options)) {
-                forEachLiteralElement(opt.value, fn);
-            }
-        }
-        else if (isTagElement(el)) {
-            forEachLiteralElement(el.children, fn);
-        }
-    });
+	ast.forEach((el) => {
+		if (isLiteralElement(el)) {
+			fn(el);
+		} else if (isPluralElement(el) || isSelectElement(el)) {
+			for (const opt of Object.values(el.options)) {
+				forEachLiteralElement(opt.value, fn);
+			}
+		} else if (isTagElement(el)) {
+			forEachLiteralElement(el.children, fn);
+		}
+	});
 }
 export function generateXXLS(msg) {
-    const ast = typeof msg === 'string' ? parse(msg) : msg;
-    const lastChunk = ast[ast.length - 1];
-    if (lastChunk && isLiteralElement(lastChunk)) {
-        lastChunk.value += 'SSSSSSSSSSSSSSSSSSSSSSSSS';
-        return ast;
-    }
-    return [...ast, { type: TYPE.literal, value: 'SSSSSSSSSSSSSSSSSSSSSSSSS' }];
+	const ast = typeof msg === "string" ? parse(msg) : msg;
+	const lastChunk = ast[ast.length - 1];
+	if (lastChunk && isLiteralElement(lastChunk)) {
+		lastChunk.value += "SSSSSSSSSSSSSSSSSSSSSSSSS";
+		return ast;
+	}
+	return [...ast, {
+		type: TYPE.literal,
+		value: "SSSSSSSSSSSSSSSSSSSSSSSSS"
+	}];
 }
 export function generateXXAC(msg) {
-    const ast = typeof msg === 'string' ? parse(msg) : msg;
-    forEachLiteralElement(ast, el => {
-        el.value = el.value.toUpperCase();
-    });
-    return ast;
+	const ast = typeof msg === "string" ? parse(msg) : msg;
+	forEachLiteralElement(ast, (el) => {
+		el.value = el.value.toUpperCase();
+	});
+	return ast;
 }
 export function generateXXHA(msg) {
-    const ast = typeof msg === 'string' ? parse(msg) : msg;
-    const [firstChunk, ...rest] = ast;
-    if (firstChunk && isLiteralElement(firstChunk)) {
-        firstChunk.value = '[javascript]' + firstChunk.value;
-        return [firstChunk, ...rest];
-    }
-    return [{ type: TYPE.literal, value: '[javascript]' }, ...ast];
+	const ast = typeof msg === "string" ? parse(msg) : msg;
+	const [firstChunk, ...rest] = ast;
+	if (firstChunk && isLiteralElement(firstChunk)) {
+		firstChunk.value = "[javascript]" + firstChunk.value;
+		return [firstChunk, ...rest];
+	}
+	return [{
+		type: TYPE.literal,
+		value: "[javascript]"
+	}, ...ast];
 }
 const ACCENTED_MAP = {
-    // ȦƁƇḒḖƑƓĦĪĴĶĿḾȠǾƤɊŘŞŦŬṼẆẊẎẐ
-    // prettier-ignore
-    "caps": [550, 385, 391, 7698, 7702, 401, 403, 294, 298, 308, 310, 319, 7742, 544, 510, 420, 586, 344, 350, 358, 364, 7804, 7814, 7818, 7822, 7824],
-    // ȧƀƈḓḗƒɠħīĵķŀḿƞǿƥɋřşŧŭṽẇẋẏẑ
-    // prettier-ignore
-    "small": [551, 384, 392, 7699, 7703, 402, 608, 295, 299, 309, 311, 320, 7743, 414, 511, 421, 587, 345, 351, 359, 365, 7805, 7815, 7819, 7823, 7825],
+	"caps": [
+		550,
+		385,
+		391,
+		7698,
+		7702,
+		401,
+		403,
+		294,
+		298,
+		308,
+		310,
+		319,
+		7742,
+		544,
+		510,
+		420,
+		586,
+		344,
+		350,
+		358,
+		364,
+		7804,
+		7814,
+		7818,
+		7822,
+		7824
+	],
+	"small": [
+		551,
+		384,
+		392,
+		7699,
+		7703,
+		402,
+		608,
+		295,
+		299,
+		309,
+		311,
+		320,
+		7743,
+		414,
+		511,
+		421,
+		587,
+		345,
+		351,
+		359,
+		365,
+		7805,
+		7815,
+		7819,
+		7823,
+		7825
+	]
 };
 const FLIPPED_MAP = {
-    // ∀ԐↃᗡƎℲ⅁HIſӼ⅂WNOԀÒᴚS⊥∩ɅMX⅄Z
-    // prettier-ignore
-    "caps": [8704, 1296, 8579, 5601, 398, 8498, 8513, 72, 73, 383, 1276, 8514, 87, 78, 79, 1280, 210, 7450, 83, 8869, 8745, 581, 77, 88, 8516, 90],
-    // ɐqɔpǝɟƃɥıɾʞʅɯuodbɹsʇnʌʍxʎz
-    // prettier-ignore
-    "small": [592, 113, 596, 112, 477, 607, 387, 613, 305, 638, 670, 645, 623, 117, 111, 100, 98, 633, 115, 647, 110, 652, 653, 120, 654, 122],
+	"caps": [
+		8704,
+		1296,
+		8579,
+		5601,
+		398,
+		8498,
+		8513,
+		72,
+		73,
+		383,
+		1276,
+		8514,
+		87,
+		78,
+		79,
+		1280,
+		210,
+		7450,
+		83,
+		8869,
+		8745,
+		581,
+		77,
+		88,
+		8516,
+		90
+	],
+	"small": [
+		592,
+		113,
+		596,
+		112,
+		477,
+		607,
+		387,
+		613,
+		305,
+		638,
+		670,
+		645,
+		623,
+		117,
+		111,
+		100,
+		98,
+		633,
+		115,
+		647,
+		110,
+		652,
+		653,
+		120,
+		654,
+		122
+	]
 };
 /**
- * Based on: https://hg.mozilla.org/mozilla-central/file/a1f74e8c8fb72390d22054d6b00c28b1a32f6c43/intl/l10n/L10nRegistry.jsm#l425
- */
+* Based on: https://hg.mozilla.org/mozilla-central/file/a1f74e8c8fb72390d22054d6b00c28b1a32f6c43/intl/l10n/L10nRegistry.jsm#l425
+*/
 function transformString(map, elongate = false, msg) {
-    return msg.replace(/[a-z]/gi, ch => {
-        const cc = ch.charCodeAt(0);
-        if (cc >= 97 && cc <= 122) {
-            const newChar = String.fromCodePoint(map.small[cc - 97]);
-            // duplicate "a", "e", "o" and "u" to emulate ~30% longer text
-            if (elongate && (cc === 97 || cc === 101 || cc === 111 || cc === 117)) {
-                return newChar + newChar;
-            }
-            return newChar;
-        }
-        if (cc >= 65 && cc <= 90) {
-            return String.fromCodePoint(map.caps[cc - 65]);
-        }
-        return ch;
-    });
+	return msg.replace(/[a-z]/gi, (ch) => {
+		const cc = ch.charCodeAt(0);
+		if (cc >= 97 && cc <= 122) {
+			const newChar = String.fromCodePoint(map.small[cc - 97]);
+			// duplicate "a", "e", "o" and "u" to emulate ~30% longer text
+			if (elongate && (cc === 97 || cc === 101 || cc === 111 || cc === 117)) {
+				return newChar + newChar;
+			}
+			return newChar;
+		}
+		if (cc >= 65 && cc <= 90) {
+			return String.fromCodePoint(map.caps[cc - 65]);
+		}
+		return ch;
+	});
 }
 /**
- * accented - Ȧȧƈƈḗḗƞŧḗḗḓ Ḗḗƞɠŀīīşħ
- * --------------------------------
- *
- * This locale replaces all Latin characters with their accented equivalents, and duplicates some
- * vowels to create roughly 30% longer strings. Strings are wrapped in markers (square brackets),
- * which help with detecting truncation.
- */
+* accented - Ȧȧƈƈḗḗƞŧḗḗḓ Ḗḗƞɠŀīīşħ
+* --------------------------------
+*
+* This locale replaces all Latin characters with their accented equivalents, and duplicates some
+* vowels to create roughly 30% longer strings. Strings are wrapped in markers (square brackets),
+* which help with detecting truncation.
+*/
 export function generateENXA(msg) {
-    const ast = typeof msg === 'string' ? parse(msg) : msg;
-    forEachLiteralElement(ast, el => {
-        el.value = transformString(ACCENTED_MAP, true, el.value);
-    });
-    return [
-        { type: TYPE.literal, value: '[' },
-        ...ast,
-        { type: TYPE.literal, value: ']' },
-    ];
+	const ast = typeof msg === "string" ? parse(msg) : msg;
+	forEachLiteralElement(ast, (el) => {
+		el.value = transformString(ACCENTED_MAP, true, el.value);
+	});
+	return [
+		{
+			type: TYPE.literal,
+			value: "["
+		},
+		...ast,
+		{
+			type: TYPE.literal,
+			value: "]"
+		}
+	];
 }
 /**
- * bidi - ɥsıʅƃuƎ ıpıԐ
- * -------------------
- *
- * This strategy replaces all Latin characters with their 180 degree rotated versions and enforces
- * right to left text flow using Unicode UAX#9 Explicit Directional Embeddings. In this mode, the UI
- * directionality will also be set to right-to-left.
- */
+* bidi - ɥsıʅƃuƎ ıpıԐ
+* -------------------
+*
+* This strategy replaces all Latin characters with their 180 degree rotated versions and enforces
+* right to left text flow using Unicode UAX#9 Explicit Directional Embeddings. In this mode, the UI
+* directionality will also be set to right-to-left.
+*/
 export function generateENXB(msg) {
-    const ast = typeof msg === 'string' ? parse(msg) : msg;
-    forEachLiteralElement(ast, el => {
-        el.value = transformString(FLIPPED_MAP, false, el.value);
-    });
-    return [
-        { type: TYPE.literal, value: '\u202e' },
-        ...ast,
-        { type: TYPE.literal, value: '\u202c' },
-    ];
+	const ast = typeof msg === "string" ? parse(msg) : msg;
+	forEachLiteralElement(ast, (el) => {
+		el.value = transformString(FLIPPED_MAP, false, el.value);
+	});
+	return [
+		{
+			type: TYPE.literal,
+			value: "‮"
+		},
+		...ast,
+		{
+			type: TYPE.literal,
+			value: "‬"
+		}
+	];
 }

package/src/verify/checkExtraKeys.js

@@ -1,36 +1,32 @@
-import { debug, writeStderr } from '../console_utils.js';
+import { debug, writeStderr } from "../console_utils.js";
 /**
- * Flatten nested obj into list of keys, delimited by `.`
- * @param obj
- * @param parentKey
- * @returns
- */
-function extractKeys(obj, parentKey = '') {
-    if (!obj || typeof obj !== 'object' || Array.isArray(obj)) {
-        return [];
-    }
-    return Object.keys(obj)
-        .map(k => [parentKey ? `${parentKey}.${k}` : k, ...extractKeys(obj[k], k)])
-        .flat();
+* Flatten nested obj into list of keys, delimited by `.`
+* @param obj
+* @param parentKey
+* @returns
+*/
+function extractKeys(obj, parentKey = "") {
+	if (!obj || typeof obj !== "object" || Array.isArray(obj)) {
+		return [];
+	}
+	return Object.keys(obj).map((k) => [parentKey ? `${parentKey}.${k}` : k, ...extractKeys(obj[k], k)]).flat();
 }
 export async function checkExtraKeys(translationFilesContents, sourceLocale) {
-    debug('Checking translation files:');
-    const sourceContent = translationFilesContents[sourceLocale];
-    if (!sourceContent) {
-        throw new Error(`Missing source ${sourceLocale}.json file`);
-    }
-    const sourceKeys = extractKeys(sourceContent);
-    return Object.entries(translationFilesContents)
-        .filter(([locale]) => locale !== sourceLocale)
-        .reduce((result, [locale, content]) => {
-        const localeKeys = new Set(extractKeys(content));
-        const extraKeys = new Set(Array.from(localeKeys).filter(k => !sourceKeys.includes(k)));
-        if (!extraKeys.size) {
-            return result;
-        }
-        writeStderr('---------------------------------\n');
-        writeStderr(`Extra translation keys for locale ${locale}:\n`);
-        extraKeys.forEach(r => writeStderr(`${r}\n`));
-        return false;
-    }, true);
+	debug("Checking translation files:");
+	const sourceContent = translationFilesContents[sourceLocale];
+	if (!sourceContent) {
+		throw new Error(`Missing source ${sourceLocale}.json file`);
+	}
+	const sourceKeys = extractKeys(sourceContent);
+	return Object.entries(translationFilesContents).filter(([locale]) => locale !== sourceLocale).reduce((result, [locale, content]) => {
+		const localeKeys = new Set(extractKeys(content));
+		const extraKeys = new Set(Array.from(localeKeys).filter((k) => !sourceKeys.includes(k)));
+		if (!extraKeys.size) {
+			return result;
+		}
+		writeStderr("---------------------------------\n");
+		writeStderr(`Extra translation keys for locale ${locale}:\n`);
+		extraKeys.forEach((r) => writeStderr(`${r}\n`));
+		return false;
+	}, true);
 }

package/src/verify/checkMissingKeys.js

@@ -1,37 +1,33 @@
-import { debug, writeStderr } from '../console_utils.js';
+import { debug, writeStderr } from "../console_utils.js";
 /**
- * Flatten nested obj into list of keys, delimited by `.`
- * @param obj
- * @param parentKey
- * @returns
- */
-function extractKeys(obj, parentKey = '') {
-    if (!obj || typeof obj !== 'object' || Array.isArray(obj)) {
-        return [];
-    }
-    return Object.keys(obj)
-        .map(k => [parentKey ? `${parentKey}.${k}` : k, ...extractKeys(obj[k], k)])
-        .flat();
+* Flatten nested obj into list of keys, delimited by `.`
+* @param obj
+* @param parentKey
+* @returns
+*/
+function extractKeys(obj, parentKey = "") {
+	if (!obj || typeof obj !== "object" || Array.isArray(obj)) {
+		return [];
+	}
+	return Object.keys(obj).map((k) => [parentKey ? `${parentKey}.${k}` : k, ...extractKeys(obj[k], k)]).flat();
 }
 export async function checkMissingKeys(translationFilesContents, sourceLocale) {
-    debug('Checking translation files:');
-    const sourceContent = translationFilesContents[sourceLocale];
-    if (!sourceContent) {
-        throw new Error(`Missing source ${sourceLocale}.json file`);
-    }
-    const sourceKeys = extractKeys(sourceContent);
-    return Object.entries(translationFilesContents)
-        .filter(([locale]) => locale !== sourceLocale)
-        .reduce((result, [locale, content]) => {
-        const localeKeys = new Set(extractKeys(content));
-        const missingKeys = new Set(sourceKeys.filter(r => !localeKeys.has(r)));
-        // We're being lenient here since only missing keys are currently considered breaking
-        if (!missingKeys.size) {
-            return result;
-        }
-        writeStderr('---------------------------------\n');
-        writeStderr(`Missing translation keys for locale ${locale}:\n`);
-        missingKeys.forEach(r => writeStderr(`${r}\n`));
-        return false;
-    }, true);
+	debug("Checking translation files:");
+	const sourceContent = translationFilesContents[sourceLocale];
+	if (!sourceContent) {
+		throw new Error(`Missing source ${sourceLocale}.json file`);
+	}
+	const sourceKeys = extractKeys(sourceContent);
+	return Object.entries(translationFilesContents).filter(([locale]) => locale !== sourceLocale).reduce((result, [locale, content]) => {
+		const localeKeys = new Set(extractKeys(content));
+		const missingKeys = new Set(sourceKeys.filter((r) => !localeKeys.has(r)));
+		// We're being lenient here since only missing keys are currently considered breaking
+		if (!missingKeys.size) {
+			return result;
+		}
+		writeStderr("---------------------------------\n");
+		writeStderr(`Missing translation keys for locale ${locale}:\n`);
+		missingKeys.forEach((r) => writeStderr(`${r}\n`));
+		return false;
+	}, true);
 }

package/src/verify/checkStructuralEquality.js

@@ -1,75 +1,71 @@
-import { isStructurallySame, parse, } from '@formatjs/icu-messageformat-parser';
-import { debug, writeStderr } from '../console_utils.js';
-import { error } from 'console';
+import { isStructurallySame, parse } from "@formatjs/icu-messageformat-parser";
+import { debug, writeStderr } from "../console_utils.js";
+import { error } from "console";
 /**
- * Flatten nested obj into list of keys, delimited by `.`
- * @param obj
- * @param parentKey
- * @returns
- */
-function flatten(obj, parentKey = '') {
-    if (!obj || typeof obj !== 'object' || Array.isArray(obj)) {
-        return {};
-    }
-    return Object.keys(obj).reduce((all, k) => {
-        const value = obj[k];
-        const key = parentKey ? `${parentKey}.${k}` : k;
-        if (typeof value === 'object') {
-            Object.assign(all, flatten(value, key));
-        }
-        else {
-            all[key] = value;
-        }
-        return all;
-    }, {});
+* Flatten nested obj into list of keys, delimited by `.`
+* @param obj
+* @param parentKey
+* @returns
+*/
+function flatten(obj, parentKey = "") {
+	if (!obj || typeof obj !== "object" || Array.isArray(obj)) {
+		return {};
+	}
+	return Object.keys(obj).reduce((all, k) => {
+		const value = obj[k];
+		const key = parentKey ? `${parentKey}.${k}` : k;
+		if (typeof value === "object") {
+			Object.assign(all, flatten(value, key));
+		} else {
+			all[key] = value;
+		}
+		return all;
+	}, {});
 }
 export async function checkStructuralEquality(translationFilesContents, sourceLocale) {
-    debug('Checking translation files:');
-    const sourceContent = translationFilesContents[sourceLocale];
-    if (!sourceContent) {
-        throw new Error(`Missing source ${sourceLocale}.json file`);
-    }
-    const sourceMessages = Object.entries(flatten(sourceContent)).reduce((all, [key, value]) => {
-        try {
-            all[key] = parse(value);
-        }
-        catch (e) {
-            error('Error parsing message', key, value, e);
-        }
-        return all;
-    }, {});
-    return Object.entries(translationFilesContents)
-        .filter(([locale]) => locale !== sourceLocale)
-        .reduce((result, [locale, content]) => {
-        const localeMessages = flatten(content);
-        const problematicKeys = Object.keys(sourceMessages)
-            .map(k => {
-            if (!localeMessages[k]) {
-                return { key: k, success: true };
-            }
-            const sourceMessage = sourceMessages[k];
-            try {
-                const localeMessage = parse(localeMessages[k]);
-                return {
-                    key: k,
-                    ...isStructurallySame(sourceMessage, localeMessage),
-                };
-            }
-            catch (e) {
-                return {
-                    key: k,
-                    success: false,
-                    error: e instanceof Error ? e : new Error(String(e)),
-                };
-            }
-        })
-            .filter(s => !s.success);
-        if (!problematicKeys.length) {
-            return result;
-        }
-        writeStderr('---------------------------------\n');
-        writeStderr(`These translation keys for locale ${locale} are structurally different from ${sourceLocale}:\n`);
-        problematicKeys.forEach(({ key, error }) => writeStderr(`${key}: ${error?.message}\n`));
-        return false;
-    }, true);
+	debug("Checking translation files:");
+	const sourceContent = translationFilesContents[sourceLocale];
+	if (!sourceContent) {
+		throw new Error(`Missing source ${sourceLocale}.json file`);
+	}
+	const sourceMessages = Object.entries(flatten(sourceContent)).reduce((all, [key, value]) => {
+		try {
+			all[key] = parse(value);
+		} catch (e) {
+			error("Error parsing message", key, value, e);
+		}
+		return all;
+	}, {});
+	return Object.entries(translationFilesContents).filter(([locale]) => locale !== sourceLocale).reduce((result, [locale, content]) => {
+		const localeMessages = flatten(content);
+		const problematicKeys = Object.keys(sourceMessages).map((k) => {
+			if (!localeMessages[k]) {
+				return {
+					key: k,
+					success: true
+				};
+			}
+			const sourceMessage = sourceMessages[k];
+			try {
+				const localeMessage = parse(localeMessages[k]);
+				return {
+					key: k,
+					...isStructurallySame(sourceMessage, localeMessage)
+				};
+			} catch (e) {
+				return {
+					key: k,
+					success: false,
+					error: e instanceof Error ? e : new Error(String(e))
+				};
+			}
+		}).filter((s) => !s.success);
+		if (!problematicKeys.length) {
+			return result;
+		}
+		writeStderr("---------------------------------\n");
+		writeStderr(`These translation keys for locale ${locale} are structurally different from ${sourceLocale}:\n`);
+		problematicKeys.forEach(({ key, error }) => writeStderr(`${key}: ${error?.message}\n`));
+		return false;
+	}, true);
 }

package/src/verify/index.d.ts

@@ -1,8 +1,8 @@
 export interface VerifyOpts {
-    sourceLocale: string;
-    missingKeys: boolean;
-    extraKeys: boolean;
-    structuralEquality: boolean;
-    ignore?: string[];
+	sourceLocale: string;
+	missingKeys: boolean;
+	extraKeys: boolean;
+	structuralEquality: boolean;
+	ignore?: string[];
 }
 export declare function verify(files: string[], { sourceLocale, missingKeys, extraKeys, structuralEquality }: VerifyOpts): Promise<void>;