@lingui/macro 3.17.1 → 4.0.0-next.0

package/build/macroJs.js

@@ -4,14 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var R = _interopRequireWildcard(require("ramda"));
 var _types = require("@babel/types");
 var _icu = _interopRequireDefault(require("./icu"));
 var _utils = require("./utils");
 var _constants = require("./constants");
+var _api = require("@lingui/cli/api");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 const keepSpaceRe = /(?:\\(?:\r\n|\r|\n))+\s+/g;
 const keepNewLineRe = /(?:\r\n|\r|\n)+\s+/g;
 function normalizeWhitespace(text) {
@@ -26,27 +24,21 @@ class MacroJs {
   _expressionIndex = (0, _utils.makeCounter)();
   constructor({
     types
-  }, {
-    i18nImportName
-  }) {
+  }, opts) {
     this.types = types;
-    this.i18nImportName = i18nImportName;
+    this.i18nImportName = opts.i18nImportName;
+    this.stripNonEssentialProps = opts.stripNonEssentialProps;
+    this.nameMap = opts.nameMap;
+    this.nameMapReversed = Array.from(opts.nameMap.entries()).reduce((map, [key, value]) => map.set(value, key), new Map());
   }
   replacePathWithMessage = (path, {
     message,
     values
   }, linguiInstance) => {
-    const args = [];
-    args.push(isString(message) ? this.types.stringLiteral(message) : message);
-    if (Object.keys(values).length) {
-      const valuesObject = Object.keys(values).map(key => this.types.objectProperty(this.types.identifier(key), values[key]));
-      args.push(this.types.objectExpression(valuesObject));
-    }
-    const newNode = this.types.callExpression(this.types.memberExpression(linguiInstance ?? this.types.identifier(this.i18nImportName), this.types.identifier("_")), args);
-
-    // preserve line number
-    newNode.loc = path.node.loc;
-    path.addComment("leading", _constants.EXTRACT_MARK);
+    const properties = [this.createIdProperty(message), this.createObjectProperty(_constants.MESSAGE, this.types.stringLiteral(message)), this.createValuesProperty(values)];
+    const newNode = this.createI18nCall(this.createMessageDescriptor(properties,
+    // preserve line numbers for extractor
+    path.node.loc), linguiInstance);
     path.replaceWith(newNode);
   };
 
@@ -59,8 +51,8 @@ class MacroJs {
       return true;
     }
 
-    // t(i18nInstance)`Message` -> i18nInstance._('Message')
-    if (this.types.isCallExpression(path.node) && this.types.isTaggedTemplateExpression(path.parentPath.node) && this.types.isIdentifier(path.node.arguments[0]) && this.isIdentifier(path.node.callee, "t")) {
+    // t(i18nInstance)`Message` -> i18nInstance._(messageDescriptor)
+    if (this.types.isCallExpression(path.node) && this.types.isTaggedTemplateExpression(path.parentPath.node) && this.types.isExpression(path.node.arguments[0]) && this.isLinguiIdentifier(path.node.callee, "t")) {
       // Use the first argument as i18n instance instead of the default i18n instance
       const i18nInstance = path.node.arguments[0];
       const tokens = this.tokenizeNode(path.parentPath.node);
@@ -78,12 +70,12 @@ class MacroJs {
     }
 
     // t(i18nInstance)(messageDescriptor) -> i18nInstance._(messageDescriptor)
-    if (this.types.isCallExpression(path.node) && this.types.isCallExpression(path.parentPath.node) && this.types.isIdentifier(path.node.arguments[0]) && this.isIdentifier(path.node.callee, "t")) {
+    if (this.types.isCallExpression(path.node) && this.types.isCallExpression(path.parentPath.node) && this.types.isExpression(path.node.arguments[0]) && this.isLinguiIdentifier(path.node.callee, "t")) {
       const i18nInstance = path.node.arguments[0];
       this.replaceTAsFunction(path.parentPath, i18nInstance);
       return false;
     }
-    if (this.types.isCallExpression(path.node) && this.isIdentifier(path.node.callee, "t")) {
+    if (this.types.isCallExpression(path.node) && this.isLinguiIdentifier(path.node.callee, "t")) {
       this.replaceTAsFunction(path);
       return true;
     }
@@ -134,9 +126,8 @@ class MacroJs {
    * we create a new node to append it to i18n._
    */
   replaceTAsFunction = (path, linguiInstance) => {
-    let descriptor = this.processDescriptor(path.node.arguments[0]);
-    const newNode = this.types.callExpression(this.types.memberExpression(linguiInstance ?? this.types.identifier(this.i18nImportName), this.types.identifier("_")), [descriptor]);
-    path.replaceWith(newNode);
+    const descriptor = this.processDescriptor(path.node.arguments[0]);
+    path.replaceWith(this.createI18nCall(descriptor, linguiInstance));
   };
 
   /**
@@ -158,44 +149,52 @@ class MacroJs {
    */
   processDescriptor = descriptor_ => {
     const descriptor = descriptor_;
-    this.types.addComment(descriptor, "leading", _constants.EXTRACT_MARK);
-    const messageIndex = descriptor.properties.findIndex(property => (0, _types.isObjectProperty)(property) && this.isIdentifier(property.key, _constants.MESSAGE));
-    if (messageIndex === -1) {
-      return descriptor;
+    const messageProperty = this.getObjectPropertyByKey(descriptor, _constants.MESSAGE);
+    const idProperty = this.getObjectPropertyByKey(descriptor, _constants.ID);
+    const contextProperty = this.getObjectPropertyByKey(descriptor, _constants.CONTEXT);
+    const properties = [idProperty];
+    if (!this.stripNonEssentialProps) {
+      properties.push(contextProperty);
     }
 
     // if there's `message` property, replace macros with formatted message
-    const node = descriptor.properties[messageIndex];
-
-    // Inside message descriptor the `t` macro in `message` prop is optional.
-    // Template strings are always processed as if they were wrapped by `t`.
-    const tokens = this.types.isTemplateLiteral(node.value) ? this.tokenizeTemplateLiteral(node.value) : this.tokenizeNode(node.value, true);
-    let messageNode = node.value;
-    if (tokens != null) {
-      const messageFormat = new _icu.default();
-      const {
-        message: messageRaw,
-        values
-      } = messageFormat.fromTokens(tokens);
-      const message = normalizeWhitespace(messageRaw);
-      messageNode = this.types.stringLiteral(message);
-      this.addValues(descriptor.properties, values);
+    if (messageProperty) {
+      // Inside message descriptor the `t` macro in `message` prop is optional.
+      // Template strings are always processed as if they were wrapped by `t`.
+      const tokens = this.types.isTemplateLiteral(messageProperty.value) ? this.tokenizeTemplateLiteral(messageProperty.value) : this.tokenizeNode(messageProperty.value, true);
+      let messageNode = messageProperty.value;
+      if (tokens) {
+        const messageFormat = new _icu.default();
+        const {
+          message: messageRaw,
+          values
+        } = messageFormat.fromTokens(tokens);
+        const message = normalizeWhitespace(messageRaw);
+        messageNode = this.types.stringLiteral(message);
+        properties.push(this.createValuesProperty(values));
+      }
+      if (!this.stripNonEssentialProps) {
+        properties.push(this.createObjectProperty(_constants.MESSAGE, messageNode));
+      }
+      if (!idProperty && this.types.isStringLiteral(messageNode)) {
+        const context = contextProperty && this.getTextFromExpression(contextProperty.value);
+        properties.push(this.createIdProperty(messageNode.value, context));
+      }
     }
-
-    // Don't override custom ID
-    const hasId = descriptor.properties.findIndex(property => (0, _types.isObjectProperty)(property) && this.isIdentifier(property.key, _constants.ID)) !== -1;
-    descriptor.properties[messageIndex] = this.types.objectProperty(this.types.identifier(hasId ? _constants.MESSAGE : _constants.ID), messageNode);
-    if (process.env.NODE_ENV === "production") {
-      descriptor.properties = descriptor.properties.filter(property => (0, _types.isObjectProperty)(property) && !this.isIdentifier(property.key, _constants.MESSAGE) && (0, _types.isObjectProperty)(property) && !this.isIdentifier(property.key, _constants.COMMENT));
+    if (!this.stripNonEssentialProps) {
+      properties.push(this.getObjectPropertyByKey(descriptor, _constants.COMMENT));
     }
-    return descriptor;
+    return this.createMessageDescriptor(properties, descriptor.loc);
   };
-  addValues = (obj, values) => {
+  createIdProperty(message, context) {
+    return this.createObjectProperty(_constants.ID, this.types.stringLiteral((0, _api.generateMessageId)(message, context)));
+  }
+  createValuesProperty(values) {
     const valuesObject = Object.keys(values).map(key => this.types.objectProperty(this.types.identifier(key), values[key]));
     if (!valuesObject.length) return;
-    obj.push(this.types.objectProperty(this.types.identifier("values"), this.types.objectExpression(valuesObject)));
-  };
-  tokenizeNode = (node, ignoreExpression = false) => {
+    return this.types.objectProperty(this.types.identifier("values"), this.types.objectExpression(valuesObject));
+  }
+  tokenizeNode(node, ignoreExpression = false) {
     if (this.isI18nMethod(node)) {
       // t
       return this.tokenizeTemplateLiteral(node);
@@ -206,35 +205,37 @@ class MacroJs {
       //   // date, number
       //   return transformFormatMethod(node, file, props, root)
     } else if (!ignoreExpression) {
-      return this.tokenizeExpression(node);
+      return [this.tokenizeExpression(node)];
     }
-  };
+  }
 
   /**
    * `node` is a TemplateLiteral. node.quasi contains
    * text chunks and node.expressions contains expressions.
    * Both arrays must be zipped together to get the final list of tokens.
    */
-  tokenizeTemplateLiteral = node => {
-    const tokenize = R.pipe(R.evolve({
-      quasis: R.map(text => {
-        // Don't output tokens without text.
-        // if it's an unicode we keep the cooked value because it's the parsed value by babel (without unicode chars)
-        // This regex will detect if a string contains unicode chars, when they're we should interpolate them
-        // why? because platforms like react native doesn't parse them, just doing a JSON.parse makes them UTF-8 friendly
-        const value = /\\u[a-fA-F0-9]{4}|\\x[a-fA-F0-9]{2}/g.test(text.value.raw) ? text.value.cooked : text.value.raw;
-        if (value === "") return null;
-        return {
-          type: "text",
-          value: this.clearBackslashes(value)
-        };
-      }),
-      expressions: R.map(exp => this.types.isCallExpression(exp) ? this.tokenizeNode(exp) : this.tokenizeExpression(exp))
-    }), exp => (0, _utils.zip)(exp.quasis, exp.expressions), R.flatten, R.filter(Boolean));
-    return tokenize(this.types.isTaggedTemplateExpression(node) ? node.quasi : node);
-  };
-  tokenizeChoiceComponent = node => {
-    const format = node.callee.name.toLowerCase();
+  tokenizeTemplateLiteral(node) {
+    const tpl = this.types.isTaggedTemplateExpression(node) ? node.quasi : node;
+    const expressions = tpl.expressions;
+    return tpl.quasis.flatMap((text, i) => {
+      // if it's an unicode we keep the cooked value because it's the parsed value by babel (without unicode chars)
+      // This regex will detect if a string contains unicode chars, when they're we should interpolate them
+      // why? because platforms like react native doesn't parse them, just doing a JSON.parse makes them UTF-8 friendly
+      const value = /\\u[a-fA-F0-9]{4}|\\x[a-fA-F0-9]{2}/g.test(text.value.raw) ? text.value.cooked : text.value.raw;
+      let argTokens = [];
+      const currExp = expressions[i];
+      if (currExp) {
+        argTokens = this.types.isCallExpression(currExp) ? this.tokenizeNode(currExp) : [this.tokenizeExpression(currExp)];
+      }
+      return [...(value ? [{
+        type: "text",
+        value: this.clearBackslashes(value)
+      }] : []), ...argTokens];
+    });
+  }
+  tokenizeChoiceComponent(node) {
+    const name = node.callee.name;
+    const format = (this.nameMapReversed.get(name) || name).toLowerCase();
     const token = {
       ...this.tokenizeExpression(node.arguments[0]),
       format,
@@ -269,8 +270,8 @@ class MacroJs {
       }
     }
     return token;
-  };
-  tokenizeExpression = node => {
+  }
+  tokenizeExpression(node) {
     if (this.isArg(node) && this.types.isCallExpression(node)) {
       return {
         type: "arg",
@@ -283,8 +284,8 @@ class MacroJs {
       name: this.expressionToArgument(node),
       value: node
     };
-  };
-  expressionToArgument = exp => {
+  }
+  expressionToArgument(exp) {
     if (this.types.isIdentifier(exp)) {
       return exp.name;
     } else if (this.types.isStringLiteral(exp)) {
@@ -292,7 +293,7 @@ class MacroJs {
     } else {
       return String(this._expressionIndex());
     }
-  };
+  }
 
   /**
    * We clean '//\` ' to just '`'
@@ -301,27 +302,54 @@ class MacroJs {
     // if not we replace the extra scaped literals
     return value.replace(/\\`/g, "`");
   }
+  createI18nCall(messageDescriptor, linguiInstance) {
+    return this.types.callExpression(this.types.memberExpression(linguiInstance ?? this.types.identifier(this.i18nImportName), this.types.identifier("_")), [messageDescriptor]);
+  }
+  createMessageDescriptor(properties, oldLoc) {
+    const newDescriptor = this.types.objectExpression(properties.filter(Boolean));
+    this.types.addComment(newDescriptor, "leading", _constants.EXTRACT_MARK);
+    if (oldLoc) {
+      newDescriptor.loc = oldLoc;
+    }
+    return newDescriptor;
+  }
+  createObjectProperty(key, value) {
+    return this.types.objectProperty(this.types.identifier(key), value);
+  }
+  getObjectPropertyByKey(objectExp, key) {
+    return objectExp.properties.find(property => (0, _types.isObjectProperty)(property) && this.isLinguiIdentifier(property.key, key));
+  }
 
   /**
    * Custom matchers
    */
-  isIdentifier = (node, name) => {
+  isLinguiIdentifier(node, name) {
     return this.types.isIdentifier(node, {
-      name
+      name: this.nameMap.get(name) || name
     });
-  };
-  isDefineMessage = node => {
-    return this.types.isCallExpression(node) && this.isIdentifier(node.callee, "defineMessage");
-  };
-  isArg = node => {
-    return this.types.isCallExpression(node) && this.isIdentifier(node.callee, "arg");
-  };
-  isI18nMethod = node => {
-    return this.types.isTaggedTemplateExpression(node) && (this.isIdentifier(node.tag, "t") || this.types.isCallExpression(node.tag) && this.isIdentifier(node.tag.callee, "t"));
-  };
-  isChoiceMethod = node => {
-    return this.types.isCallExpression(node) && (this.isIdentifier(node.callee, "plural") || this.isIdentifier(node.callee, "select") || this.isIdentifier(node.callee, "selectOrdinal"));
-  };
+  }
+  isDefineMessage(node) {
+    return this.types.isCallExpression(node) && this.isLinguiIdentifier(node.callee, "defineMessage");
+  }
+  isArg(node) {
+    return this.types.isCallExpression(node) && this.isLinguiIdentifier(node.callee, "arg");
+  }
+  isI18nMethod(node) {
+    return this.types.isTaggedTemplateExpression(node) && (this.isLinguiIdentifier(node.tag, "t") || this.types.isCallExpression(node.tag) && this.isLinguiIdentifier(node.tag.callee, "t"));
+  }
+  isChoiceMethod(node) {
+    return this.types.isCallExpression(node) && (this.isLinguiIdentifier(node.callee, "plural") || this.isLinguiIdentifier(node.callee, "select") || this.isLinguiIdentifier(node.callee, "selectOrdinal"));
+  }
+  getTextFromExpression(exp) {
+    if (this.types.isStringLiteral(exp)) {
+      return exp.value;
+    }
+    if (this.types.isTemplateLiteral(exp)) {
+      if ((exp === null || exp === void 0 ? void 0 : exp.quasis.length) === 1) {
+        var _exp$quasis$, _exp$quasis$$value;
+        return (_exp$quasis$ = exp.quasis[0]) === null || _exp$quasis$ === void 0 ? void 0 : (_exp$quasis$$value = _exp$quasis$.value) === null || _exp$quasis$$value === void 0 ? void 0 : _exp$quasis$$value.cooked;
+      }
+    }
+  }
 }
-exports.default = MacroJs;
-const isString = s => typeof s === "string";
+exports.default = MacroJs;