@lingui/macro 3.12.0 → 3.13.2

package/constants.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.EXTRACT_MARK = exports.COMMENT = exports.MESSAGE = exports.ID = void 0;
+exports.CONTEXT = exports.EXTRACT_MARK = exports.COMMENT = exports.MESSAGE = exports.ID = void 0;
 var ID = "id";
 exports.ID = ID;
 var MESSAGE = "message";
@@ -11,4 +11,6 @@ exports.MESSAGE = MESSAGE;
 var COMMENT = "comment";
 exports.COMMENT = COMMENT;
 var EXTRACT_MARK = "i18n";
-exports.EXTRACT_MARK = EXTRACT_MARK;
+exports.EXTRACT_MARK = EXTRACT_MARK;
+var CONTEXT = "context";
+exports.CONTEXT = CONTEXT;

package/global.d.ts

@@ -1,3 +1,4 @@
+// @ts-ignore
 declare module "@lingui/macro" {
   import type { MessageDescriptor, I18n } from "@lingui/core"
 
@@ -28,9 +29,9 @@ declare module "@lingui/macro" {
    * });
    * ```
    *
-   * @param messageDescriptior The descriptor to translate
+   * @param descriptor The message descriptor to translate
    */
-  export function t(messageDescriptior: MessageDescriptor): string
+  export function t(descriptor: MessageDescriptor): string
 
   /**
    * Translates a template string using the global I18n instance
@@ -47,7 +48,7 @@ declare module "@lingui/macro" {
   ): string
 
   /**
-   * Translates a template string using a given I18n instance
+   * Translates a template string or message descriptor using a given I18n instance
    *
    * @example
    * ```
@@ -59,12 +60,24 @@ declare module "@lingui/macro" {
    * });
    * const message = t(i18n)`Hello ${name}`;
    * ```
+   *
+   * @example
+   * ```
+   * import { t } from "@lingui/macro";
+   * import { I18n } from "@lingui/core";
+   * const i18n = new I18n({
+   *   locale: "nl",
+   *   messages: { "Hello {0}": "Hallo {0}" },
+   * });
+   * const message = t(i18n)({ message: `Hello ${name}` });
+   * ```
    */
   export function t(
-    i18n: I18n,
-    literals: TemplateStringsArray,
-    ...placeholders: any[]
-  ): string
+    i18n: I18n
+  ): {
+    (literals: TemplateStringsArray, ...placeholders: any[]): string
+    (descriptor: MessageDescriptor): string
+  }
 
   export type UnderscoreDigit<T = string> = { [digit: string]: T }
   export type ChoiceOptions<T = string> = {
@@ -146,13 +159,6 @@ declare module "@lingui/macro" {
     choices: Record<string, string> & BasicType
   ): string
 
-  /**
-   * Defines multiple messages for extraction
-   */
-  export function defineMessages<M extends Record<string, MessageDescriptor>>(
-    messages: M
-  ): M
-
   /**
    * Define a message for later use
    *

package/index.d.ts

@@ -34,9 +34,9 @@ export type ChoiceOptions<T = string> = {
  * });
  * ```
  *
- * @param messageDescriptior The descriptor to translate
+ * @param descriptor The message descriptor to translate
  */
-export function t(messageDescriptior: MessageDescriptor): string
+export function t(descriptor: MessageDescriptor): string
 
 /**
  * Translates a template string using the global I18n instance
@@ -53,7 +53,7 @@ export function t(
 ): string
 
 /**
- * Translates a template string using a given I18n instance
+ * Translates a template string or message descriptor using a given I18n instance
  *
  * @example
  * ```
@@ -65,12 +65,24 @@ export function t(
  * });
  * const message = t(i18n)`Hello ${name}`;
  * ```
+ *
+ * @example
+ * ```
+ * import { t } from "@lingui/macro";
+ * import { I18n } from "@lingui/core";
+ * const i18n = new I18n({
+ *   locale: "nl",
+ *   messages: { "Hello {0}": "Hallo {0}" },
+ * });
+ * const message = t(i18n)({ message: `Hello ${name}` });
+ * ```
  */
 export function t(
-  i18n: I18n,
-  literals: TemplateStringsArray,
-  ...placeholders: any[]
-): string
+  i18n: I18n
+): {
+  (literals: TemplateStringsArray, ...placeholders: any[]): string
+  (descriptor: MessageDescriptor): string
+}
 
 /**
  * Pluralize a message
@@ -136,15 +148,6 @@ export function selectOrdinal(
  */
 export function select(value: string, choices: ChoiceOptions): string
 
-/**
- * Defines multiple messages for extraction
- *
- * @see {@link defineMessage} for more details
- */
-export function defineMessages<M extends Record<string, MessageDescriptor>>(
-  messages: M
-): M
-
 /**
  * Define a message for later use
  *
@@ -168,6 +171,7 @@ export type TransProps = {
   id?: string
   comment?: string
   values?: Record<string, unknown>
+  context?: string
   component?: React.ComponentType<TransRenderProps>
   render?: (props: TransRenderProps) => ReactElement<any, any> | null
 }

package/index.js

@@ -147,7 +147,6 @@ function alreadyVisited(path) {
 
 function getMacroType(tagName) {
   switch (tagName) {
-    case "defineMessages":
     case "defineMessage":
     case "arg":
     case "t":

package/macroJs.js

@@ -129,6 +129,15 @@ var MacroJs = /*#__PURE__*/function () {
           comment: _comment
         }, i18nInstance);
 
+        return false;
+      } // 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")) {
+        var _i18nInstance = path.node.arguments[0];
+
+        _this.replaceTAsFunction(path.parentPath, _i18nInstance);
+
         return false;
       }
 
@@ -167,10 +176,10 @@ var MacroJs = /*#__PURE__*/function () {
 
       path.replaceWith(descriptor);
     });
-    (0, _defineProperty2.default)(this, "replaceTAsFunction", function (path) {
+    (0, _defineProperty2.default)(this, "replaceTAsFunction", function (path, linguiInstance) {
       var descriptor = _this.processDescriptor(path.node.arguments[0]);
 
-      var newNode = _this.types.callExpression(_this.types.memberExpression(_this.types.identifier(_this.i18nImportName), _this.types.identifier("_")), [descriptor]);
+      var newNode = _this.types.callExpression(_this.types.memberExpression(linguiInstance !== null && linguiInstance !== void 0 ? linguiInstance : _this.types.identifier(_this.i18nImportName), _this.types.identifier("_")), [descriptor]);
 
       path.replaceWith(newNode);
     });

package/macroJsx.js

@@ -81,7 +81,8 @@ var MacroJSX = /*#__PURE__*/function () {
       var _this$stripMacroAttri = _this.stripMacroAttributes(path.node),
           attributes = _this$stripMacroAttri.attributes,
           id = _this$stripMacroAttri.id,
-          comment = _this$stripMacroAttri.comment;
+          comment = _this$stripMacroAttri.comment,
+          context = _this$stripMacroAttri.context;
 
       if (!id && !message) {
         return;
@@ -103,6 +104,10 @@ var MacroJSX = /*#__PURE__*/function () {
         if (comment) {
           attributes.push(_this.types.jsxAttribute(_this.types.jsxIdentifier(_constants.COMMENT), _this.types.stringLiteral(comment)));
         }
+      }
+
+      if (context) {
+        attributes.push(_this.types.jsxAttribute(_this.types.jsxIdentifier(_constants.CONTEXT), _this.types.stringLiteral(context)));
       } // Parameters for variable substitution
 
 
@@ -147,7 +152,8 @@ var MacroJSX = /*#__PURE__*/function () {
       var id = attributes.filter(_this.attrName([_constants.ID]))[0];
       var message = attributes.filter(_this.attrName([_constants.MESSAGE]))[0];
       var comment = attributes.filter(_this.attrName([_constants.COMMENT]))[0];
-      var reserved = [_constants.ID, _constants.MESSAGE, _constants.COMMENT];
+      var context = attributes.filter(_this.attrName([_constants.CONTEXT]))[0];
+      var reserved = [_constants.ID, _constants.MESSAGE, _constants.COMMENT, _constants.CONTEXT];
 
       if (_this.isI18nComponent(node)) {// no reserved prop names
       } else if (_this.isChoiceComponent(node)) {
@@ -158,6 +164,7 @@ var MacroJSX = /*#__PURE__*/function () {
         id: maybeNodeValue(id),
         message: maybeNodeValue(message),
         comment: maybeNodeValue(comment),
+        context: maybeNodeValue(context),
         attributes: attributes.filter(_this.attrName(reserved, true))
       };
     });
@@ -225,7 +232,7 @@ var MacroJSX = /*#__PURE__*/function () {
     (0, _defineProperty2.default)(this, "tokenizeChoiceComponent", function (node) {
       var element = node.openingElement;
       var format = element.name.name.toLowerCase();
-      var props = element.attributes.filter(_this.attrName([_constants.ID, _constants.COMMENT, _constants.MESSAGE, "key", // we remove <Trans /> react props that are not useful for translation
+      var props = element.attributes.filter(_this.attrName([_constants.ID, _constants.COMMENT, _constants.MESSAGE, _constants.CONTEXT, "key", // we remove <Trans /> react props that are not useful for translation
       "render", "component", "components"], true));
       var token = {
         type: "arg",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingui/macro",
-  "version": "3.12.0",
+  "version": "3.13.2",
   "description": "Macro for generating messages in ICU MessageFormat syntax",
   "main": "index.js",
   "author": {
@@ -30,10 +30,12 @@
   ],
   "dependencies": {
     "@babel/runtime": "^7.11.2",
-    "@lingui/conf": "^3.12.0",
+    "@lingui/conf": "^3.13.2",
     "ramda": "^0.27.1"
   },
   "peerDependencies": {
+    "@lingui/core": "^3.13.0",
+    "@lingui/react": "^3.13.0",
     "babel-plugin-macros": "2 || 3"
   }
 }