@formatjs/cli-lib 7.0.3 → 7.1.0

package/src/extract.d.ts

@@ -1,74 +0,0 @@
-import { MessageDescriptor, Opts } from '@formatjs/ts-transformer';
-import { Formatter } from './formatters';
-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;
-    /**
-     * Ignore file glob pattern
-     */
-    ignore?: string[];
-};
-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;
-    /**
-     * Path to a formatter file that controls the shape of JSON file from `outFile`.
-     */
-    format?: string | Formatter<unknown>;
-    /**
-     * Whether to hoist selectors & flatten sentences
-     */
-    flatten?: boolean;
-} & 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,197 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.extract = extract;
-exports.default = extractAndWrite;
-const tslib_1 = require("tslib");
-const ts_transformer_1 = require("@formatjs/ts-transformer");
-const fs_extra_1 = require("fs-extra");
-const console_utils_1 = require("./console_utils");
-const icu_messageformat_parser_1 = require("@formatjs/icu-messageformat-parser");
-const manipulator_1 = require("@formatjs/icu-messageformat-parser/manipulator");
-const printer_1 = require("@formatjs/icu-messageformat-parser/printer");
-const json_stable_stringify_1 = tslib_1.__importDefault(require("json-stable-stringify"));
-const formatters_1 = require("./formatters");
-const parse_script_1 = require("./parse_script");
-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 ||
-                (0, ts_transformer_1.interpolateName)({
-                    resourcePath: fileName,
-                }, idInterpolationPattern, {
-                    content: description
-                        ? `${defaultMessage}#${typeof description === 'string'
-                            ? description
-                            : (0, json_stable_stringify_1.default)(description)}`
-                        : defaultMessage,
-                }),
-        };
-    }
-    (0, console_utils_1.debug)('Processing opts for %s: %s', fn, opts);
-    const scriptParseFn = (0, parse_script_1.parseScript)(opts, fn);
-    if (fn.endsWith('.vue')) {
-        (0, console_utils_1.debug)('Processing %s using vue extractor', fn);
-        const { parseFile } = await import('./vue_extractor.js');
-        parseFile(source, fn, scriptParseFn);
-    }
-    else if (fn.endsWith('.hbs')) {
-        (0, console_utils_1.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')) {
-        (0, console_utils_1.debug)('Processing %s as gts/gjs file', fn);
-        const { parseFile } = await import('./gts_extractor.js');
-        parseFile(source, fn, opts);
-    }
-    else {
-        (0, console_utils_1.debug)('Processing %s using typescript extractor', fn);
-        scriptParseFn(source);
-    }
-    (0, console_utils_1.debug)('Done extracting %s messages: %s', fn, messages);
-    if (meta) {
-        (0, console_utils_1.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`
- */
-async function extract(files, extractOpts) {
-    const { throws, readFromStdin, flatten, ...opts } = extractOpts;
-    let rawResults = [];
-    try {
-        if (readFromStdin) {
-            (0, console_utils_1.debug)(`Reading input from stdin`);
-            // Read from stdin
-            if (process.stdin.isTTY) {
-                (0, console_utils_1.warn)('Reading source file from TTY.');
-            }
-            const stdinSource = await (0, console_utils_1.getStdinAsString)();
-            rawResults = [await processFile(stdinSource, 'dummy', opts)];
-        }
-        else {
-            rawResults = await Promise.all(files.map(async (fn) => {
-                (0, console_utils_1.debug)('Extracting file:', fn);
-                const source = await (0, fs_extra_1.readFile)(fn, 'utf8');
-                return processFile(source, fn, opts);
-            }));
-        }
-    }
-    catch (e) {
-        if (throws) {
-            throw e;
-        }
-        else {
-            (0, console_utils_1.warn)(String(e));
-        }
-    }
-    const formatter = await (0, formatters_1.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 {
-                    (0, console_utils_1.warn)(error.message);
-                }
-                continue;
-            }
-            if (extractedMessages.has(id)) {
-                const existing = extractedMessages.get(id);
-                if ((0, json_stable_stringify_1.default)(description) !== (0, json_stable_stringify_1.default)(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 {
-                        (0, console_utils_1.warn)(error.message);
-                    }
-                }
-            }
-            extractedMessages.set(id, message);
-        }
-    }
-    const results = {};
-    const messages = Array.from(extractedMessages.values());
-    for (const { id, ...msg } of messages) {
-        if (flatten && msg.defaultMessage) {
-            msg.defaultMessage = (0, printer_1.printAST)((0, manipulator_1.hoistSelectors)((0, icu_messageformat_parser_1.parse)(msg.defaultMessage)));
-        }
-        results[id] = msg;
-    }
-    if (typeof formatter.serialize === 'function') {
-        return formatter.serialize(formatter.format(results));
-    }
-    return (0, json_stable_stringify_1.default)(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
- */
-async function extractAndWrite(files, extractOpts) {
-    const { outFile, ...opts } = extractOpts;
-    const serializedResult = (await extract(files, opts)) + '\n';
-    if (outFile) {
-        (0, console_utils_1.debug)('Writing output file:', outFile);
-        return (0, fs_extra_1.outputFile)(outFile, serializedResult);
-    }
-    await (0, console_utils_1.writeStdout)(serializedResult);
-}

package/src/formatters/crowdin.d.ts

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

package/src/formatters/crowdin.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compile = exports.format = void 0;
-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;
-};
-exports.format = format;
-const compile = msgs => {
-    const results = {};
-    for (const [id, msg] of Object.entries(msgs)) {
-        if (id === 'smartling') {
-            continue;
-        }
-        results[id] = msg.message;
-    }
-    return results;
-};
-exports.compile = compile;

package/src/formatters/default.d.ts

@@ -1,6 +0,0 @@
-import { 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,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compile = exports.format = void 0;
-const format = msgs => msgs;
-exports.format = format;
-const compile = msgs => {
-    const results = {};
-    for (const k in msgs) {
-        results[k] = msgs[k].defaultMessage;
-    }
-    return results;
-};
-exports.compile = compile;

package/src/formatters/index.d.ts

@@ -1,9 +0,0 @@
-import type { Comparator } from 'json-stable-stringify';
-import { CompileFn, FormatFn, SerializeFn } from './default';
-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,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveBuiltinFormatter = resolveBuiltinFormatter;
-const tslib_1 = require("tslib");
-const path_1 = require("path");
-const url_1 = require("url");
-const crowdin = tslib_1.__importStar(require("./crowdin"));
-const defaultFormatter = tslib_1.__importStar(require("./default"));
-const lokalise = tslib_1.__importStar(require("./lokalise"));
-const simple = tslib_1.__importStar(require("./simple"));
-const smartling = tslib_1.__importStar(require("./smartling"));
-const transifex = tslib_1.__importStar(require("./transifex"));
-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((0, url_1.pathToFileURL)((0, path_1.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 { CompileFn, FormatFn } from './default';
-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,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compile = exports.format = void 0;
-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;
-};
-exports.format = format;
-const compile = msgs => {
-    const results = {};
-    for (const [id, msg] of Object.entries(msgs)) {
-        results[id] = msg.translation;
-    }
-    return results;
-};
-exports.compile = compile;

package/src/formatters/simple.d.ts

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

package/src/formatters/simple.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compile = exports.format = void 0;
-const format = msgs => {
-    return Object.keys(msgs).reduce((all, k) => {
-        all[k] = msgs[k].defaultMessage;
-        return all;
-    }, {});
-};
-exports.format = format;
-const compile = msgs => msgs;
-exports.compile = compile;

package/src/formatters/smartling.d.ts

@@ -1,23 +0,0 @@
-import type { Comparator } from 'json-stable-stringify';
-import { CompileFn, FormatFn } from './default';
-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,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compile = exports.compareMessages = exports.format = void 0;
-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;
-};
-exports.format = format;
-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;
-};
-exports.compareMessages = compareMessages;
-const compile = msgs => {
-    const results = {};
-    for (const [id, msg] of Object.entries(msgs)) {
-        if (id === 'smartling') {
-            continue;
-        }
-        results[id] = msg.message;
-    }
-    return results;
-};
-exports.compile = compile;

package/src/formatters/transifex.d.ts

@@ -1,9 +0,0 @@
-import { CompileFn, FormatFn } from './default';
-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,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compile = exports.format = void 0;
-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;
-};
-exports.format = format;
-const compile = msgs => {
-    const results = {};
-    for (const [id, msg] of Object.entries(msgs)) {
-        results[id] = msg.string;
-    }
-    return results;
-};
-exports.compile = compile;

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,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseFile = parseFile;
-const content_tag_1 = require("content-tag");
-const hbs_extractor_1 = require("./hbs_extractor");
-const parse_script_1 = require("./parse_script");
-let p = new content_tag_1.Preprocessor();
-function parseFile(source, fileName, options) {
-    const scriptParseFn = (0, parse_script_1.parseScript)(options, fileName);
-    const transformedSource = p.process(source, { filename: fileName });
-    scriptParseFn(transformedSource);
-    // extract template from transformed source to then run through hbs processor
-    const parseResult = p.parse(source, { filename: fileName });
-    for (let parsed of parseResult) {
-        (0, hbs_extractor_1.parseFile)(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/hbs_extractor.js

@@ -1,48 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseFile = parseFile;
-const ember_template_recast_1 = require("ember-template-recast");
-function extractText(node, fileName, options) {
-    if (!options.onMsgExtracted)
-        return;
-    if (!options.overrideIdFn)
-        return;
-    if (node.path.type !== 'PathExpression')
-        return;
-    if (['format-message', 'formatMessage'].includes(node.path.original)) {
-        let [first, second] = node.params;
-        if (first.type !== 'StringLiteral')
-            return;
-        let message = first?.value;
-        let desc;
-        if (second?.type === 'StringLiteral') {
-            desc = second.value?.trim().replace(/\s+/gm, ' ');
-        }
-        let defaultMessage = message?.trim().replace(/\s+/gm, ' ');
-        let id = typeof options.overrideIdFn === 'string'
-            ? options.overrideIdFn
-            : options.overrideIdFn(undefined, defaultMessage, desc, fileName);
-        options.onMsgExtracted(fileName, [
-            {
-                id: id,
-                defaultMessage: defaultMessage,
-                description: desc,
-            },
-        ]);
-    }
-}
-function parseFile(source, fileName, options) {
-    let visitor = function () {
-        return {
-            MustacheStatement(node) {
-                extractText(node, fileName, options);
-            },
-            SubExpression(node) {
-                extractText(node, fileName, options);
-            },
-        };
-    };
-    // SAFETY: ember-template-recast's types are out of date,
-    // but it does not affect runtime
-    (0, ember_template_recast_1.transform)(source, visitor);
-}

package/src/parse_script.d.ts

@@ -1,7 +0,0 @@
-import { 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;