@lingui/macro 4.0.0-next.0 → 4.0.0-next.2

package/build/index.d.ts

@@ -13,7 +13,7 @@ export type ChoiceOptions = {
   many?: string
 
   /** Catch-all option */
-  other?: string
+  other: string
   /** Exact match form, corresponds to =N rule */
   [digit: `${number}`]: string
 }
@@ -193,6 +193,29 @@ export function defineMessage(
   descriptor: MacroMessageDescriptor
 ): MessageDescriptor
 
+/**
+ * Define a message for later use
+ *
+ * @example
+ * ```
+ * import { defineMessage, msg } from "@lingui/macro";
+ * const message = defineMessage`Hello ${name}`;
+ *
+ * // or using shorter version
+ * const message = msg`Hello ${name}`;
+ * ```
+ */
+export function defineMessage(
+  literals: TemplateStringsArray,
+  ...placeholders: any[]
+): MessageDescriptor
+
+/**
+ * Define a message for later use
+ * Alias for {@see defineMessage}
+ */
+export const msg: typeof defineMessage
+
 type CommonProps = {
   id?: string
   comment?: string

package/build/index.js

@@ -10,7 +10,7 @@ var _macroJs = _interopRequireDefault(require("./macroJs"));
 var _macroJsx = _interopRequireDefault(require("./macroJsx"));
 var _types = require("@babel/types");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-const jsMacroTags = new Set(["defineMessage", "arg", "t", "plural", "select", "selectOrdinal"]);
+const jsMacroTags = new Set(["defineMessage", "msg", "arg", "t", "plural", "select", "selectOrdinal"]);
 const jsxMacroTags = new Set(["Trans", "Plural", "Select", "SelectOrdinal"]);
 let config;
 function getConfig(_config) {

package/build/macroJs.js

@@ -15,6 +15,17 @@ const keepNewLineRe = /(?:\r\n|\r|\n)+\s+/g;
 function normalizeWhitespace(text) {
   return text.replace(keepSpaceRe, " ").replace(keepNewLineRe, "\n").trim();
 }
+function buildICUFromTokens(tokens) {
+  const messageFormat = new _icu.default();
+  const {
+    message,
+    values
+  } = messageFormat.fromTokens(tokens);
+  return {
+    message: normalizeWhitespace(message),
+    values
+  };
+}
 class MacroJs {
   // Babel Types
 
@@ -31,14 +42,8 @@ class MacroJs {
     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 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);
+  replacePathWithMessage = (path, tokens, linguiInstance) => {
+    const newNode = this.createI18nCall(this.createMessageDescriptorFromTokens(tokens, path.node.loc), linguiInstance);
     path.replaceWith(newNode);
   };
 
@@ -46,9 +51,20 @@ class MacroJs {
   replacePath = path => {
     // reset the expression counter
     this._expressionIndex = (0, _utils.makeCounter)();
-    if (this.isDefineMessage(path.node)) {
-      this.replaceDefineMessage(path);
-      return true;
+
+    // defineMessage({ message: "Message", context: "My" }) -> {id: <hash + context>, message: "Message"}
+    if (this.types.isCallExpression(path.node) && this.isDefineMessage(path.node.callee)) {
+      let descriptor = this.processDescriptor(path.node.arguments[0]);
+      path.replaceWith(descriptor);
+      return false;
+    }
+
+    // defineMessage`Message` -> {id: <hash>, message: "Message"}
+    if (this.types.isTaggedTemplateExpression(path.node) && this.isDefineMessage(path.node.tag)) {
+      const tokens = this.tokenizeTemplateLiteral(path.node.quasi);
+      const descriptor = this.createMessageDescriptorFromTokens(tokens, path.node.loc);
+      path.replaceWith(descriptor);
+      return false;
     }
 
     // t(i18nInstance)`Message` -> i18nInstance._(messageDescriptor)
@@ -56,71 +72,27 @@ class MacroJs {
       // 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);
-      const messageFormat = new _icu.default();
-      const {
-        message: messageRaw,
-        values
-      } = messageFormat.fromTokens(tokens);
-      const message = normalizeWhitespace(messageRaw);
-      this.replacePathWithMessage(path.parentPath, {
-        message,
-        values
-      }, i18nInstance);
+      this.replacePathWithMessage(path.parentPath, tokens, i18nInstance);
       return false;
     }
 
     // t(i18nInstance)(messageDescriptor) -> i18nInstance._(messageDescriptor)
-    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")) {
+    if (this.types.isCallExpression(path.node) && this.types.isCallExpression(path.parentPath.node) && this.types.isExpression(path.node.arguments[0]) && path.parentPath.node.callee === path.node && this.isLinguiIdentifier(path.node.callee, "t")) {
       const i18nInstance = path.node.arguments[0];
       this.replaceTAsFunction(path.parentPath, i18nInstance);
       return false;
     }
+
+    // t({...})
     if (this.types.isCallExpression(path.node) && this.isLinguiIdentifier(path.node.callee, "t")) {
       this.replaceTAsFunction(path);
       return true;
     }
     const tokens = this.tokenizeNode(path.node);
-    const messageFormat = new _icu.default();
-    const {
-      message: messageRaw,
-      values
-    } = messageFormat.fromTokens(tokens);
-    const message = normalizeWhitespace(messageRaw);
-    this.replacePathWithMessage(path, {
-      message,
-      values
-    });
+    this.replacePathWithMessage(path, tokens);
     return true;
   };
 
-  /**
-   * macro `defineMessage` is called with MessageDescriptor. The only
-   * thing that happens is that any macros used in `message` property
-   * are replaced with formatted message.
-   *
-   * import { defineMessage, plural } from '@lingui/macro';
-   * const message = defineMessage({
-   *   id: "msg.id",
-   *   comment: "Description",
-   *   message: plural(value, { one: "book", other: "books" })
-   * })
-   *
-   * ↓ ↓ ↓ ↓ ↓ ↓
-   *
-   * const message = {
-   *   id: "msg.id",
-   *   comment: "Description",
-   *   message: "{value, plural, one {book} other {books}}"
-   * }
-   *
-   */
-  replaceDefineMessage = path => {
-    // reset the expression counter
-    this._expressionIndex = (0, _utils.makeCounter)();
-    let descriptor = this.processDescriptor(path.node.arguments[0]);
-    path.replaceWith(descriptor);
-  };
-
   /**
    * macro `t` is called with MessageDescriptor, after that
    * we create a new node to append it to i18n._
@@ -143,7 +115,8 @@ class MacroJs {
    *
    * {
    *   comment: "Description",
-   *   id: "{value, plural, one {book} other {books}}"
+   *   id: <hash>
+   *   message: "{value, plural, one {book} other {books}}"
    * }
    *
    */
@@ -164,12 +137,10 @@ class MacroJs {
       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,
+          message,
           values
-        } = messageFormat.fromTokens(tokens);
-        const message = normalizeWhitespace(messageRaw);
+        } = buildICUFromTokens(tokens);
         messageNode = this.types.stringLiteral(message);
         properties.push(this.createValuesProperty(values));
       }
@@ -263,6 +234,10 @@ class MacroJs {
           value = this.tokenizeTemplateLiteral(attrValue);
         } else if (this.types.isCallExpression(attrValue)) {
           value = this.tokenizeNode(attrValue);
+        } else if (this.types.isStringLiteral(attrValue)) {
+          value = attrValue.value;
+        } else if (this.types.isExpression(attrValue)) {
+          value = this.tokenizeExpression(attrValue);
         } else {
           value = attrValue.value;
         }
@@ -305,6 +280,16 @@ class MacroJs {
   createI18nCall(messageDescriptor, linguiInstance) {
     return this.types.callExpression(this.types.memberExpression(linguiInstance ?? this.types.identifier(this.i18nImportName), this.types.identifier("_")), [messageDescriptor]);
   }
+  createMessageDescriptorFromTokens(tokens, oldLoc) {
+    const {
+      message,
+      values
+    } = buildICUFromTokens(tokens);
+    const properties = [this.createIdProperty(message), !this.stripNonEssentialProps ? this.createObjectProperty(_constants.MESSAGE, this.types.stringLiteral(message)) : null, this.createValuesProperty(values)];
+    return this.createMessageDescriptor(properties,
+    // preserve line numbers for extractor
+    oldLoc);
+  }
   createMessageDescriptor(properties, oldLoc) {
     const newDescriptor = this.types.objectExpression(properties.filter(Boolean));
     this.types.addComment(newDescriptor, "leading", _constants.EXTRACT_MARK);
@@ -329,7 +314,7 @@ class MacroJs {
     });
   }
   isDefineMessage(node) {
-    return this.types.isCallExpression(node) && this.isLinguiIdentifier(node.callee, "defineMessage");
+    return this.isLinguiIdentifier(node, "defineMessage") || this.isLinguiIdentifier(node, "msg");
   }
   isArg(node) {
     return this.types.isCallExpression(node) && this.isLinguiIdentifier(node.callee, "arg");

package/index.d.ts

@@ -13,7 +13,7 @@ export type ChoiceOptions = {
   many?: string
 
   /** Catch-all option */
-  other?: string
+  other: string
   /** Exact match form, corresponds to =N rule */
   [digit: `${number}`]: string
 }
@@ -193,6 +193,29 @@ export function defineMessage(
   descriptor: MacroMessageDescriptor
 ): MessageDescriptor
 
+/**
+ * Define a message for later use
+ *
+ * @example
+ * ```
+ * import { defineMessage, msg } from "@lingui/macro";
+ * const message = defineMessage`Hello ${name}`;
+ *
+ * // or using shorter version
+ * const message = msg`Hello ${name}`;
+ * ```
+ */
+export function defineMessage(
+  literals: TemplateStringsArray,
+  ...placeholders: any[]
+): MessageDescriptor
+
+/**
+ * Define a message for later use
+ * Alias for {@see defineMessage}
+ */
+export const msg: typeof defineMessage
+
 type CommonProps = {
   id?: string
   comment?: string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingui/macro",
-  "version": "4.0.0-next.0",
+  "version": "4.0.0-next.2",
   "description": "Macro for generating messages in ICU MessageFormat syntax",
   "main": "./build/index.js",
   "types": "./index.d.ts",
@@ -34,12 +34,12 @@
   "dependencies": {
     "@babel/runtime": "^7.20.13",
     "@babel/types": "^7.20.7",
-    "@lingui/cli": "^4.0.0-next.0",
-    "@lingui/conf": "^4.0.0-next.0"
+    "@lingui/cli": "^4.0.0-next.2",
+    "@lingui/conf": "^4.0.0-next.2"
   },
   "peerDependencies": {
-    "@lingui/core": "4.0.0-next.0",
-    "@lingui/react": "4.0.0-next.0",
+    "@lingui/core": "4.0.0-next.2",
+    "@lingui/react": "4.0.0-next.2",
     "babel-plugin-macros": "2 || 3"
   },
   "devDependencies": {
@@ -48,12 +48,7 @@
     "@babel/traverse": "7.20.12",
     "@types/babel-plugin-macros": "^2.8.5",
     "prettier": "2.8.3",
-    "tsd": "^0.25.0"
+    "tsd": "^0.26.1"
   },
-  "tsd": {
-    "compilerOptions": {
-      "strict": false
-    }
-  },
-  "gitHead": "637f5cf6beda9d4ebce4e15cd9fdaa23e404b660"
+  "gitHead": "556ab57e20c2ac9d384a22424c6a90c2ba0dd133"
 }