@formatjs/cli-lib 8.5.0 → 8.5.2

package/src/formatters/transifex.d.ts

@@ -1,9 +0,0 @@
-import { type CompileFn, type FormatFn } from "./default.js";
-export type StructuredJson = Record<string, {
-	string: string;
-	developer_comment?: string;
-	context?: string;
-	character_limit?: string;
-}>;
-export declare const format: FormatFn<StructuredJson>;
-export declare const compile: CompileFn<StructuredJson>;

package/src/formatters/transifex.js

@@ -1,18 +0,0 @@
-import "./default.js";
-export const format = (msgs) => {
-	const results = {};
-	for (const [id, msg] of Object.entries(msgs)) {
-		results[id] = {
-			string: msg.defaultMessage,
-			developer_comment: typeof msg.description === "string" ? msg.description : JSON.stringify(msg.description)
-		};
-	}
-	return results;
-};
-export const compile = (msgs) => {
-	const results = {};
-	for (const [id, msg] of Object.entries(msgs)) {
-		results[id] = msg.string;
-	}
-	return results;
-};

package/src/gts_extractor.d.ts

@@ -1 +0,0 @@
-export declare function parseFile(source: string, fileName: string, options: any): void;

package/src/gts_extractor.js

@@ -1,14 +0,0 @@
-import { Preprocessor } from "content-tag";
-import { parseFile as parseHbsFile } from "./hbs_extractor.js";
-import { parseScript } from "./parse_script.js";
-let p = new Preprocessor();
-export function parseFile(source, fileName, options) {
-	const scriptParseFn = parseScript(options, fileName);
-	const transformedSource = p.process(source, { filename: fileName });
-	scriptParseFn(transformedSource.code);
-	// extract template from transformed source to then run through hbs processor
-	const parseResult = p.parse(source, { filename: fileName });
-	for (let parsed of parseResult) {
-		parseHbsFile(parsed.contents, fileName, options);
-	}
-}

package/src/hbs_extractor.d.ts

@@ -1 +0,0 @@
-export declare function parseFile(source: string, fileName: string, options: any): void;

package/src/parse_script.d.ts

@@ -1,7 +0,0 @@
-import { type Opts } from "@formatjs/ts-transformer";
-/**
-* Invoid TypeScript module transpilation with our TS transformer
-* @param opts Formatjs TS Transformer opt
-* @param fn filename
-*/
-export declare function parseScript(opts: Opts, fn?: string): (source: string) => void;

package/src/parse_script.js

@@ -1,43 +0,0 @@
-import { transformWithTs } from "@formatjs/ts-transformer";
-import * as ts from "typescript";
-import { debug } from "./console_utils.js";
-/**
-* Invoid TypeScript module transpilation with our TS transformer
-* @param opts Formatjs TS Transformer opt
-* @param fn filename
-*/
-export function parseScript(opts, fn) {
-	return (source) => {
-		let output;
-		try {
-			debug("Using TS compiler to process file", fn);
-			output = ts.transpileModule(source, {
-				compilerOptions: {
-					allowJs: true,
-					target: ts.ScriptTarget.ESNext,
-					noEmit: true,
-					experimentalDecorators: true
-				},
-				reportDiagnostics: true,
-				fileName: fn,
-				transformers: { before: [transformWithTs(ts, opts)] }
-			});
-		} catch (e) {
-			if (e instanceof Error) {
-				e.message = `Error processing file ${fn} 
-${e.message || ""}`;
-			}
-			throw e;
-		}
-		if (output.diagnostics) {
-			const errs = output.diagnostics.filter((d) => d.category === ts.DiagnosticCategory.Error);
-			if (errs.length) {
-				throw new Error(ts.formatDiagnosticsWithColorAndContext(errs, {
-					getCanonicalFileName: (fileName) => fileName,
-					getCurrentDirectory: () => process.cwd(),
-					getNewLine: () => ts.sys.newLine
-				}));
-			}
-		}
-	};
-}

package/src/pseudo_locale.d.ts

@@ -1,22 +0,0 @@
-import { type MessageFormatElement } from "@formatjs/icu-messageformat-parser";
-export declare function generateXXLS(msg: string | MessageFormatElement[]): MessageFormatElement[];
-export declare function generateXXAC(msg: string | MessageFormatElement[]): MessageFormatElement[];
-export declare function generateXXHA(msg: string | MessageFormatElement[]): MessageFormatElement[];
-/**
-* 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 declare function generateENXA(msg: string | MessageFormatElement[]): MessageFormatElement[];
-/**
-* 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 declare function generateENXB(msg: string | MessageFormatElement[]): MessageFormatElement[];

package/src/pseudo_locale.js

@@ -1,231 +0,0 @@
-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);
-		}
-	});
-}
-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"
-	}];
-}
-export function generateXXAC(msg) {
-	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 ACCENTED_MAP = {
-	"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 = {
-	"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
-*/
-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;
-	});
-}
-/**
-* 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: "]"
-		}
-	];
-}
-/**
-* 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: "‮"
-		},
-		...ast,
-		{
-			type: TYPE.literal,
-			value: "‬"
-		}
-	];
-}

package/src/svelte_extractor.d.ts

@@ -1,2 +0,0 @@
-export type ScriptParseFn = (source: string) => void;
-export declare function parseFile(source: string, filename: string, parseScriptFn: ScriptParseFn): void;

package/src/verify/checkExtraKeys.d.ts

@@ -1 +0,0 @@
-export declare function checkExtraKeys(translationFilesContents: Record<string, any>, sourceLocale: string): Promise<boolean>;

package/src/verify/checkExtraKeys.js

@@ -1,32 +0,0 @@
-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();
-}
-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);
-}

package/src/verify/checkMissingKeys.d.ts

@@ -1 +0,0 @@
-export declare function checkMissingKeys(translationFilesContents: Record<string, any>, sourceLocale: string): Promise<boolean>;

package/src/verify/checkMissingKeys.js

@@ -1,33 +0,0 @@
-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();
-}
-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);
-}

package/src/verify/checkStructuralEquality.d.ts

@@ -1 +0,0 @@
-export declare function checkStructuralEquality(translationFilesContents: Record<string, any>, sourceLocale: string): Promise<boolean>;

package/src/verify/checkStructuralEquality.js

@@ -1,71 +0,0 @@
-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;
-	}, {});
-}
-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);
-}

package/src/verify/index.d.ts

@@ -1,13 +0,0 @@
-export interface VerifyOpts {
-	sourceLocale: string;
-	missingKeys: boolean;
-	extraKeys: boolean;
-	structuralEquality: boolean;
-	ignore?: string[];
-	/**
-	* Whether to follow symbolic links when traversing directories.
-	* Defaults to true for compatibility with pnpm symlinked node_modules.
-	*/
-	followLinks?: boolean;
-}
-export declare function verify(files: string[], { sourceLocale, missingKeys, extraKeys, structuralEquality }: VerifyOpts): Promise<void>;

package/src/verify/index.js

@@ -1,26 +0,0 @@
-import { basename } from "path";
-import { debug } from "../console_utils.js";
-import { checkMissingKeys } from "./checkMissingKeys.js";
-import { checkExtraKeys } from "./checkExtraKeys.js";
-import { readJSON } from "fs-extra/esm";
-import { checkStructuralEquality } from "./checkStructuralEquality.js";
-export async function verify(files, { sourceLocale, missingKeys, extraKeys, structuralEquality }) {
-	debug("Checking translation files:");
-	files.forEach((fn) => debug(fn));
-	const translationFilesContents = (await Promise.all(files.map(async (fn) => [basename(fn, ".json"), await readJSON(fn)]))).reduce((all, [locale, content]) => {
-		all[locale] = content;
-		return all;
-	}, {});
-	debug("Verifying files:", files);
-	let exitCode = 0;
-	if (missingKeys && !await checkMissingKeys(translationFilesContents, sourceLocale)) {
-		exitCode = 1;
-	}
-	if (extraKeys && !await checkExtraKeys(translationFilesContents, sourceLocale)) {
-		exitCode = 1;
-	}
-	if (structuralEquality && !await checkStructuralEquality(translationFilesContents, sourceLocale)) {
-		exitCode = 1;
-	}
-	process.exit(exitCode);
-}

package/src/vue_extractor.d.ts

@@ -1,2 +0,0 @@
-export type ScriptParseFn = (source: string) => void;
-export declare function parseFile(source: string, filename: string, parseScriptFn: ScriptParseFn): void;

package/src/vue_extractor.js

@@ -1,58 +0,0 @@
-import { NodeTypes } from "@vue/compiler-core";
-import { parse } from "vue/compiler-sfc";
-function walk(node, visitor) {
-	if (typeof node !== "object" || node == null) {
-		return;
-	}
-	if (node.type === NodeTypes.ROOT) {
-		node.children.forEach((n) => walk(n, visitor));
-		return;
-	}
-	if (node.type !== NodeTypes.ELEMENT && node.type !== NodeTypes.COMPOUND_EXPRESSION && node.type !== NodeTypes.INTERPOLATION) {
-		return;
-	}
-	visitor(node);
-	if (node.type === NodeTypes.INTERPOLATION) {
-		visitor(node.content);
-	} else if (node.type === NodeTypes.ELEMENT) {
-		node.children.forEach((n) => walk(n, visitor));
-		node.props.filter((prop) => prop.type === NodeTypes.DIRECTIVE).filter((prop) => !!prop.exp).forEach((prop) => visitor(prop.exp));
-	} else {
-		node.children.forEach((n) => walk(n, visitor));
-	}
-}
-function templateSimpleExpressionNodeVisitor(parseScriptFn) {
-	return (n) => {
-		if (typeof n !== "object") {
-			return;
-		}
-		if (n.type !== NodeTypes.SIMPLE_EXPRESSION) {
-			return;
-		}
-		const { content } = n;
-		// Wrap this in () since a vue comp node attribute can just be
-		// an object literal which, by itself is invalid TS
-		// but with () it becomes an ExpressionStatement
-		try {
-			parseScriptFn(`(${content})`);
-		} catch (e) {
-			console.warn(`Failed to parse "${content}". Ignore this if content has no extractable message`, e);
-		}
-	};
-}
-export function parseFile(source, filename, parseScriptFn) {
-	const { descriptor, errors } = parse(source, { filename });
-	if (errors.length) {
-		throw errors[0];
-	}
-	const { script, scriptSetup, template } = descriptor;
-	if (template) {
-		walk(template.ast, templateSimpleExpressionNodeVisitor(parseScriptFn));
-	}
-	if (script) {
-		parseScriptFn(script.content);
-	}
-	if (scriptSetup) {
-		parseScriptFn(scriptSetup.content);
-	}
-}