@formatjs/cli 2.13.16 → 2.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formatjs/cli",
-  "version": "2.13.16",
+  "version": "2.15.0",
   "description": "A CLI for formatjs.",
   "keywords": [
     "intl",
@@ -31,16 +31,18 @@
     "url": "git+ssh://git@github.com/formatjs/formatjs.git"
   },
   "dependencies": {
-    "@formatjs/ts-transformer": "2.12.11",
+    "@formatjs/ts-transformer": "2.13.0",
     "@types/json-stable-stringify": "^1.0.32",
     "@types/lodash": "^4.14.150",
     "@types/loud-rejection": "^2.0.0",
     "@types/node": "14",
+    "@vue/compiler-core": "^3.0.0",
+    "@vue/compiler-sfc": "^3.0.5",
     "chalk": "^4.0.0",
     "commander": "^6.1.0",
     "fast-glob": "^3.2.4",
     "fs-extra": "^9.0.0",
-    "intl-messageformat-parser": "6.1.0",
+    "intl-messageformat-parser": "6.1.2",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.15",
     "loud-rejection": "^2.2.0",

package/src/cli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../../../../../packages/cli/src/cli.ts"],"names":[],"mappings":"AASA,iBAAe,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,iBAgNjC;AACD,eAAe,IAAI,CAAC"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../../../../../packages/cli/src/cli.ts"],"names":[],"mappings":"AASA,iBAAe,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,iBAsNjC;AACD,eAAe,IAAI,CAAC"}

package/src/cli.js

@@ -28,7 +28,7 @@ function main(argv) {
                 .description('Show this help message.')
                 .action(function () { return commander_1.default.help(); });
             // Long text wrapping to available terminal columns: https://github.com/tj/commander.js/pull/956
-            // NOTE: please keep the help text in sync with babel-plugin-react-intl documentation.
+            // NOTE: please keep the help text in sync with babel-plugin-formatjs documentation.
             commander_1.default
                 .command('extract [files...]')
                 .description("Extract string messages from React components that use react-intl.\nThe input language is expected to be TypeScript or ES2017 with JSX.")
@@ -38,6 +38,7 @@ function main(argv) {
                 .option('--extract-source-location', "Whether the metadata about the location of the message in the source file should be \nextracted. If `true`, then `file`, `start`, and `end` fields will exist for each \nextracted message descriptors.", false)
                 .option('--remove-default-message', 'Remove `defaultMessage` field in generated js after extraction', false)
                 .option('--additional-component-names <comma-separated-names>', "Additional component names to extract messages from, e.g: `['FormattedFooBarMessage']`. \n**NOTE**: By default we check for the fact that `FormattedMessage` \nis imported from `moduleSourceName` to make sure variable alias \nworks. This option does not do that so it's less safe.", function (val) { return val.split(','); })
+                .option('--additional-function-names <comma-separated-names>', "Additional function names to extract messages from, e.g: `['$t']`.", function (val) { return val.split(','); })
                 .option('--extract-from-format-message-call', "Opt-in to extract from `intl.formatMessage` call with the same restrictions, e.g: has \nto be called with object literal such as `intl.formatMessage({ id: 'foo', defaultMessage: \n'bar', description: 'baz'})", true)
                 .option('--ignore <files...>', 'List of glob paths to **not** extract translations from.')
                 .option('--throws', 'Whether to throw an exception when we fail to process any file in the batch.')
@@ -60,6 +61,7 @@ function main(argv) {
                                     extractSourceLocation: cmdObj.extractSourceLocation,
                                     removeDefaultMessage: cmdObj.removeDefaultMessage,
                                     additionalComponentNames: cmdObj.additionalComponentNames,
+                                    additionalFunctionNames: cmdObj.additionalFunctionNames,
                                     extractFromFormatMessageCall: cmdObj.extractFromFormatMessageCall,
                                     throws: cmdObj.throws,
                                     pragma: cmdObj.pragma,

package/src/extract.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"extract.d.ts","sourceRoot":"","sources":["../../../../../../packages/cli/src/extract.ts"],"names":[],"mappings":"AAEA,OAAO,EAGL,IAAI,EACJ,iBAAiB,EAClB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAA0B,SAAS,EAAC,MAAM,cAAc,CAAC;AAGhE,MAAM,WAAW,gBAAgB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAC1D;;OAEG;IACH,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,CAAC,CAAC;CACV;AAED,MAAM,WAAW,0BAA2B,SAAQ,iBAAiB;IACnE;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B;AAED,oBAAY,iBAAiB,GAAG,IAAI,CAClC,WAAW,EACX,cAAc,GAAG,gBAAgB,GAAG,iBAAiB,CACtD,GAAG;IACF;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,oBAAY,WAAW,GAAG,IAAI,GAAG;IAC/B;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,GAAG,IAAI,CAAC,IAAI,EAAE,gBAAgB,GAAG,iBAAiB,CAAC,CAAC;AAkGrD;;;;;;GAMG;AACH,wBAAsB,OAAO,CAC3B,KAAK,EAAE,SAAS,MAAM,EAAE,EACxB,WAAW,EAAE,WAAW,mBAgFzB;AAED;;;;;GAKG;AACH,wBAA8B,eAAe,CAC3C,KAAK,EAAE,SAAS,MAAM,EAAE,EACxB,WAAW,EAAE,iBAAiB,iBAS/B"}
+{"version":3,"file":"extract.d.ts","sourceRoot":"","sources":["../../../../../../packages/cli/src/extract.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,IAAI,EACJ,iBAAiB,EAClB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAA0B,SAAS,EAAC,MAAM,cAAc,CAAC;AAIhE,MAAM,WAAW,gBAAgB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAC1D;;OAEG;IACH,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,CAAC,CAAC;CACV;AAED,MAAM,WAAW,0BAA2B,SAAQ,iBAAiB;IACnE;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B;AAED,oBAAY,iBAAiB,GAAG,IAAI,CAClC,WAAW,EACX,cAAc,GAAG,gBAAgB,GAAG,iBAAiB,CACtD,GAAG;IACF;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,oBAAY,WAAW,GAAG,IAAI,GAAG;IAC/B;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,GAAG,IAAI,CAAC,IAAI,EAAE,gBAAgB,GAAG,iBAAiB,CAAC,CAAC;AA2ErD;;;;;;GAMG;AACH,wBAAsB,OAAO,CAC3B,KAAK,EAAE,SAAS,MAAM,EAAE,EACxB,WAAW,EAAE,WAAW,mBAgFzB;AAED;;;;;GAKG;AACH,wBAA8B,eAAe,CAC3C,KAAK,EAAE,SAAS,MAAM,EAAE,EACxB,WAAW,EAAE,iBAAiB,iBAS/B"}

package/src/extract.js

@@ -5,9 +5,10 @@ var tslib_1 = require("tslib");
 var console_utils_1 = require("./console_utils");
 var fs_extra_1 = require("fs-extra");
 var ts_transformer_1 = require("@formatjs/ts-transformer");
-var typescript_1 = tslib_1.__importDefault(require("typescript"));
 var formatters_1 = require("./formatters");
 var json_stable_stringify_1 = tslib_1.__importDefault(require("json-stable-stringify"));
+var vue_extractor_1 = require("./vue_extractor");
+var parse_script_1 = require("./parse_script");
 function calculateLineColFromOffset(text, start) {
     if (!start) {
         return { line: 1, col: 1 };
@@ -21,7 +22,9 @@ function processFile(source, fn, _a) {
     var idInterpolationPattern = _a.idInterpolationPattern, opts = tslib_1.__rest(_a, ["idInterpolationPattern"]);
     var messages = [];
     var meta;
-    opts = tslib_1.__assign(tslib_1.__assign({}, opts), { onMsgExtracted: function (_, msgs) {
+    opts = tslib_1.__assign(tslib_1.__assign({}, opts), { additionalComponentNames: tslib_1.__spreadArrays([
+            '$formatMessage'
+        ], (opts.additionalComponentNames || [])), onMsgExtracted: function (_, msgs) {
             if (opts.extractSourceLocation) {
                 msgs = msgs.map(function (msg) { return (tslib_1.__assign(tslib_1.__assign({}, msg), calculateLineColFromOffset(source, msg.start))); });
             }
@@ -42,35 +45,12 @@ function processFile(source, fn, _a) {
                     });
             } });
     }
-    var output;
-    try {
-        output = typescript_1.default.transpileModule(source, {
-            compilerOptions: {
-                allowJs: true,
-                target: typescript_1.default.ScriptTarget.ESNext,
-                noEmit: true,
-                experimentalDecorators: true,
-            },
-            reportDiagnostics: true,
-            fileName: fn,
-            transformers: {
-                before: [ts_transformer_1.transform(opts)],
-            },
-        });
-    }
-    catch (e) {
-        e.message = "Error processing file " + fn + " \n" + (e.message || '');
-        throw e;
+    var scriptParseFn = parse_script_1.parseScript(opts, fn);
+    if (fn.endsWith('.vue')) {
+        vue_extractor_1.parseFile(source, fn, scriptParseFn);
     }
-    if (output.diagnostics) {
-        var errs = output.diagnostics.filter(function (d) { return d.category === typescript_1.default.DiagnosticCategory.Error; });
-        if (errs.length) {
-            throw new Error(typescript_1.default.formatDiagnosticsWithColorAndContext(errs, {
-                getCanonicalFileName: function (fileName) { return fileName; },
-                getCurrentDirectory: function () { return process.cwd(); },
-                getNewLine: function () { return typescript_1.default.sys.newLine; },
-            }));
-        }
+    else {
+        scriptParseFn(source);
     }
     if (meta) {
         messages.forEach(function (m) { return (m.meta = meta); });

package/src/parse_script.d.ts

@@ -0,0 +1,8 @@
+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;
+//# sourceMappingURL=parse_script.d.ts.map

package/src/parse_script.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse_script.d.ts","sourceRoot":"","sources":["../../../../../../packages/cli/src/parse_script.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAY,MAAM,0BAA0B,CAAC;AAGzD;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,MAAM,YACjC,MAAM,UAoCvB"}

package/src/parse_script.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseScript = void 0;
+var tslib_1 = require("tslib");
+var ts_transformer_1 = require("@formatjs/ts-transformer");
+var typescript_1 = tslib_1.__importDefault(require("typescript"));
+/**
+ * Invoid TypeScript module transpilation with our TS transformer
+ * @param opts Formatjs TS Transformer opt
+ * @param fn filename
+ */
+function parseScript(opts, fn) {
+    return function (source) {
+        var output;
+        try {
+            output = typescript_1.default.transpileModule(source, {
+                compilerOptions: {
+                    allowJs: true,
+                    target: typescript_1.default.ScriptTarget.ESNext,
+                    noEmit: true,
+                    experimentalDecorators: true,
+                },
+                reportDiagnostics: true,
+                fileName: fn,
+                transformers: {
+                    before: [ts_transformer_1.transform(opts)],
+                },
+            });
+        }
+        catch (e) {
+            e.message = "Error processing file " + fn + " \n" + (e.message || '');
+            throw e;
+        }
+        if (output.diagnostics) {
+            var errs = output.diagnostics.filter(function (d) { return d.category === typescript_1.default.DiagnosticCategory.Error; });
+            if (errs.length) {
+                throw new Error(typescript_1.default.formatDiagnosticsWithColorAndContext(errs, {
+                    getCanonicalFileName: function (fileName) { return fileName; },
+                    getCurrentDirectory: function () { return process.cwd(); },
+                    getNewLine: function () { return typescript_1.default.sys.newLine; },
+                }));
+            }
+        }
+    };
+}
+exports.parseScript = parseScript;

package/src/vue_extractor.d.ts

@@ -0,0 +1,3 @@
+export declare type ScriptParseFn = (source: string) => void;
+export declare function parseFile(source: string, filename: string, parseScriptFn: ScriptParseFn): any;
+//# sourceMappingURL=vue_extractor.d.ts.map

package/src/vue_extractor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vue_extractor.d.ts","sourceRoot":"","sources":["../../../../../../packages/cli/src/vue_extractor.ts"],"names":[],"mappings":"AAOA,oBAAY,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;AA+BrD,wBAAgB,SAAS,CACvB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,aAAa,GAC3B,GAAG,CAgBL"}

package/src/vue_extractor.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseFile = void 0;
+var compiler_sfc_1 = require("@vue/compiler-sfc");
+function walk(node, visitor) {
+    if (node.type === 2 /* TEXT */ ||
+        node.type === 3 /* COMMENT */ ||
+        node.type === 9 /* IF */ ||
+        node.type === 12 /* TEXT_CALL */) {
+        return;
+    }
+    visitor(node);
+    if (node.type === 5 /* INTERPOLATION */) {
+        visitor(node.content);
+    }
+    else {
+        node.children.forEach(function (n) { return walk(n, visitor); });
+    }
+}
+function templateSimpleExpressionNodeVisitor(parseScriptFn) {
+    return function (n) {
+        if (n.type !== 4 /* SIMPLE_EXPRESSION */) {
+            return;
+        }
+        var content = n.content;
+        parseScriptFn(content);
+    };
+}
+function parseFile(source, filename, parseScriptFn) {
+    var _a = compiler_sfc_1.parse(source, {
+        filename: filename,
+    }), descriptor = _a.descriptor, errors = _a.errors;
+    if (errors.length) {
+        throw errors[0];
+    }
+    var script = descriptor.script, template = descriptor.template;
+    if (template) {
+        walk(template.ast, templateSimpleExpressionNodeVisitor(parseScriptFn));
+    }
+    if (script) {
+        parseScriptFn(script.content);
+    }
+}
+exports.parseFile = parseFile;