@formatjs/cli-lib 8.1.0 → 8.2.0

package/src/extract.js

@@ -1,190 +1,177 @@
-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';
+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 };
+	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('.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 };
+	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(".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`
- */
+* 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, ...opts } = extractOpts;
-    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', opts)];
-        }
-        else {
-            rawResults = await Promise.all(files.map(async (fn) => {
-                debug('Extracting file:', fn);
-                const source = await readFile(fn, 'utf8');
-                return processFile(source, fn, opts);
-            }));
-        }
-    }
-    catch (e) {
-        if (throws) {
-            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:
+	const { throws, readFromStdin, ...opts } = extractOpts;
+	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", opts)];
+		} else {
+			rawResults = await Promise.all(files.map(async (fn) => {
+				debug("Extracting file:", fn);
+				const source = await readFile(fn, "utf8");
+				return processFile(source, fn, opts);
+			}));
+		}
+	} catch (e) {
+		if (throws) {
+			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,
-    }) ?? '');
+				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
- */
+* 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);
+	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 +1,7 @@
-import { CompileFn, FormatFn } from './default.js';
+import { type CompileFn, type FormatFn } from "./default.js";
 export type CrowdinJson = Record<string, {
-    message: string;
-    description?: string;
+	message: string;
+	description?: string;
 }>;
 export declare const format: FormatFn<CrowdinJson>;
 export declare const compile: CompileFn<CrowdinJson>;

package/src/formatters/crowdin.js

@@ -1,22 +1,21 @@
-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;
+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;
+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,4 +1,4 @@
-import { MessageDescriptor } from '@formatjs/ts-transformer';
+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;

package/src/formatters/default.js

@@ -1,8 +1,9 @@
-export const format = msgs => msgs;
-export const compile = msgs => {
-    const results = {};
-    for (const k in msgs) {
-        results[k] = msgs[k].defaultMessage;
-    }
-    return results;
+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 +1,9 @@
-import type { Comparator } from 'json-stable-stringify';
-import { CompileFn, FormatFn, SerializeFn } from './default.js';
+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;
+	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,36 +1,31 @@
-import { resolve } from 'path';
-import { pathToFileURL } from 'url';
-import * as crowdin from './crowdin.js';
-import * as defaultFormatter from './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';
+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;
-    }
+	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 +1,9 @@
-import { CompileFn, FormatFn } from './default.js';
+import { type CompileFn, type FormatFn } from "./default.js";
 export type StructuredJson = Record<string, {
-    translation: string;
-    notes?: string;
-    context?: string;
-    limit?: 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,19 +1,18 @@
-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;
+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;
+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 +1,4 @@
-import { CompileFn, FormatFn } from './default.js';
+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,7 +1,8 @@
-export const format = msgs => {
-    return Object.keys(msgs).reduce((all, k) => {
-        all[k] = msgs[k].defaultMessage;
-        return all;
-    }, {});
+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;
+export const compile = (msgs) => msgs;

package/src/formatters/smartling.d.ts

@@ -1,22 +1,20 @@
-import type { Comparator } from 'json-stable-stringify';
-import { CompileFn, FormatFn } from './default.js';
+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;
+	translate_paths: [{
+		path: string;
+		key: string;
+		instruction: string;
+	}];
+	variants_enabled: boolean;
+	string_format: string;
+	[k: string]: any;
 }
 export type SmartlingJson = {
-    smartling: SmartlingDirectives;
+	smartling: SmartlingDirectives;
 } & Record<string, {
-    message: string;
-    description?: string;
+	message: string;
+	description?: string;
 }>;
 export declare const format: FormatFn<SmartlingJson>;
 export declare const compareMessages: Comparator;