@formatjs/cli-lib 8.5.0 → 8.5.2

package/src/compile.js

@@ -1,95 +0,0 @@
-import { parse } from "@formatjs/icu-messageformat-parser";
-import { outputFile } from "fs-extra/esm";
-import { readFile } from "fs/promises";
-import * as stringifyNs from "json-stable-stringify";
-import { debug, warn, writeStdout } from "./console_utils.js";
-import { resolveBuiltinFormatter } from "./formatters/index.js";
-import { generateENXA, generateENXB, generateXXAC, generateXXHA, generateXXLS } from "./pseudo_locale.js";
-const stringify = stringifyNs.default || stringifyNs;
-/**
-* Aggregate `inputFiles` into a single JSON blob and compile.
-* Also checks for conflicting IDs.
-* Then returns the serialized result as a `string` since key order
-* makes a difference in some vendor.
-* @param inputFiles Input files
-* @param opts Options
-* @returns serialized result in string format
-*/
-export async function compile(inputFiles, opts = {}) {
-	debug("Compiling files:", inputFiles);
-	const { ast, format, pseudoLocale, skipErrors, ignoreTag, signal } = opts;
-	signal?.throwIfAborted();
-	const formatter = await resolveBuiltinFormatter(format);
-	const messages = {};
-	const messageAsts = {};
-	const idsWithFileName = {};
-	const compiledFiles = await Promise.all(inputFiles.map((f) => readFile(f, {
-		encoding: "utf8",
-		signal
-	}).then((content) => JSON.parse(content)).then(formatter.compile)));
-	debug("Compiled files:", compiledFiles);
-	for (let i = 0; i < inputFiles.length; i++) {
-		const inputFile = inputFiles[i];
-		debug("Processing file:", inputFile);
-		const compiled = compiledFiles[i];
-		for (const id in compiled) {
-			if (messages[id] && messages[id] !== compiled[id]) {
-				throw new Error(`Conflicting ID "${id}" with different translation found in these 2 files:
-ID: ${id}
-Message from ${idsWithFileName[id]}: ${messages[id]}
-Message from ${inputFile}: ${compiled[id]}
-`);
-			}
-			try {
-				const msgAst = parse(compiled[id], { ignoreTag });
-				messages[id] = compiled[id];
-				switch (pseudoLocale) {
-					case "xx-LS":
-						messageAsts[id] = generateXXLS(msgAst);
-						break;
-					case "xx-AC":
-						messageAsts[id] = generateXXAC(msgAst);
-						break;
-					case "xx-HA":
-						messageAsts[id] = generateXXHA(msgAst);
-						break;
-					case "en-XA":
-						messageAsts[id] = generateENXA(msgAst);
-						break;
-					case "en-XB":
-						messageAsts[id] = generateENXB(msgAst);
-						break;
-					default:
-						messageAsts[id] = msgAst;
-						break;
-				}
-				idsWithFileName[id] = inputFile;
-			} catch (e) {
-				warn("Error validating message \"%s\" with ID \"%s\" in file \"%s\"", compiled[id], id, inputFile);
-				if (!skipErrors) {
-					throw e;
-				}
-			}
-		}
-	}
-	return stringify(ast ? messageAsts : messages, {
-		space: 2,
-		cmp: formatter.compareMessages || undefined
-	}) ?? "";
-}
-/**
-* Aggregate `inputFiles` into a single JSON blob and compile.
-* Also checks for conflicting IDs and write output to `outFile`.
-* @param inputFiles Input files
-* @param compileOpts options
-* @returns A `Promise` that resolves if file was written successfully
-*/
-export default async function compileAndWrite(inputFiles, compileOpts = {}) {
-	const { outFile, ...opts } = compileOpts;
-	const serializedResult = await compile(inputFiles, opts) + "\n";
-	if (outFile) {
-		debug("Writing output file:", outFile);
-		return outputFile(outFile, serializedResult);
-	}
-	await writeStdout(serializedResult);
-}

package/src/compile_folder.d.ts

@@ -1,2 +0,0 @@
-import { type Opts } from "./compile.js";
-export default function compileFolder(files: string[], outFolder: string, opts?: Opts): Promise<void[]>;

package/src/compile_folder.js

@@ -1,8 +0,0 @@
-import { outputFile } from "fs-extra/esm";
-import { basename, join } from "path";
-import { compile } from "./compile.js";
-export default async function compileFolder(files, outFolder, opts = {}) {
-	const results = await Promise.all(files.map((f) => compile([f], opts)));
-	const outFiles = files.map((f) => join(outFolder, basename(f)));
-	return Promise.all(outFiles.map((outFile, i) => outputFile(outFile, results[i])));
-}

package/src/console_utils.d.ts

@@ -1,7 +0,0 @@
-export declare const writeStderr: (arg1: string | Uint8Array) => Promise<void>;
-export declare const writeStdout: (arg1: string | Uint8Array) => Promise<void>;
-export declare function clearLine(terminal: (typeof process)["stderr"]): Promise<void>;
-export declare function debug(message: string, ...args: any[]): Promise<void>;
-export declare function warn(message: string, ...args: any[]): Promise<void>;
-export declare function error(message: string, ...args: any[]): Promise<void>;
-export declare function getStdinAsString(): Promise<string>;

package/src/console_utils.js

@@ -1,62 +0,0 @@
-import { clearLine as nativeClearLine, cursorTo as nativeCursorTo } from "readline";
-import { format, promisify, styleText } from "node:util";
-const CLEAR_WHOLE_LINE = 0;
-export const writeStderr = promisify(process.stderr.write).bind(process.stderr);
-export const writeStdout = promisify(process.stdout.write).bind(process.stdout);
-// From:
-// https://github.com/yarnpkg/yarn/blob/53d8004229f543f342833310d5af63a4b6e59c8a/src/reporters/console/util.js
-export async function clearLine(terminal) {
-	if (!terminal.hasColors?.()) {
-		if (terminal.isTTY) {
-			// terminal
-			if (terminal.columns > 0) {
-				await writeStderr(`\r${" ".repeat(terminal.columns - 1)}`);
-			}
-			await writeStderr(`\r`);
-		}
-	} else {
-		nativeClearLine(terminal, CLEAR_WHOLE_LINE);
-		nativeCursorTo(terminal, 0, undefined);
-	}
-}
-const LEVEL_COLORS = {
-	debug: "green",
-	warn: "yellow",
-	error: "red"
-};
-function label(level, message) {
-	return `[@formatjs/cli] [${styleText(LEVEL_COLORS[level], level.toUpperCase())}] ${message}`;
-}
-export async function debug(message, ...args) {
-	if (process.env.LOG_LEVEL !== "debug") {
-		return;
-	}
-	await clearLine(process.stderr);
-	await writeStderr(format(label("debug", message), ...args));
-	await writeStderr("\n");
-}
-export async function warn(message, ...args) {
-	await clearLine(process.stderr);
-	await writeStderr(format(label("warn", message), ...args));
-	await writeStderr("\n");
-}
-export async function error(message, ...args) {
-	await clearLine(process.stderr);
-	await writeStderr(format(label("error", message), ...args));
-	await writeStderr("\n");
-}
-export function getStdinAsString() {
-	let result = "";
-	return new Promise((resolve) => {
-		process.stdin.setEncoding("utf-8");
-		process.stdin.on("readable", () => {
-			let chunk;
-			while (chunk = process.stdin.read()) {
-				result += chunk;
-			}
-		});
-		process.stdin.on("end", () => {
-			resolve(result);
-		});
-	});
-}

package/src/extract.d.ts

@@ -1,87 +0,0 @@
-import { type MessageDescriptor, type Opts } from "@formatjs/ts-transformer";
-import { type Formatter } from "./formatters/index.js";
-export interface ExtractionResult<M = Record<string, string>> {
-	/**
-	* List of extracted messages
-	*/
-	messages: MessageDescriptor[];
-	/**
-	* Metadata extracted w/ `pragma`
-	*/
-	meta?: M;
-}
-export interface ExtractedMessageDescriptor extends MessageDescriptor {
-	/**
-	* Line number
-	*/
-	line?: number;
-	/**
-	* Column number
-	*/
-	col?: number;
-	/**
-	* Metadata extracted from pragma
-	*/
-	meta?: Record<string, string>;
-}
-export type ExtractCLIOptions = Omit<ExtractOpts, "overrideIdFn" | "onMsgExtracted" | "onMetaExtracted"> & {
-	/**
-	* Output File
-	*/
-	outFile?: string;
-	/**
-	* Input File
-	*/
-	inFile?: string;
-	/**
-	* Ignore file glob pattern
-	*/
-	ignore?: string[];
-	/**
-	* Whether to follow symbolic links when traversing directories.
-	* Defaults to true for compatibility with pnpm symlinked node_modules.
-	*/
-	followLinks?: boolean;
-};
-export type ExtractOpts = Opts & {
-	/**
-	* Whether to throw an error if we had any issues with
-	* 1 of the source files
-	*/
-	throws?: boolean;
-	/**
-	* Message ID interpolation pattern
-	*/
-	idInterpolationPattern?: string;
-	/**
-	* Whether we read from stdin instead of a file
-	*/
-	readFromStdin?: boolean;
-	/**
-	* Either path to a formatter file that controls the shape of JSON file from `outFile` or {@link Formatter} object.
-	*/
-	format?: string | Formatter<any>;
-	/**
-	* Whether to hoist selectors & flatten sentences
-	*/
-	flatten?: boolean;
-	/**
-	* An AbortSignal to cancel the extraction
-	*/
-	signal?: AbortSignal;
-} & Pick<Opts, "onMsgExtracted" | "onMetaExtracted">;
-/**
-* Extract strings from source files
-* @param files list of files
-* @param extractOpts extract options
-* @returns messages serialized as JSON string since key order
-* matters for some `format`
-*/
-export declare function extract(files: readonly string[], extractOpts: ExtractOpts): Promise<string>;
-/**
-* Extract strings from source files, also writes to a file.
-* @param files list of files
-* @param extractOpts extract options
-* @returns A Promise that resolves if output file was written successfully
-*/
-export default function extractAndWrite(files: readonly string[], extractOpts: ExtractCLIOptions): Promise<void>;

package/src/extract.js

@@ -1,212 +0,0 @@
-import { interpolateName } from "@formatjs/ts-transformer";
-import { outputFile } from "fs-extra/esm";
-import { debug, getStdinAsString, warn, writeStdout } from "./console_utils.js";
-import * as stringifyNs from "json-stable-stringify";
-import { resolveBuiltinFormatter } from "./formatters/index.js";
-import { parseScript } from "./parse_script.js";
-import { readFile } from "fs/promises";
-const stringify = stringifyNs.default || stringifyNs;
-function calculateLineColFromOffset(text, start) {
-	if (!start) {
-		return {
-			line: 1,
-			col: 1
-		};
-	}
-	const chunk = text.slice(0, start);
-	const lines = chunk.split("\n");
-	const lastLine = lines[lines.length - 1];
-	return {
-		line: lines.length,
-		col: lastLine.length
-	};
-}
-async function processFile(source, fn, { idInterpolationPattern, ...opts }) {
-	let messages = [];
-	let meta;
-	const onMsgExtracted = opts.onMsgExtracted;
-	const onMetaExtracted = opts.onMetaExtracted;
-	opts = {
-		...opts,
-		additionalComponentNames: ["$formatMessage", ...opts.additionalComponentNames || []],
-		onMsgExtracted(filePath, msgs) {
-			if (opts.extractSourceLocation) {
-				msgs = msgs.map((msg) => ({
-					...msg,
-					...calculateLineColFromOffset(source, msg.start)
-				}));
-			}
-			messages = messages.concat(msgs);
-			if (onMsgExtracted) {
-				onMsgExtracted(filePath, msgs);
-			}
-		},
-		onMetaExtracted(filePath, m) {
-			meta = m;
-			if (onMetaExtracted) {
-				onMetaExtracted(filePath, m);
-			}
-		}
-	};
-	if (!opts.overrideIdFn && idInterpolationPattern) {
-		opts = {
-			...opts,
-			overrideIdFn: (id, defaultMessage, description, fileName) => id || interpolateName({ resourcePath: fileName }, idInterpolationPattern, { content: description ? `${defaultMessage}#${typeof description === "string" ? description : stringify(description)}` : defaultMessage })
-		};
-	}
-	debug("Processing opts for %s: %s", fn, opts);
-	const scriptParseFn = parseScript(opts, fn);
-	if (fn.endsWith(".vue")) {
-		debug("Processing %s using vue extractor", fn);
-		const { parseFile } = await import("./vue_extractor.js");
-		parseFile(source, fn, scriptParseFn);
-	} else if (fn.endsWith(".svelte")) {
-		debug("Processing %s using svelte extractor", fn);
-		const { parseFile } = await import("./svelte_extractor.js");
-		parseFile(source, fn, scriptParseFn);
-	} else if (fn.endsWith(".hbs")) {
-		debug("Processing %s using hbs extractor", fn);
-		const { parseFile } = await import("./hbs_extractor.js");
-		parseFile(source, fn, opts);
-	} else if (fn.endsWith(".gts") || fn.endsWith(".gjs")) {
-		debug("Processing %s as gts/gjs file", fn);
-		const { parseFile } = await import("./gts_extractor.js");
-		parseFile(source, fn, opts);
-	} else {
-		debug("Processing %s using typescript extractor", fn);
-		scriptParseFn(source);
-	}
-	debug("Done extracting %s messages: %s", fn, messages);
-	if (meta) {
-		debug("Extracted meta:", meta);
-		messages.forEach((m) => m.meta = meta);
-	}
-	return {
-		messages,
-		meta
-	};
-}
-/**
-* Extract strings from source files
-* @param files list of files
-* @param extractOpts extract options
-* @returns messages serialized as JSON string since key order
-* matters for some `format`
-*/
-export async function extract(files, extractOpts) {
-	const { throws, readFromStdin, signal, ...opts } = extractOpts;
-	// When throws is not explicitly true, we want to collect partial results
-	const shouldThrow = throws === true;
-	// Pass throws option to transformer for per-message error handling
-	const optsWithThrows = {
-		...opts,
-		throws: shouldThrow,
-		onMsgError: !shouldThrow ? (_, e) => warn(e.message) : undefined
-	};
-	let rawResults = [];
-	try {
-		if (readFromStdin) {
-			debug(`Reading input from stdin`);
-			// Read from stdin
-			if (process.stdin.isTTY) {
-				warn("Reading source file from TTY.");
-			}
-			const stdinSource = await getStdinAsString();
-			rawResults = [await processFile(stdinSource, "dummy", optsWithThrows)];
-		} else {
-			// Use Promise.allSettled when throws is not explicitly true to collect partial results
-			if (!shouldThrow) {
-				const settledResults = await Promise.allSettled(files.map(async (fn) => {
-					debug("Extracting file:", fn);
-					const source = await readFile(fn, {
-						encoding: "utf8",
-						signal
-					});
-					return processFile(source, fn, optsWithThrows);
-				}));
-				rawResults = settledResults.map((result) => {
-					if (result.status === "fulfilled") {
-						return result.value;
-					} else {
-						warn(String(result.reason));
-						return undefined;
-					}
-				});
-			} else {
-				rawResults = await Promise.all(files.map(async (fn) => {
-					debug("Extracting file:", fn);
-					const source = await readFile(fn, {
-						encoding: "utf8",
-						signal
-					});
-					return processFile(source, fn, optsWithThrows);
-				}));
-			}
-		}
-	} catch (e) {
-		if (shouldThrow) {
-			throw e;
-		} else {
-			warn(String(e));
-		}
-	}
-	const formatter = await resolveBuiltinFormatter(opts.format);
-	const extractionResults = rawResults.filter((r) => !!r);
-	const extractedMessages = new Map();
-	for (const { messages } of extractionResults) {
-		for (const message of messages) {
-			const { id, description, defaultMessage } = message;
-			if (!id) {
-				const error = new Error(`[FormatJS CLI] Missing message id for message:
-${JSON.stringify(message, undefined, 2)}`);
-				if (throws) {
-					throw error;
-				} else {
-					warn(error.message);
-				}
-				continue;
-			}
-			if (extractedMessages.has(id)) {
-				const existing = extractedMessages.get(id);
-				if (stringify(description) !== stringify(existing.description) || defaultMessage !== existing.defaultMessage) {
-					const error = new Error(`[FormatJS CLI] Duplicate message id: "${id}", ` + "but the `description` and/or `defaultMessage` are different.");
-					if (throws) {
-						throw error;
-					} else {
-						warn(error.message);
-					}
-				}
-			}
-			extractedMessages.set(id, message);
-		}
-	}
-	const results = {};
-	const messages = Array.from(extractedMessages.values());
-	for (const { id, ...msg } of messages) {
-		// GH #3537: flatten is now applied during extraction in the babel plugin,
-		// so we don't need to apply it again here. The messages are already flattened.
-		results[id] = msg;
-	}
-	if (typeof formatter.serialize === "function") {
-		return formatter.serialize(formatter.format(results));
-	}
-	return stringify(formatter.format(results), {
-		space: 2,
-		cmp: formatter.compareMessages || undefined
-	}) ?? "";
-}
-/**
-* Extract strings from source files, also writes to a file.
-* @param files list of files
-* @param extractOpts extract options
-* @returns A Promise that resolves if output file was written successfully
-*/
-export default async function extractAndWrite(files, extractOpts) {
-	const { outFile, ...opts } = extractOpts;
-	const serializedResult = await extract(files, opts) + "\n";
-	if (outFile) {
-		debug("Writing output file:", outFile);
-		return outputFile(outFile, serializedResult);
-	}
-	await writeStdout(serializedResult);
-}

package/src/formatters/crowdin.d.ts

@@ -1,7 +0,0 @@
-import { type CompileFn, type FormatFn } from "./default.js";
-export type CrowdinJson = Record<string, {
-	message: string;
-	description?: string;
-}>;
-export declare const format: FormatFn<CrowdinJson>;
-export declare const compile: CompileFn<CrowdinJson>;

package/src/formatters/crowdin.js

@@ -1,21 +0,0 @@
-import "./default.js";
-export const format = (msgs) => {
-	const results = {};
-	for (const [id, msg] of Object.entries(msgs)) {
-		results[id] = {
-			message: msg.defaultMessage,
-			description: 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)) {
-		if (id === "smartling") {
-			continue;
-		}
-		results[id] = msg.message;
-	}
-	return results;
-};

package/src/formatters/default.d.ts

@@ -1,6 +0,0 @@
-import { type MessageDescriptor } from "@formatjs/ts-transformer";
-export type FormatFn<T = Record<string, MessageDescriptor>> = (msgs: Record<string, MessageDescriptor>) => T;
-export type CompileFn<T = Record<string, MessageDescriptor>> = (msgs: T) => Record<string, string>;
-export type SerializeFn<T = Record<string, MessageDescriptor>> = (msgs: T) => string;
-export declare const format: FormatFn;
-export declare const compile: CompileFn;

package/src/formatters/default.js

@@ -1,9 +0,0 @@
-import "@formatjs/ts-transformer";
-export const format = (msgs) => msgs;
-export const compile = (msgs) => {
-	const results = {};
-	for (const k in msgs) {
-		results[k] = msgs[k].defaultMessage;
-	}
-	return results;
-};

package/src/formatters/index.d.ts

@@ -1,9 +0,0 @@
-import type { Comparator } from "json-stable-stringify";
-import { type CompileFn, type FormatFn, type SerializeFn } from "./default.js";
-export interface Formatter<T> {
-	serialize?: SerializeFn<T>;
-	format: FormatFn<T>;
-	compile: CompileFn<T>;
-	compareMessages?: Comparator;
-}
-export declare function resolveBuiltinFormatter(format?: string | Formatter<unknown>): Promise<any>;

package/src/formatters/index.js

@@ -1,31 +0,0 @@
-import { resolve } from "path";
-import { pathToFileURL } from "url";
-import * as crowdin from "./crowdin.js";
-import * as defaultFormatter from "./default.js";
-import "./default.js";
-import * as lokalise from "./lokalise.js";
-import * as simple from "./simple.js";
-import * as smartling from "./smartling.js";
-import * as transifex from "./transifex.js";
-export async function resolveBuiltinFormatter(format) {
-	if (!format) {
-		return defaultFormatter;
-	}
-	if (typeof format !== "string") {
-		return format;
-	}
-	switch (format) {
-		case "transifex": return transifex;
-		case "smartling": return smartling;
-		case "simple": return simple;
-		case "lokalise": return lokalise;
-		case "crowdin": return crowdin;
-	}
-	try {
-		// eslint-disable-next-line import/dynamic-import-chunkname
-		return import(pathToFileURL(resolve(process.cwd(), format)).href);
-	} catch (e) {
-		console.error(`Cannot resolve formatter ${format}`);
-		throw e;
-	}
-}

package/src/formatters/lokalise.d.ts

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

package/src/formatters/lokalise.js

@@ -1,18 +0,0 @@
-import "./default.js";
-export const format = (msgs) => {
-	const results = {};
-	for (const [id, msg] of Object.entries(msgs)) {
-		results[id] = {
-			translation: msg.defaultMessage,
-			notes: 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.translation;
-	}
-	return results;
-};

package/src/formatters/simple.d.ts

@@ -1,4 +0,0 @@
-import { type CompileFn, type FormatFn } from "./default.js";
-export type PhraseJson = Record<string, string>;
-export declare const format: FormatFn<PhraseJson>;
-export declare const compile: CompileFn<PhraseJson>;

package/src/formatters/simple.js

@@ -1,8 +0,0 @@
-import "./default.js";
-export const format = (msgs) => {
-	return Object.keys(msgs).reduce((all, k) => {
-		all[k] = msgs[k].defaultMessage;
-		return all;
-	}, {});
-};
-export const compile = (msgs) => msgs;

package/src/formatters/smartling.d.ts

@@ -1,21 +0,0 @@
-import type { Comparator } from "json-stable-stringify";
-import { type CompileFn, type FormatFn } from "./default.js";
-export interface SmartlingDirectives {
-	translate_paths: [{
-		path: string;
-		key: string;
-		instruction: string;
-	}];
-	variants_enabled: boolean;
-	string_format: string;
-	[k: string]: any;
-}
-export type SmartlingJson = {
-	smartling: SmartlingDirectives;
-} & Record<string, {
-	message: string;
-	description?: string;
-}>;
-export declare const format: FormatFn<SmartlingJson>;
-export declare const compareMessages: Comparator;
-export declare const compile: CompileFn<SmartlingJson>;

package/src/formatters/smartling.js

@@ -1,39 +0,0 @@
-import "./default.js";
-export const format = (msgs) => {
-	const results = { smartling: {
-		translate_paths: [{
-			path: "*/message",
-			key: "{*}/message",
-			instruction: "*/description"
-		}],
-		variants_enabled: true,
-		string_format: "icu"
-	} };
-	for (const [id, msg] of Object.entries(msgs)) {
-		results[id] = {
-			message: msg.defaultMessage,
-			description: typeof msg.description === "string" ? msg.description : JSON.stringify(msg.description)
-		};
-	}
-	return results;
-};
-export const compareMessages = (el1, el2) => {
-	// `smartling` has to be the 1st key
-	if (el1.key === "smartling") {
-		return -1;
-	}
-	if (el2.key === "smartling") {
-		return 1;
-	}
-	return el1.key < el2.key ? -1 : el1.key === el2.key ? 0 : 1;
-};
-export const compile = (msgs) => {
-	const results = {};
-	for (const [id, msg] of Object.entries(msgs)) {
-		if (id === "smartling") {
-			continue;
-		}
-		results[id] = msg.message;
-	}
-	return results;
-};