@lingui/macro 4.7.0 → 4.8.0-next.0

package/dist/index.cjs

@@ -2,9 +2,23 @@
 
 const babelPluginMacros = require('babel-plugin-macros');
 const conf = require('@lingui/conf');
-const types = require('@babel/types');
+const t = require('@babel/types');
 const generateMessageId = require('@lingui/message-utils/generateMessageId');
 
+function _interopNamespaceCompat(e) {
+  if (e && typeof e === 'object' && 'default' in e) return e;
+  const n = Object.create(null);
+  if (e) {
+    for (const k in e) {
+      n[k] = e[k];
+    }
+  }
+  n.default = e;
+  return n;
+}
+
+const t__namespace = /*#__PURE__*/_interopNamespaceCompat(t);
+
 const metaOptions = ["id", "comment", "props"];
 const escapedMetaOptionsRe = new RegExp(`^_(${metaOptions.join("|")})$`);
 class ICUMessageFormat {
@@ -30,7 +44,7 @@ class ICUMessageFormat {
         message: token.value
       };
     } else if (token.type === "arg") {
-      if (token.value !== void 0 && types.isJSXEmptyExpression(token.value)) {
+      if (token.value !== void 0 && t.isJSXEmptyExpression(token.value)) {
         return null;
       }
       const values = token.value !== void 0 ? { [token.name]: token.value } : {};
@@ -124,6 +138,8 @@ class MacroJs {
     __publicField$1(this, "stripNonEssentialProps");
     __publicField$1(this, "nameMap");
     __publicField$1(this, "nameMapReversed");
+    __publicField$1(this, "needsUseLinguiImport", false);
+    __publicField$1(this, "needsI18nImport", false);
     // Positional expressions counter (e.g. for placeholders `Hello {0}, today is {1}`)
     __publicField$1(this, "_expressionIndex", makeCounter());
     __publicField$1(this, "replacePathWithMessage", (path, tokens, linguiInstance) => {
@@ -166,10 +182,36 @@ class MacroJs {
       }
       if (this.types.isCallExpression(path.node) && this.isLinguiIdentifier(path.node.callee, "t")) {
         this.replaceTAsFunction(path);
+        this.needsI18nImport = true;
         return true;
       }
+      if (path.isTaggedTemplateExpression() && this.isLinguiIdentifier(path.node.tag, "_t")) {
+        this.needsUseLinguiImport = true;
+        const tokens2 = this.tokenizeTemplateLiteral(path.node);
+        const descriptor = this.createMessageDescriptorFromTokens(
+          tokens2,
+          path.node.loc
+        );
+        const callExpr = this.types.callExpression(
+          this.types.isIdentifier(path.node.tag) && path.node.tag,
+          [descriptor]
+        );
+        path.replaceWith(callExpr);
+        return false;
+      }
+      if (path.isCallExpression() && this.isLinguiIdentifier(path.node.callee, "_t") && this.types.isExpression(path.node.arguments[0])) {
+        this.needsUseLinguiImport = true;
+        let descriptor = this.processDescriptor(path.node.arguments[0]);
+        path.node.arguments = [descriptor];
+        return false;
+      }
+      if (this.types.isCallExpression(path.node) && this.isLinguiIdentifier(path.node.callee, "useLingui") && this.types.isVariableDeclarator(path.parentPath.node)) {
+        this.needsUseLinguiImport = true;
+        return false;
+      }
       const tokens = this.tokenizeNode(path.node);
       this.replacePathWithMessage(path, tokens);
+      this.needsI18nImport = true;
       return true;
     });
     /**
@@ -380,7 +422,7 @@ class MacroJs {
   }
   getObjectPropertyByKey(objectExp, key) {
     return objectExp.properties.find(
-      (property) => types.isObjectProperty(property) && this.isLinguiIdentifier(property.key, key)
+      (property) => t.isObjectProperty(property) && this.isLinguiIdentifier(property.key, key)
     );
   }
   /**
@@ -784,6 +826,7 @@ const jsMacroTags = /* @__PURE__ */ new Set([
   "msg",
   "arg",
   "t",
+  "useLingui",
   "plural",
   "select",
   "selectOrdinal"
@@ -801,22 +844,37 @@ function getConfig(_config) {
 }
 function macro({ references, state, babel, config: config2 }) {
   const opts = config2;
+  const body = state.file.path.node.body;
   const {
     i18nImportModule,
     i18nImportName,
     TransImportModule,
-    TransImportName
+    TransImportName,
+    useLinguiImportModule,
+    useLinguiImportName
   } = getConfig(opts.linguiConfig).runtimeConfigModule;
   const jsxNodes = /* @__PURE__ */ new Set();
   const jsNodes = /* @__PURE__ */ new Set();
   let needsI18nImport = false;
+  let needsUseLinguiImport = false;
+  const uniq_tIdentifier = state.file.scope.generateUidIdentifier("_t");
   let nameMap = /* @__PURE__ */ new Map();
   Object.keys(references).forEach((tagName) => {
     const nodes = references[tagName];
     if (jsMacroTags.has(tagName)) {
       nodes.forEach((path) => {
-        nameMap.set(tagName, path.node.name);
-        jsNodes.add(path.parentPath);
+        if (tagName !== "useLingui") {
+          nameMap.set(tagName, path.node.name);
+          jsNodes.add(path.parentPath);
+        } else {
+          needsUseLinguiImport = true;
+          nameMap.set("_t", uniq_tIdentifier.name);
+          processUseLingui(
+            path,
+            useLinguiImportName,
+            uniq_tIdentifier.name
+          )?.forEach((n) => jsNodes.add(n));
+        }
       });
     } else if (jsxMacroTags.has(tagName)) {
       nodes.forEach((path) => {
@@ -836,8 +894,9 @@ function macro({ references, state, babel, config: config2 }) {
       nameMap
     });
     try {
-      if (macro2.replacePath(path))
-        needsI18nImport = true;
+      macro2.replacePath(path);
+      needsI18nImport = needsI18nImport || macro2.needsI18nImport;
+      needsUseLinguiImport = needsUseLinguiImport || macro2.needsUseLinguiImport;
     } catch (e) {
       reportUnsupportedSyntax(path, e);
     }
@@ -851,39 +910,84 @@ function macro({ references, state, babel, config: config2 }) {
       reportUnsupportedSyntax(path, e);
     }
   });
+  if (needsUseLinguiImport) {
+    addImport(babel, body, useLinguiImportModule, useLinguiImportName);
+  }
   if (needsI18nImport) {
-    addImport(babel, state, i18nImportModule, i18nImportName);
+    addImport(babel, body, i18nImportModule, i18nImportName);
   }
   if (jsxNodes.size) {
-    addImport(babel, state, TransImportModule, TransImportName);
+    addImport(babel, body, TransImportModule, TransImportName);
   }
 }
 function reportUnsupportedSyntax(path, e) {
   throw path.buildCodeFrameError(
-    `Unsupported macro usage. Please check the examples at https://lingui.dev/ref/macro#examples-of-js-macros. 
+    `Unsupported macro usage. Please check the examples at https://lingui.dev/ref/macro#examples-of-js-macros.
  If you think this is a bug, fill in an issue at https://github.com/lingui/js-lingui/issues
- 
+
  Error: ${e.message}`
   );
 }
-function addImport(babel, state, module2, importName) {
-  const { types: t } = babel;
-  const linguiImport = state.file.path.node.body.find(
-    (importNode) => t.isImportDeclaration(importNode) && importNode.source.value === module2 && // https://github.com/lingui/js-lingui/issues/777
+function processUseLingui(path, useLinguiName, newIdentifier) {
+  if (!path.parentPath.parentPath.isVariableDeclarator()) {
+    reportUnsupportedSyntax(
+      path,
+      new Error(
+        `\`useLingui\` macro must be used in variable declaration.
+        
+ Example:
+
+ const { t } = useLingui()
+`
+      )
+    );
+    return null;
+  }
+  const varDec = path.parentPath.parentPath.node;
+  const _property = t__namespace.isObjectPattern(varDec.id) ? varDec.id.properties.find(
+    (property) => t__namespace.isObjectProperty(property) && t__namespace.isIdentifier(property.key) && t__namespace.isIdentifier(property.value) && property.key.name == "t"
+  ) : null;
+  if (!_property) {
+    reportUnsupportedSyntax(
+      path.parentPath.parentPath,
+      new Error(
+        `You have to destructure \`t\` when using the \`useLingui\` macro, i.e:
+ const { t } = useLingui()
+ or
+ const { t: _ } = useLingui()
+ `
+      )
+    );
+    return null;
+  }
+  if (t__namespace.isIdentifier(path.node)) {
+    path.scope.rename(path.node.name, useLinguiName);
+  }
+  _property.key.name = "_";
+  path.scope.rename(_property.value.name, newIdentifier);
+  return path.scope.getBinding(_property.value.name)?.referencePaths.filter(
+    // dont process array expression to allow use in dependency arrays
+    (path2) => !path2.parentPath.isArrayExpression()
+  ).map((path2) => path2.parentPath);
+}
+function addImport(babel, body, module2, importName) {
+  const { types: t2 } = babel;
+  const linguiImport = body.find(
+    (importNode) => t2.isImportDeclaration(importNode) && importNode.source.value === module2 && // https://github.com/lingui/js-lingui/issues/777
     importNode.importKind !== "type"
   );
-  const tIdentifier = t.identifier(importName);
+  const tIdentifier = t2.identifier(importName);
   if (linguiImport) {
-    if (linguiImport.specifiers.findIndex(
-      (specifier) => types.isImportSpecifier(specifier) && types.isIdentifier(specifier.imported, { name: importName })
-    ) === -1) {
-      linguiImport.specifiers.push(t.importSpecifier(tIdentifier, tIdentifier));
+    if (!linguiImport.specifiers.find(
+      (specifier) => t2.isImportSpecifier(specifier) && t2.isIdentifier(specifier.imported, { name: importName })
+    )) {
+      linguiImport.specifiers.push(t2.importSpecifier(tIdentifier, tIdentifier));
     }
   } else {
-    state.file.path.node.body.unshift(
-      t.importDeclaration(
-        [t.importSpecifier(tIdentifier, tIdentifier)],
-        t.stringLiteral(module2)
+    body.unshift(
+      t2.importDeclaration(
+        [t2.importSpecifier(tIdentifier, tIdentifier)],
+        t2.stringLiteral(module2)
       )
     );
   }

package/dist/index.mjs

@@ -1,6 +1,7 @@
 import { createMacro } from 'babel-plugin-macros';
 import { getConfig as getConfig$1 } from '@lingui/conf';
-import { isJSXEmptyExpression, isObjectProperty, isImportSpecifier, isIdentifier } from '@babel/types';
+import * as t from '@babel/types';
+import { isJSXEmptyExpression, isObjectProperty } from '@babel/types';
 import { generateMessageId } from '@lingui/message-utils/generateMessageId';
 
 const metaOptions = ["id", "comment", "props"];
@@ -122,6 +123,8 @@ class MacroJs {
     __publicField$1(this, "stripNonEssentialProps");
     __publicField$1(this, "nameMap");
     __publicField$1(this, "nameMapReversed");
+    __publicField$1(this, "needsUseLinguiImport", false);
+    __publicField$1(this, "needsI18nImport", false);
     // Positional expressions counter (e.g. for placeholders `Hello {0}, today is {1}`)
     __publicField$1(this, "_expressionIndex", makeCounter());
     __publicField$1(this, "replacePathWithMessage", (path, tokens, linguiInstance) => {
@@ -164,10 +167,36 @@ class MacroJs {
       }
       if (this.types.isCallExpression(path.node) && this.isLinguiIdentifier(path.node.callee, "t")) {
         this.replaceTAsFunction(path);
+        this.needsI18nImport = true;
         return true;
       }
+      if (path.isTaggedTemplateExpression() && this.isLinguiIdentifier(path.node.tag, "_t")) {
+        this.needsUseLinguiImport = true;
+        const tokens2 = this.tokenizeTemplateLiteral(path.node);
+        const descriptor = this.createMessageDescriptorFromTokens(
+          tokens2,
+          path.node.loc
+        );
+        const callExpr = this.types.callExpression(
+          this.types.isIdentifier(path.node.tag) && path.node.tag,
+          [descriptor]
+        );
+        path.replaceWith(callExpr);
+        return false;
+      }
+      if (path.isCallExpression() && this.isLinguiIdentifier(path.node.callee, "_t") && this.types.isExpression(path.node.arguments[0])) {
+        this.needsUseLinguiImport = true;
+        let descriptor = this.processDescriptor(path.node.arguments[0]);
+        path.node.arguments = [descriptor];
+        return false;
+      }
+      if (this.types.isCallExpression(path.node) && this.isLinguiIdentifier(path.node.callee, "useLingui") && this.types.isVariableDeclarator(path.parentPath.node)) {
+        this.needsUseLinguiImport = true;
+        return false;
+      }
       const tokens = this.tokenizeNode(path.node);
       this.replacePathWithMessage(path, tokens);
+      this.needsI18nImport = true;
       return true;
     });
     /**
@@ -782,6 +811,7 @@ const jsMacroTags = /* @__PURE__ */ new Set([
   "msg",
   "arg",
   "t",
+  "useLingui",
   "plural",
   "select",
   "selectOrdinal"
@@ -799,22 +829,37 @@ function getConfig(_config) {
 }
 function macro({ references, state, babel, config: config2 }) {
   const opts = config2;
+  const body = state.file.path.node.body;
   const {
     i18nImportModule,
     i18nImportName,
     TransImportModule,
-    TransImportName
+    TransImportName,
+    useLinguiImportModule,
+    useLinguiImportName
   } = getConfig(opts.linguiConfig).runtimeConfigModule;
   const jsxNodes = /* @__PURE__ */ new Set();
   const jsNodes = /* @__PURE__ */ new Set();
   let needsI18nImport = false;
+  let needsUseLinguiImport = false;
+  const uniq_tIdentifier = state.file.scope.generateUidIdentifier("_t");
   let nameMap = /* @__PURE__ */ new Map();
   Object.keys(references).forEach((tagName) => {
     const nodes = references[tagName];
     if (jsMacroTags.has(tagName)) {
       nodes.forEach((path) => {
-        nameMap.set(tagName, path.node.name);
-        jsNodes.add(path.parentPath);
+        if (tagName !== "useLingui") {
+          nameMap.set(tagName, path.node.name);
+          jsNodes.add(path.parentPath);
+        } else {
+          needsUseLinguiImport = true;
+          nameMap.set("_t", uniq_tIdentifier.name);
+          processUseLingui(
+            path,
+            useLinguiImportName,
+            uniq_tIdentifier.name
+          )?.forEach((n) => jsNodes.add(n));
+        }
       });
     } else if (jsxMacroTags.has(tagName)) {
       nodes.forEach((path) => {
@@ -834,8 +879,9 @@ function macro({ references, state, babel, config: config2 }) {
       nameMap
     });
     try {
-      if (macro2.replacePath(path))
-        needsI18nImport = true;
+      macro2.replacePath(path);
+      needsI18nImport = needsI18nImport || macro2.needsI18nImport;
+      needsUseLinguiImport = needsUseLinguiImport || macro2.needsUseLinguiImport;
     } catch (e) {
       reportUnsupportedSyntax(path, e);
     }
@@ -849,39 +895,84 @@ function macro({ references, state, babel, config: config2 }) {
       reportUnsupportedSyntax(path, e);
     }
   });
+  if (needsUseLinguiImport) {
+    addImport(babel, body, useLinguiImportModule, useLinguiImportName);
+  }
   if (needsI18nImport) {
-    addImport(babel, state, i18nImportModule, i18nImportName);
+    addImport(babel, body, i18nImportModule, i18nImportName);
   }
   if (jsxNodes.size) {
-    addImport(babel, state, TransImportModule, TransImportName);
+    addImport(babel, body, TransImportModule, TransImportName);
   }
 }
 function reportUnsupportedSyntax(path, e) {
   throw path.buildCodeFrameError(
-    `Unsupported macro usage. Please check the examples at https://lingui.dev/ref/macro#examples-of-js-macros. 
+    `Unsupported macro usage. Please check the examples at https://lingui.dev/ref/macro#examples-of-js-macros.
  If you think this is a bug, fill in an issue at https://github.com/lingui/js-lingui/issues
- 
+
  Error: ${e.message}`
   );
 }
-function addImport(babel, state, module2, importName) {
-  const { types: t } = babel;
-  const linguiImport = state.file.path.node.body.find(
-    (importNode) => t.isImportDeclaration(importNode) && importNode.source.value === module2 && // https://github.com/lingui/js-lingui/issues/777
+function processUseLingui(path, useLinguiName, newIdentifier) {
+  if (!path.parentPath.parentPath.isVariableDeclarator()) {
+    reportUnsupportedSyntax(
+      path,
+      new Error(
+        `\`useLingui\` macro must be used in variable declaration.
+        
+ Example:
+
+ const { t } = useLingui()
+`
+      )
+    );
+    return null;
+  }
+  const varDec = path.parentPath.parentPath.node;
+  const _property = t.isObjectPattern(varDec.id) ? varDec.id.properties.find(
+    (property) => t.isObjectProperty(property) && t.isIdentifier(property.key) && t.isIdentifier(property.value) && property.key.name == "t"
+  ) : null;
+  if (!_property) {
+    reportUnsupportedSyntax(
+      path.parentPath.parentPath,
+      new Error(
+        `You have to destructure \`t\` when using the \`useLingui\` macro, i.e:
+ const { t } = useLingui()
+ or
+ const { t: _ } = useLingui()
+ `
+      )
+    );
+    return null;
+  }
+  if (t.isIdentifier(path.node)) {
+    path.scope.rename(path.node.name, useLinguiName);
+  }
+  _property.key.name = "_";
+  path.scope.rename(_property.value.name, newIdentifier);
+  return path.scope.getBinding(_property.value.name)?.referencePaths.filter(
+    // dont process array expression to allow use in dependency arrays
+    (path2) => !path2.parentPath.isArrayExpression()
+  ).map((path2) => path2.parentPath);
+}
+function addImport(babel, body, module2, importName) {
+  const { types: t2 } = babel;
+  const linguiImport = body.find(
+    (importNode) => t2.isImportDeclaration(importNode) && importNode.source.value === module2 && // https://github.com/lingui/js-lingui/issues/777
     importNode.importKind !== "type"
   );
-  const tIdentifier = t.identifier(importName);
+  const tIdentifier = t2.identifier(importName);
   if (linguiImport) {
-    if (linguiImport.specifiers.findIndex(
-      (specifier) => isImportSpecifier(specifier) && isIdentifier(specifier.imported, { name: importName })
-    ) === -1) {
-      linguiImport.specifiers.push(t.importSpecifier(tIdentifier, tIdentifier));
+    if (!linguiImport.specifiers.find(
+      (specifier) => t2.isImportSpecifier(specifier) && t2.isIdentifier(specifier.imported, { name: importName })
+    )) {
+      linguiImport.specifiers.push(t2.importSpecifier(tIdentifier, tIdentifier));
     }
   } else {
-    state.file.path.node.body.unshift(
-      t.importDeclaration(
-        [t.importSpecifier(tIdentifier, tIdentifier)],
-        t.stringLiteral(module2)
+    body.unshift(
+      t2.importDeclaration(
+        [t2.importSpecifier(tIdentifier, tIdentifier)],
+        t2.stringLiteral(module2)
       )
     );
   }

package/index.d.ts

@@ -1,7 +1,7 @@
 // eslint-disable-next-line import/no-extraneous-dependencies
 import type { ReactNode, VFC, FC } from "react"
 import type { I18n, MessageDescriptor } from "@lingui/core"
-import type { TransRenderCallbackOrComponent } from "@lingui/react"
+import type { TransRenderCallbackOrComponent, I18nContext } from "@lingui/react"
 
 export type ChoiceOptions = {
   /** Offset of value when calculating plural forms */
@@ -316,3 +316,36 @@ export const SelectOrdinal: VFC<PluralChoiceProps>
  * ```
  */
 export const Select: VFC<SelectChoiceProps>
+
+export function _t(descriptor: MacroMessageDescriptor): string
+export function _t(
+  literals: TemplateStringsArray,
+  ...placeholders: any[]
+): string
+
+/**
+ *
+ * Macro version of useLingui replaces _ function with `t` macro function which is bound to i18n passed from React.Context
+ *
+ * Returned `t` macro function has all the same signatures as global `t`
+ *
+ * @example
+ * ```
+ * const { t } = useLingui();
+ * const message = t`Text`;
+ * ```
+ *
+ * @example
+ * ```
+ * const { i18n, t } = useLingui();
+ * const locale = i18n.locale;
+ * const message = t({
+ *   id: "msg.hello",
+ *   comment: "Greetings at the homepage",
+ *   message: `Hello ${name}`,
+ * });
+ * ```
+ */
+export function useLingui(): Omit<I18nContext, "_"> & {
+  t: typeof _t
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingui/macro",
-  "version": "4.7.0",
+  "version": "4.8.0-next.0",
   "description": "Macro for generating messages in ICU MessageFormat syntax",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -65,9 +65,9 @@
   "dependencies": {
     "@babel/runtime": "^7.20.13",
     "@babel/types": "^7.20.7",
-    "@lingui/conf": "4.7.0",
-    "@lingui/core": "4.7.0",
-    "@lingui/message-utils": "4.7.0"
+    "@lingui/conf": "^4.8.0-next.0",
+    "@lingui/core": "^4.8.0-next.0",
+    "@lingui/message-utils": "^4.8.0-next.0"
   },
   "peerDependencies": {
     "@lingui/react": "^4.0.0",
@@ -82,5 +82,5 @@
     "tsd": "^0.26.1",
     "unbuild": "2.0.0"
   },
-  "gitHead": "ebb6353aef59d1b1a29a10ba6ffe94eb42c51a77"
+  "gitHead": "d085ac65d66ce6c2f866b703b6346e53ff0bf6b3"
 }