@lingui/babel-plugin-extract-messages 4.0.0-next.3 → 4.0.0-next.4

package/{build/index.js → dist/index.cjs}

@@ -1,12 +1,8 @@
-"use strict";
+'use strict';
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = _default;
 function collectMessage(path, props, ctx) {
-  // prevent from adding undefined msgid
-  if (props.id === undefined) return;
+  if (props.id === void 0)
+    return;
   const node = path.node;
   const line = node.loc ? node.loc.start.line : null;
   const column = node.loc ? node.loc.start.column : null;
@@ -23,48 +19,61 @@ function getTextFromExpression(t, exp, hub, emitErrorOnVariable = true) {
     return exp.value;
   }
   if (t.isBinaryExpression(exp)) {
-    return getTextFromExpression(t, exp.left, hub, emitErrorOnVariable) + getTextFromExpression(t, exp.right, hub, emitErrorOnVariable);
+    return getTextFromExpression(
+      t,
+      exp.left,
+      hub,
+      emitErrorOnVariable
+    ) + getTextFromExpression(
+      t,
+      exp.right,
+      hub,
+      emitErrorOnVariable
+    );
   }
   if (t.isTemplateLiteral(exp)) {
-    var _exp$quasis$, _exp$quasis$$value;
-    if ((exp === null || exp === void 0 ? void 0 : exp.quasis.length) > 1) {
-      console.warn(hub.buildError(exp, "Could not extract from template literal with expressions.", SyntaxError).message);
+    if (exp?.quasis.length > 1) {
+      console.warn(
+        hub.buildError(
+          exp,
+          "Could not extract from template literal with expressions.",
+          SyntaxError
+        ).message
+      );
       return "";
     }
-    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;
+    return exp.quasis[0]?.value?.cooked;
   }
   if (emitErrorOnVariable) {
-    console.warn(hub.buildError(exp, "Only strings or template literals could be extracted.", SyntaxError).message);
+    console.warn(
+      hub.buildError(
+        exp,
+        "Only strings or template literals could be extracted.",
+        SyntaxError
+      ).message
+    );
   }
 }
 function extractFromObjectExpression(t, exp, hub, keys) {
   const props = {};
-  exp.properties.forEach(({
-    key,
-    value
-  }, i) => {
+  exp.properties.forEach(({ key, value }, i) => {
     const name = key.name;
-    if (!keys.includes(name)) return;
+    if (!keys.includes(name))
+      return;
     props[name] = getTextFromExpression(t, value, hub);
   });
   return props;
 }
-function _default({
-  types: t
-}) {
+function index({ types: t }) {
   let localTransComponentName;
   function isTransComponent(node) {
     return t.isJSXElement(node) && t.isJSXIdentifier(node.openingElement.name, {
       name: localTransComponentName
     });
   }
-  const isI18nMethod = node => t.isMemberExpression(node) && t.isIdentifier(node.object, {
-    name: "i18n"
-  }) && t.isIdentifier(node.property, {
-    name: "_"
-  });
+  const isI18nMethod = (node) => t.isMemberExpression(node) && t.isIdentifier(node.object, { name: "i18n" }) && t.isIdentifier(node.property, { name: "_" });
   function hasI18nComment(node) {
-    return node.leadingComments && node.leadingComments.some(comm => comm.value.match(/^\s*i18n/));
+    return node.leadingComments && node.leadingComments.some((comm) => comm.value.match(/^\s*i18n/));
   }
   return {
     visitor: {
@@ -72,29 +81,24 @@ function _default({
       // it might be different when the import is aliased:
       // import { Trans as T } from '@lingui/react';
       ImportDeclaration(path) {
-        const {
-          node
-        } = path;
+        const { node } = path;
         const moduleName = node.source.value;
-        if (!["@lingui/react", "@lingui/core"].includes(moduleName)) return;
+        if (!["@lingui/react", "@lingui/core"].includes(moduleName))
+          return;
         const importDeclarations = {};
         if (moduleName === "@lingui/react") {
-          node.specifiers.forEach(specifier => {
+          node.specifiers.forEach((specifier) => {
             specifier = specifier;
             importDeclarations[specifier.imported.name] = specifier.local.name;
           });
-
-          // Trans import might be missing if there's just Plural or similar macro.
-          // If there's no alias, consider it was imported as Trans.
           localTransComponentName = importDeclarations["Trans"] || "Trans";
         }
       },
       // Extract translation from <Trans /> component.
       JSXElement(path, ctx) {
-        const {
-          node
-        } = path;
-        if (!localTransComponentName || !isTransComponent(node)) return;
+        const { node } = path;
+        if (!localTransComponentName || !isTransComponent(node))
+          return;
         const attrs = node.openingElement.attributes || [];
         const props = attrs.reduce((acc, item) => {
           const key = item.name.name;
@@ -108,27 +112,31 @@ function _default({
           return acc;
         }, {});
         if (!props.id) {
-          // <Trans id={message} /> is valid, don't raise warning
-          const idProp = attrs.filter(item => item.name.name === "id")[0];
-          if (idProp === undefined || t.isLiteral(props.id)) {
-            console.warn(path.buildCodeFrameError("Missing message ID, skipping.").message);
+          const idProp = attrs.filter((item) => item.name.name === "id")[0];
+          if (idProp === void 0 || t.isLiteral(props.id)) {
+            console.warn(
+              path.buildCodeFrameError("Missing message ID, skipping.").message
+            );
           }
           return;
         }
         collectMessage(path, props, ctx);
       },
       CallExpression(path, ctx) {
-        const hasComment = [path.node, path.parent].some(node => hasI18nComment(node));
+        const hasComment = [path.node, path.parent].some(
+          (node) => hasI18nComment(node)
+        );
         const firstArgument = path.node.arguments[0];
-
-        // support `i18n._` calls written by users in form i18n._(id, variables, descriptor)
-        // without explicit annotation with comment
-        // calls generated by macro has a form i18n._(/*i18n*/ {descriptor}) and
-        // processed by ObjectExpression visitor
-        const isNonMacroI18n = isI18nMethod(path.node.callee) && !(firstArgument !== null && firstArgument !== void 0 && firstArgument.leadingComments);
-        if (!hasComment && !isNonMacroI18n) return;
+        const isNonMacroI18n = isI18nMethod(path.node.callee) && !firstArgument?.leadingComments;
+        if (!hasComment && !isNonMacroI18n)
+          return;
         let props = {
-          id: getTextFromExpression(t, firstArgument, ctx.file.hub, false)
+          id: getTextFromExpression(
+            t,
+            firstArgument,
+            ctx.file.hub,
+            false
+          )
         };
         if (!props.id) {
           return;
@@ -137,7 +145,11 @@ function _default({
         if (t.isObjectExpression(msgDescArg)) {
           props = {
             ...props,
-            ...extractFromObjectExpression(t, msgDescArg, ctx.file.hub, ["message", "comment", "context"])
+            ...extractFromObjectExpression(t, msgDescArg, ctx.file.hub, [
+              "message",
+              "comment",
+              "context"
+            ])
           };
         }
         collectMessage(path, props, ctx);
@@ -150,7 +162,9 @@ function _default({
           id: path.node.value
         };
         if (!props.id) {
-          console.warn(path.buildCodeFrameError("Empty StringLiteral, skipping.").message);
+          console.warn(
+            path.buildCodeFrameError("Empty StringLiteral, skipping.").message
+          );
           return;
         }
         collectMessage(path, props, ctx);
@@ -160,13 +174,22 @@ function _default({
         if (!hasI18nComment(path.node)) {
           return;
         }
-        const props = extractFromObjectExpression(t, path.node, ctx.file.hub, ["id", "message", "comment", "context"]);
+        const props = extractFromObjectExpression(t, path.node, ctx.file.hub, [
+          "id",
+          "message",
+          "comment",
+          "context"
+        ]);
         if (!props.id) {
-          console.warn(path.buildCodeFrameError("Missing message ID, skipping.").message);
+          console.warn(
+            path.buildCodeFrameError("Missing message ID, skipping.").message
+          );
           return;
         }
         collectMessage(path, props, ctx);
       }
     }
   };
-}
+}
+
+module.exports = index;

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+import * as BabelTypesNamespace from '@babel/types';
+import { PluginObj } from '@babel/core';
+
+type BabelTypes = typeof BabelTypesNamespace;
+type ExtractedMessage = {
+    id: string;
+    message?: string;
+    context?: string;
+    origin?: Origin;
+    comment?: string;
+};
+type ExtractPluginOpts = {
+    onMessageExtracted(msg: ExtractedMessage): void;
+};
+type Origin = [filename: string, line: number, column?: number];
+declare function export_default({ types: t }: {
+    types: BabelTypes;
+}): PluginObj;
+
+export { ExtractPluginOpts, ExtractedMessage, Origin, export_default as default };

package/dist/index.mjs

@@ -0,0 +1,193 @@
+function collectMessage(path, props, ctx) {
+  if (props.id === void 0)
+    return;
+  const node = path.node;
+  const line = node.loc ? node.loc.start.line : null;
+  const column = node.loc ? node.loc.start.column : null;
+  ctx.opts.onMessageExtracted({
+    id: props.id,
+    message: props.message,
+    context: props.context,
+    comment: props.comment,
+    origin: [ctx.file.opts.filename, line, column]
+  });
+}
+function getTextFromExpression(t, exp, hub, emitErrorOnVariable = true) {
+  if (t.isStringLiteral(exp)) {
+    return exp.value;
+  }
+  if (t.isBinaryExpression(exp)) {
+    return getTextFromExpression(
+      t,
+      exp.left,
+      hub,
+      emitErrorOnVariable
+    ) + getTextFromExpression(
+      t,
+      exp.right,
+      hub,
+      emitErrorOnVariable
+    );
+  }
+  if (t.isTemplateLiteral(exp)) {
+    if (exp?.quasis.length > 1) {
+      console.warn(
+        hub.buildError(
+          exp,
+          "Could not extract from template literal with expressions.",
+          SyntaxError
+        ).message
+      );
+      return "";
+    }
+    return exp.quasis[0]?.value?.cooked;
+  }
+  if (emitErrorOnVariable) {
+    console.warn(
+      hub.buildError(
+        exp,
+        "Only strings or template literals could be extracted.",
+        SyntaxError
+      ).message
+    );
+  }
+}
+function extractFromObjectExpression(t, exp, hub, keys) {
+  const props = {};
+  exp.properties.forEach(({ key, value }, i) => {
+    const name = key.name;
+    if (!keys.includes(name))
+      return;
+    props[name] = getTextFromExpression(t, value, hub);
+  });
+  return props;
+}
+function index({ types: t }) {
+  let localTransComponentName;
+  function isTransComponent(node) {
+    return t.isJSXElement(node) && t.isJSXIdentifier(node.openingElement.name, {
+      name: localTransComponentName
+    });
+  }
+  const isI18nMethod = (node) => t.isMemberExpression(node) && t.isIdentifier(node.object, { name: "i18n" }) && t.isIdentifier(node.property, { name: "_" });
+  function hasI18nComment(node) {
+    return node.leadingComments && node.leadingComments.some((comm) => comm.value.match(/^\s*i18n/));
+  }
+  return {
+    visitor: {
+      // Get the local name of Trans component. Usually it's just `Trans`, but
+      // it might be different when the import is aliased:
+      // import { Trans as T } from '@lingui/react';
+      ImportDeclaration(path) {
+        const { node } = path;
+        const moduleName = node.source.value;
+        if (!["@lingui/react", "@lingui/core"].includes(moduleName))
+          return;
+        const importDeclarations = {};
+        if (moduleName === "@lingui/react") {
+          node.specifiers.forEach((specifier) => {
+            specifier = specifier;
+            importDeclarations[specifier.imported.name] = specifier.local.name;
+          });
+          localTransComponentName = importDeclarations["Trans"] || "Trans";
+        }
+      },
+      // Extract translation from <Trans /> component.
+      JSXElement(path, ctx) {
+        const { node } = path;
+        if (!localTransComponentName || !isTransComponent(node))
+          return;
+        const attrs = node.openingElement.attributes || [];
+        const props = attrs.reduce((acc, item) => {
+          const key = item.name.name;
+          if (key === "id" || key === "message" || key === "comment" || key === "context") {
+            if (t.isStringLiteral(item.value)) {
+              acc[key] = item.value.value;
+            } else if (t.isJSXExpressionContainer(item.value) && t.isStringLiteral(item.value.expression)) {
+              acc[key] = item.value.expression.value;
+            }
+          }
+          return acc;
+        }, {});
+        if (!props.id) {
+          const idProp = attrs.filter((item) => item.name.name === "id")[0];
+          if (idProp === void 0 || t.isLiteral(props.id)) {
+            console.warn(
+              path.buildCodeFrameError("Missing message ID, skipping.").message
+            );
+          }
+          return;
+        }
+        collectMessage(path, props, ctx);
+      },
+      CallExpression(path, ctx) {
+        const hasComment = [path.node, path.parent].some(
+          (node) => hasI18nComment(node)
+        );
+        const firstArgument = path.node.arguments[0];
+        const isNonMacroI18n = isI18nMethod(path.node.callee) && !firstArgument?.leadingComments;
+        if (!hasComment && !isNonMacroI18n)
+          return;
+        let props = {
+          id: getTextFromExpression(
+            t,
+            firstArgument,
+            ctx.file.hub,
+            false
+          )
+        };
+        if (!props.id) {
+          return;
+        }
+        const msgDescArg = path.node.arguments[2];
+        if (t.isObjectExpression(msgDescArg)) {
+          props = {
+            ...props,
+            ...extractFromObjectExpression(t, msgDescArg, ctx.file.hub, [
+              "message",
+              "comment",
+              "context"
+            ])
+          };
+        }
+        collectMessage(path, props, ctx);
+      },
+      StringLiteral(path, ctx) {
+        if (!hasI18nComment(path.node)) {
+          return;
+        }
+        const props = {
+          id: path.node.value
+        };
+        if (!props.id) {
+          console.warn(
+            path.buildCodeFrameError("Empty StringLiteral, skipping.").message
+          );
+          return;
+        }
+        collectMessage(path, props, ctx);
+      },
+      // Extract message descriptors
+      ObjectExpression(path, ctx) {
+        if (!hasI18nComment(path.node)) {
+          return;
+        }
+        const props = extractFromObjectExpression(t, path.node, ctx.file.hub, [
+          "id",
+          "message",
+          "comment",
+          "context"
+        ]);
+        if (!props.id) {
+          console.warn(
+            path.buildCodeFrameError("Missing message ID, skipping.").message
+          );
+          return;
+        }
+        collectMessage(path, props, ctx);
+      }
+    }
+  };
+}
+
+export { index as default };

package/package.json

@@ -1,8 +1,10 @@
 {
   "name": "@lingui/babel-plugin-extract-messages",
-  "version": "4.0.0-next.3",
+  "version": "4.0.0-next.4",
   "description": "Babel plugin for collecting messages from source code for internationalization",
-  "main": "./build/index.js",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "author": {
     "name": "Tomáš Ehrlich",
     "email": "tomas.ehrlich@gmail.com"
@@ -17,10 +19,14 @@
     "i9n",
     "translation"
   ],
+  "scripts": {
+    "build": "rimraf ./dist && unbuild",
+    "stub": "unbuild --stub"
+  },
   "files": [
     "LICENSE",
     "README.md",
-    "build/"
+    "dist/"
   ],
   "repository": {
     "type": "git",
@@ -32,14 +38,12 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "dependencies": {
-    "@babel/runtime": "^7.20.13"
-  },
   "devDependencies": {
     "@babel/core": "^7.21.0",
     "@babel/traverse": "7.20.12",
     "@babel/types": "^7.20.7",
-    "@lingui/jest-mocks": "^3.0.3"
+    "@lingui/jest-mocks": "^3.0.3",
+    "unbuild": "^1.1.2"
   },
-  "gitHead": "29cad1bdcc781994ac4d496e5c4937795423d405"
+  "gitHead": "3b999e35d26e67dec7cf0591f794be782e11022c"
 }

package/build/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017-2022 Tomáš Ehrlich, (c) 2022-2023 Crowdin.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.