@formatjs/ts-transformer 2.8.0 → 2.10.1

package/_validate_dist-base_options.optionsvalid.d.ts

@@ -1,8 +1,9 @@
 
-// /home/longlho/.cache/bazel/_bazel_longlho/576c18efaac10246ec115c72af79fca6/sandbox/linux-sandbox/123/execroot/formatjs/node_modules/@bazel/typescript/internal/ts_project_options_validator.js checked attributes for //packages/ts-transformer:dist-base
+// /home/longlho/.cache/bazel/_bazel_longlho/576c18efaac10246ec115c72af79fca6/sandbox/linux-sandbox/3224/execroot/formatjs/node_modules/@bazel/typescript/internal/ts_project_options_validator.js checked attributes for //packages/ts-transformer:dist-base
 // composite:             false
 // declaration:           true
 // declaration_map:       true
 // incremental:           false
 // source_map:            false
 // emit_declaration_only: false
+// ts_build_info_file:    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formatjs/ts-transformer",
-  "version": "2.8.0",
+  "version": "2.10.1",
   "description": "TS Compiler transformer for formatjs",
   "main": "index.js",
   "types": "index.d.ts",
@@ -17,7 +17,7 @@
     "react-intl"
   ],
   "dependencies": {
-    "intl-messageformat-parser": "^6.0.5",
+    "intl-messageformat-parser": "^6.0.7",
     "typescript": "^4.0"
   },
   "author": "Long Ho <holevietlong@gmail.com>",

package/src/transform.d.ts

@@ -1,8 +1,9 @@
-import * as ts from 'typescript';
+import * as typescript from 'typescript';
 import { MessageDescriptor } from './types';
 export declare type Extractor = (filePath: string, msgs: MessageDescriptor[]) => void;
 export declare type MetaExtractor = (filePath: string, meta: Record<string, string>) => void;
 export declare type InterpolateNameFn = (id?: string, defaultMessage?: string, description?: string, filePath?: string) => string;
+declare type TypeScript = typeof typescript;
 export interface Opts {
     /**
      * Parse specific additional custom pragma.
@@ -66,5 +67,7 @@ export interface Opts {
      */
     ast?: boolean;
 }
-export declare function transform(opts: Opts): ts.TransformerFactory<ts.SourceFile>;
+export declare function transformWithTs(ts: TypeScript, opts: Opts): typescript.TransformerFactory<typescript.SourceFile>;
+export declare function transform(opts: Opts): typescript.TransformerFactory<typescript.SourceFile>;
+export {};
 //# sourceMappingURL=transform.d.ts.map

package/src/transform.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transform.d.ts","sourceRoot":"","sources":["../../../../../../packages/ts-transformer/src/transform.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AACjC,OAAO,EAAC,iBAAiB,EAAC,MAAM,SAAS,CAAC;AAG1C,oBAAY,SAAS,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,KAAK,IAAI,CAAC;AAC9E,oBAAY,aAAa,GAAG,CAC1B,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACzB,IAAI,CAAC;AAEV,oBAAY,iBAAiB,GAAG,CAC9B,EAAE,CAAC,EAAE,MAAM,EACX,cAAc,CAAC,EAAE,MAAM,EACvB,WAAW,CAAC,EAAE,MAAM,EACpB,QAAQ,CAAC,EAAE,MAAM,KACd,MAAM,CAAC;AAuCZ,MAAM,WAAW,IAAI;IACnB;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IACpC;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,SAAS,CAAC;IAC3B;;;OAGG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;IAChC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,iBAAiB,GAAG,MAAM,CAAC;IAC1C;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAoXD,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,wCAwBnC"}
+{"version":3,"file":"transform.d.ts","sourceRoot":"","sources":["../../../../../../packages/ts-transformer/src/transform.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,YAAY,CAAC;AACzC,OAAO,EAAC,iBAAiB,EAAC,MAAM,SAAS,CAAC;AAG1C,oBAAY,SAAS,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,KAAK,IAAI,CAAC;AAC9E,oBAAY,aAAa,GAAG,CAC1B,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACzB,IAAI,CAAC;AAEV,oBAAY,iBAAiB,GAAG,CAC9B,EAAE,CAAC,EAAE,MAAM,EACX,cAAc,CAAC,EAAE,MAAM,EACvB,WAAW,CAAC,EAAE,MAAM,EACpB,QAAQ,CAAC,EAAE,MAAM,KACd,MAAM,CAAC;AAQZ,aAAK,UAAU,GAAG,OAAO,UAAU,CAAC;AAmCpC,MAAM,WAAW,IAAI;IACnB;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IACpC;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,SAAS,CAAC;IAC3B;;;OAGG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;IAChC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,iBAAiB,GAAG,MAAM,CAAC;IAC1C;;;OAGG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAwZD,wBAAgB,eAAe,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,wDAwBzD;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,wDAEnC"}

package/src/transform.js

@@ -37,8 +37,8 @@ var __spreadArrays = (this && this.__spreadArrays) || function () {
     return r;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transform = void 0;
-var ts = __importStar(require("typescript"));
+exports.transform = exports.transformWithTs = void 0;
+var typescript = __importStar(require("typescript"));
 var interpolate_name_1 = require("./interpolate-name");
 var intl_messageformat_parser_1 = require("intl-messageformat-parser");
 var MESSAGE_DESC_KEYS = [
@@ -46,7 +46,7 @@ var MESSAGE_DESC_KEYS = [
     'defaultMessage',
     'description',
 ];
-function primitiveToTSNode(v) {
+function primitiveToTSNode(ts, v) {
     return typeof v === 'string'
         ? ts.createStringLiteral(v)
         : typeof v === 'number'
@@ -57,30 +57,30 @@ function primitiveToTSNode(v) {
                     : ts.createFalse()
                 : undefined;
 }
-function objToTSNode(obj) {
+function objToTSNode(ts, obj) {
     var props = Object.entries(obj).map(function (_a) {
         var k = _a[0], v = _a[1];
-        return ts.createPropertyAssignment(k, primitiveToTSNode(v) ||
+        return ts.createPropertyAssignment(k, primitiveToTSNode(ts, v) ||
             (Array.isArray(v)
-                ? ts.createArrayLiteral(v.map(objToTSNode))
+                ? ts.createArrayLiteral(v.map(function (n) { return objToTSNode(ts, n); }))
                 : typeof v === 'object'
-                    ? objToTSNode(v)
+                    ? objToTSNode(ts, v)
                     : ts.createNull()));
     });
     return ts.createObjectLiteral(props);
 }
-function messageASTToTSNode(ast) {
-    return ts.createArrayLiteral(ast.map(function (el) { return objToTSNode(el); }));
+function messageASTToTSNode(ts, ast) {
+    return ts.createArrayLiteral(ast.map(function (el) { return objToTSNode(ts, el); }));
 }
 var DEFAULT_OPTS = {
     onMsgExtracted: function () { return undefined; },
     onMetaExtracted: function () { return undefined; },
 };
-function isMultipleMessageDecl(node) {
+function isMultipleMessageDecl(ts, node) {
     return (ts.isIdentifier(node.expression) &&
         node.expression.text === 'defineMessages');
 }
-function isSingularMessageDecl(node, additionalComponentNames) {
+function isSingularMessageDecl(ts, node, additionalComponentNames) {
     var compNames = new Set(__spreadArrays([
         'FormattedMessage',
         'defineMessage'
@@ -98,7 +98,7 @@ function isSingularMessageDecl(node, additionalComponentNames) {
     }
     return compNames.has(fnName);
 }
-function extractMessageDescriptor(node, _a, sf) {
+function extractMessageDescriptor(ts, node, _a, sf) {
     var overrideIdFn = _a.overrideIdFn, extractSourceLocation = _a.extractSourceLocation;
     var properties = undefined;
     if (ts.isObjectLiteralExpression(node)) {
@@ -116,28 +116,42 @@ function extractMessageDescriptor(node, _a, sf) {
         var initializer = ts.isPropertyAssignment(prop) || ts.isJsxAttribute(prop)
             ? prop.initializer
             : undefined;
-        if (!initializer ||
-            !ts.isStringLiteral(initializer) ||
-            !name ||
-            !ts.isIdentifier(name)) {
-            return;
-        }
-        switch (name.text) {
-            case 'id':
-                msg.id = initializer.text;
-                break;
-            case 'defaultMessage':
-                msg.defaultMessage = initializer.text;
-                break;
-            case 'description':
-                msg.description = initializer.text;
-                break;
+        if (name && ts.isIdentifier(name) && initializer) {
+            if (ts.isStringLiteral(initializer)) {
+                switch (name.text) {
+                    case 'id':
+                        msg.id = initializer.text;
+                        break;
+                    case 'defaultMessage':
+                        msg.defaultMessage = initializer.text;
+                        break;
+                    case 'description':
+                        msg.description = initializer.text;
+                        break;
+                }
+            }
+            else if (ts.isNoSubstitutionTemplateLiteral(initializer)) {
+                switch (name.text) {
+                    case 'id':
+                        msg.id = initializer.text;
+                        break;
+                    case 'defaultMessage':
+                        msg.defaultMessage = initializer.text;
+                        break;
+                    case 'description':
+                        msg.description = initializer.text;
+                        break;
+                }
+            }
         }
     });
     // We extracted nothing
     if (!msg.defaultMessage && !msg.id) {
         return;
     }
+    if (msg.defaultMessage) {
+        msg.defaultMessage = msg.defaultMessage.trim().replace(/\s+/gm, ' ');
+    }
     if (msg.defaultMessage && overrideIdFn) {
         switch (typeof overrideIdFn) {
             case 'string':
@@ -164,7 +178,7 @@ function extractMessageDescriptor(node, _a, sf) {
  * @param node
  * @param sf
  */
-function isIntlFormatMessageCall(node) {
+function isIntlFormatMessageCall(ts, node) {
     var method = node.expression;
     // Handle intl.formatMessage()
     if (ts.isPropertyAccessExpression(method)) {
@@ -177,19 +191,19 @@ function isIntlFormatMessageCall(node) {
     // Handle formatMessage()
     return ts.isIdentifier(method) && method.text === 'formatMessage';
 }
-function extractMessageFromJsxComponent(node, opts, sf) {
+function extractMessageFromJsxComponent(ts, node, opts, sf) {
     var onMsgExtracted = opts.onMsgExtracted;
-    if (!isSingularMessageDecl(node, opts.additionalComponentNames || [])) {
+    if (!isSingularMessageDecl(ts, node, opts.additionalComponentNames || [])) {
         return node;
     }
-    var msg = extractMessageDescriptor(node, opts, sf);
+    var msg = extractMessageDescriptor(ts, node, opts, sf);
     if (!msg) {
         return node;
     }
     if (typeof onMsgExtracted === 'function') {
         onMsgExtracted(sf.fileName, [msg]);
     }
-    var attrs = setAttributesInJsxAttributes(node.attributes, {
+    var attrs = setAttributesInJsxAttributes(ts, node.attributes, {
         defaultMessage: opts.removeDefaultMessage
             ? undefined
             : msg.defaultMessage,
@@ -199,13 +213,13 @@ function extractMessageFromJsxComponent(node, opts, sf) {
         ? ts.createJsxOpeningElement(node.tagName, node.typeArguments, attrs)
         : ts.createJsxSelfClosingElement(node.tagName, node.typeArguments, attrs);
 }
-function setAttributesInObject(node, msg, ast) {
+function setAttributesInObject(ts, node, msg, ast) {
     var newProps = __spreadArrays([
         ts.createPropertyAssignment('id', ts.createStringLiteral(msg.id))
     ], (msg.defaultMessage
         ? [
             ts.createPropertyAssignment('defaultMessage', ast
-                ? messageASTToTSNode(intl_messageformat_parser_1.parse(msg.defaultMessage))
+                ? messageASTToTSNode(ts, intl_messageformat_parser_1.parse(msg.defaultMessage))
                 : ts.createStringLiteral(msg.defaultMessage)),
         ]
         : []));
@@ -222,13 +236,13 @@ function setAttributesInObject(node, msg, ast) {
     }
     return ts.createObjectLiteral(ts.createNodeArray(newProps));
 }
-function setAttributesInJsxAttributes(node, msg, ast) {
+function setAttributesInJsxAttributes(ts, node, msg, ast) {
     var newProps = __spreadArrays([
         ts.createJsxAttribute(ts.createIdentifier('id'), ts.createStringLiteral(msg.id))
     ], (msg.defaultMessage
         ? [
             ts.createJsxAttribute(ts.createIdentifier('defaultMessage'), ast
-                ? ts.createJsxExpression(undefined, messageASTToTSNode(intl_messageformat_parser_1.parse(msg.defaultMessage)))
+                ? ts.createJsxExpression(undefined, messageASTToTSNode(ts, intl_messageformat_parser_1.parse(msg.defaultMessage)))
                 : ts.createStringLiteral(msg.defaultMessage)),
         ]
         : []));
@@ -245,9 +259,9 @@ function setAttributesInJsxAttributes(node, msg, ast) {
     }
     return ts.createJsxAttributes(ts.createNodeArray(newProps));
 }
-function extractMessagesFromCallExpression(node, opts, sf) {
+function extractMessagesFromCallExpression(ts, node, opts, sf) {
     var onMsgExtracted = opts.onMsgExtracted;
-    if (isMultipleMessageDecl(node)) {
+    if (isMultipleMessageDecl(ts, node)) {
         var _a = node.arguments, arg = _a[0], restArgs = _a.slice(1);
         var descriptorsObj = void 0;
         if (ts.isObjectLiteralExpression(arg)) {
@@ -265,7 +279,7 @@ function extractMessagesFromCallExpression(node, opts, sf) {
             })
                 .map(function (prop) {
                 return ts.isObjectLiteralExpression(prop.initializer) &&
-                    extractMessageDescriptor(prop.initializer, opts, sf);
+                    extractMessageDescriptor(ts, prop.initializer, opts, sf);
             })
                 .filter(function (msg) { return !!msg; });
             if (!msgs_1.length) {
@@ -279,7 +293,7 @@ function extractMessagesFromCallExpression(node, opts, sf) {
                     !ts.isObjectLiteralExpression(prop.initializer)) {
                     return prop;
                 }
-                return ts.createPropertyAssignment(prop.name, setAttributesInObject(prop.initializer, {
+                return ts.createPropertyAssignment(prop.name, setAttributesInObject(ts, prop.initializer, {
                     defaultMessage: opts.removeDefaultMessage
                         ? undefined
                         : msgs_1[i].defaultMessage,
@@ -290,11 +304,11 @@ function extractMessagesFromCallExpression(node, opts, sf) {
             return ts.createCall(node.expression, node.typeArguments, ts.createNodeArray(__spreadArrays([clonedDescriptorsObj], restArgs)));
         }
     }
-    else if (isSingularMessageDecl(node, opts.additionalComponentNames || []) ||
-        (opts.extractFromFormatMessageCall && isIntlFormatMessageCall(node))) {
+    else if (isSingularMessageDecl(ts, node, opts.additionalComponentNames || []) ||
+        (opts.extractFromFormatMessageCall && isIntlFormatMessageCall(ts, node))) {
         var _b = node.arguments, descriptorsObj = _b[0], restArgs = _b.slice(1);
         if (ts.isObjectLiteralExpression(descriptorsObj)) {
-            var msg = extractMessageDescriptor(descriptorsObj, opts, sf);
+            var msg = extractMessageDescriptor(ts, descriptorsObj, opts, sf);
             if (!msg) {
                 return node;
             }
@@ -302,7 +316,7 @@ function extractMessagesFromCallExpression(node, opts, sf) {
                 onMsgExtracted(sf.fileName, [msg]);
             }
             return ts.createCall(node.expression, node.typeArguments, ts.createNodeArray(__spreadArrays([
-                setAttributesInObject(descriptorsObj, {
+                setAttributesInObject(ts, descriptorsObj, {
                     defaultMessage: opts.removeDefaultMessage
                         ? undefined
                         : msg.defaultMessage,
@@ -314,18 +328,18 @@ function extractMessagesFromCallExpression(node, opts, sf) {
     return node;
 }
 var PRAGMA_REGEX = /^\/\/ @([^\s]*) (.*)$/m;
-function getVisitor(ctx, sf, opts) {
+function getVisitor(ts, ctx, sf, opts) {
     var visitor = function (node) {
         var newNode = ts.isCallExpression(node)
-            ? extractMessagesFromCallExpression(node, opts, sf)
+            ? extractMessagesFromCallExpression(ts, node, opts, sf)
             : ts.isJsxOpeningElement(node) || ts.isJsxSelfClosingElement(node)
-                ? extractMessageFromJsxComponent(node, opts, sf)
+                ? extractMessageFromJsxComponent(ts, node, opts, sf)
                 : node;
         return ts.visitEachChild(newNode, visitor, ctx);
     };
     return visitor;
 }
-function transform(opts) {
+function transformWithTs(ts, opts) {
     opts = __assign(__assign({}, DEFAULT_OPTS), opts);
     var transformFn = function (ctx) {
         return function (sf) {
@@ -345,9 +359,13 @@ function transform(opts) {
                     }
                 }
             }
-            return ts.visitNode(sf, getVisitor(ctx, sf, opts));
+            return ts.visitNode(sf, getVisitor(ts, ctx, sf, opts));
         };
     };
     return transformFn;
 }
+exports.transformWithTs = transformWithTs;
+function transform(opts) {
+    return transformWithTs(typescript, opts);
+}
 exports.transform = transform;