refactor(macro): macro to plugin

packages/babel-plugin-extract-messages/package.json

@@ -44,6 +44,7 @@
  "@babel/traverse": "7.20.12",
  "@babel/types": "^7.20.7",
  "@lingui/jest-mocks": "*",
+ "@lingui/macro": "*",
  "unbuild": "2.0.0"
  }
 }

packages/babel-plugin-extract-messages/src/index.ts

@@ -2,14 +2,12 @@ import type * as BabelTypesNamespace from "@babel/types"
 import {
  Expression,
  Identifier,
- ImportSpecifier,
  JSXAttribute,
  Node,
  ObjectExpression,
  ObjectProperty,
 } from "@babel/types"
-import type { PluginObj, PluginPass } from "@babel/core"
-import type { NodePath } from "@babel/core"
+import type { PluginObj, PluginPass, NodePath } from "@babel/core"
 import type { Hub } from "@babel/traverse"
 
 type BabelTypes = typeof BabelTypesNamespace
@@ -148,14 +146,13 @@ function hasI18nComment(node: Node): boolean {
 }
 
 export default function ({ types: t }: { types: BabelTypes }): PluginObj {
- let localTransComponentName: string
-
- function isTransComponent(node: Node) {
+ function isTransComponent(path: NodePath) {
  return (
- t.isJSXElement(node) &&
- t.isJSXIdentifier(node.openingElement.name, {
- name: localTransComponentName,
- })
+ path.isJSXElement() &&
+ path
+ .get("openingElement")
+ .get("name")
+ .referencesImport("@lingui/react", "Trans")
  )
  }
 
@@ -190,33 +187,10 @@ export default function ({ types: t }: { types: BabelTypes }): PluginObj {
 
  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: Record<string, string> = {}
- if (moduleName === "@lingui/react") {
- node.specifiers.forEach((specifier) => {
- specifier = specifier as ImportSpecifier
- importDeclarations[(specifier.imported as Identifier).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
+ if (!isTransComponent(path)) return
 
  const attrs = (node.openingElement.attributes as JSXAttribute[]) || []
 

packages/babel-plugin-extract-messages/test/fixtures/js-with-macros.js

@@ -1,4 +1,4 @@
-import { t, defineMessage, msg, useLingui } from "@lingui/macro"
+import { t, defineMessage, msg, useLingui, plural } from "@lingui/macro"
 
 t`Message`
 

packages/babel-plugin-extract-messages/test/index.ts

@@ -3,6 +3,7 @@ import fs from "fs"
 import { transform as babelTransform } from "@babel/core"
 import plugin, { ExtractedMessage, ExtractPluginOpts } from "../src/index"
 import { mockConsole } from "@lingui/jest-mocks"
+import linguiMacroPlugin, { type LinguiPluginOpts } from "@lingui/macro/plugin"
 
 const transform = (filename: string) => {
  const rootDir = path.join(__dirname, "fixtures")
@@ -42,15 +43,10 @@ const transformCode = (
  plugins: [
  "@babel/plugin-syntax-jsx",
  [
- "macros",
+ linguiMacroPlugin,
  {
- lingui: { extract: true },
- // macro plugin uses package `resolve` to find a path of macro file
- // this will not follow jest pathMapping and will resolve path from ./build
- // instead of ./src which makes testing & developing hard.
- // here we override resolve and provide correct path for testing
- resolvePath: (source: string) => require.resolve(source),
- },
+ extract: true,
+ } satisfies LinguiPluginOpts,
  ],
  [plugin, pluginOpts],
  ],

packages/cli/package.json

@@ -57,6 +57,7 @@
  "@lingui/conf": "4.8.0-next.0",
  "@lingui/core": "4.8.0-next.0",
  "@lingui/format-po": "4.8.0-next.0",
+ "@lingui/macro": "4.8.0-next.0",
  "@lingui/message-utils": "4.8.0-next.0",
  "babel-plugin-macros": "^3.0.1",
  "chalk": "^4.1.0",
@@ -80,7 +81,6 @@
  },
  "devDependencies": {
  "@lingui/jest-mocks": "*",
- "@lingui/macro": "4.8.0-next.0",
  "@types/convert-source-map": "^2.0.0",
  "@types/glob": "^8.1.0",
  "@types/micromatch": "^4.0.1",

packages/cli/src/api/extractors/babel.ts

@@ -9,7 +9,8 @@ import linguiExtractMessages from "@lingui/babel-plugin-extract-messages"
 import type { ExtractorType } from "@lingui/conf"
 import { ParserPlugin } from "@babel/parser"
 
-import { LinguiMacroOpts } from "@lingui/macro/node"
+import { type LinguiPluginOpts } from "@lingui/macro/plugin"
+import linguiMacroPlugin from "@lingui/macro/plugin"
 import { ExtractedMessage, ExtractorCtx } from "@lingui/conf"
 
 const babelRe = new RegExp(
@@ -120,18 +121,11 @@ export async function extractFromFileWithBabel(
 
  plugins: [
  [
- "macros",
+ linguiMacroPlugin,
  {
- // macro plugin uses package `resolve` to find a path of macro file
- // this will not follow jest pathMapping and will resolve path from ./build
- // instead of ./src which makes testing & developing hard.
- // here we override resolve and provide correct path for testing
- resolvePath: (source: string) => require.resolve(source),
- lingui: {
- extract: true,
- linguiConfig: ctx.linguiConfig,
- } satisfies LinguiMacroOpts,
- },
+ extract: true,
+ linguiConfig: ctx.linguiConfig,
+ } satisfies LinguiPluginOpts,
  ],
  [
  linguiExtractMessages,

packages/cli/test/extractor-experimental-1797/expected/locales/_app.page/en.po

@@ -0,0 +1,8 @@
+msgid ""
+msgstr ""
+"POT-Creation-Date: 2023-03-15 10:00+0000\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: @lingui/cli\n"
+"Language: en\n"

packages/cli/test/extractor-experimental-1797/expected/locales/_app.page/pl.po

@@ -0,0 +1,8 @@
+msgid ""
+msgstr ""
+"POT-Creation-Date: 2023-03-15 10:00+0000\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: @lingui/cli\n"
+"Language: pl\n"

packages/cli/test/extractor-experimental-1797/expected/locales/index.page/en.po

@@ -0,0 +1,67 @@
+msgid ""
+msgstr ""
+"POT-Creation-Date: 2023-03-15 10:00+0000\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: @lingui/cli\n"
+"Language: en\n"
+
+#: fixtures/pages/index.page.tsx:83
+#: fixtures/pages/index.page.tsx:85
+msgid "{0, plural, one {# Person} other {# Persons}}"
+msgstr "{0, plural, one {# Person} other {# Persons}}"
+
+#: fixtures/components/Developers.tsx:20
+msgid "{selected, plural, one {Developer} other {Developers}}"
+msgstr "{selected, plural, one {Developer} other {Developers}}"
+
+#: fixtures/pages/index.page.tsx:62
+msgid "<0>Next.js</0>say hi."
+msgstr "<0>Next.js</0>say hi."
+
+#: fixtures/components/Switcher.tsx:10
+msgid "English"
+msgstr "English"
+
+#: fixtures/components/AboutText.tsx:6
+msgid "Hello, world"
+msgstr "Hello, world"
+
+#. js-lingui-explicit-id
+#: fixtures/components/AboutText.tsx:8
+msgid "message.next-explanation"
+msgstr "Next.js is an open-source React front-end development web framework that enables functionality such as server-side rendering and generating static websites for React based web applications. It is a production-ready framework that allows developers to quickly create static and dynamic JAMstack websites and is used widely by many large companies."
+
+#: fixtures/pages/index.page.tsx:58
+#: fixtures/pages/index.page.tsx:60
+msgid "Plain text"
+msgstr "Plain text"
+
+#: fixtures/components/Developers.tsx:9
+msgid "Plural Test: How many developers?"
+msgstr "Plural Test: How many developers?"
+
+#: fixtures/components/Switcher.tsx:11
+msgid "Serbian"
+msgstr "Serbian"
+
+#: fixtures/components/Switcher.tsx:12
+msgid "Spanish"
+msgstr "Spanish"
+
+#: fixtures/pages/index.page.tsx:46
+msgid "Translation Demo"
+msgstr "Translation Demo"
+
+#: fixtures/pages/index.page.tsx:53
+msgid "Welcome to <0>Next.js!</0>"
+msgstr "Welcome to <0>Next.js!</0>"
+
+#: fixtures/pages/index.page.tsx:67
+msgid "Wonderful framework <0>Next.js</0>say hi."
+msgstr "Wonderful framework <0>Next.js</0>say hi."
+
+#: fixtures/pages/index.page.tsx:72
+msgid "Wonderful framework <0>Next.js</0>say hi. And <1>Next.js</1>say hi."
+msgstr "Wonderful framework <0>Next.js</0>say hi. And <1>Next.js</1>say hi."

packages/cli/test/extractor-experimental-1797/expected/locales/index.page/pl.po

@@ -0,0 +1,67 @@
+msgid ""
+msgstr ""
+"POT-Creation-Date: 2023-03-15 10:00+0000\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: @lingui/cli\n"
+"Language: pl\n"
+
+#: fixtures/pages/index.page.tsx:83
+#: fixtures/pages/index.page.tsx:85
+msgid "{0, plural, one {# Person} other {# Persons}}"
+msgstr ""
+
+#: fixtures/components/Developers.tsx:20
+msgid "{selected, plural, one {Developer} other {Developers}}"
+msgstr ""
+
+#: fixtures/pages/index.page.tsx:62
+msgid "<0>Next.js</0>say hi."
+msgstr ""
+
+#: fixtures/components/Switcher.tsx:10
+msgid "English"
+msgstr ""
+
+#: fixtures/components/AboutText.tsx:6
+msgid "Hello, world"
+msgstr ""
+
+#. js-lingui-explicit-id
+#: fixtures/components/AboutText.tsx:8
+msgid "message.next-explanation"
+msgstr ""
+
+#: fixtures/pages/index.page.tsx:58
+#: fixtures/pages/index.page.tsx:60
+msgid "Plain text"
+msgstr ""
+
+#: fixtures/components/Developers.tsx:9
+msgid "Plural Test: How many developers?"
+msgstr ""
+
+#: fixtures/components/Switcher.tsx:11
+msgid "Serbian"
+msgstr ""
+
+#: fixtures/components/Switcher.tsx:12
+msgid "Spanish"
+msgstr ""
+
+#: fixtures/pages/index.page.tsx:46
+msgid "Translation Demo"
+msgstr ""
+
+#: fixtures/pages/index.page.tsx:53
+msgid "Welcome to <0>Next.js!</0>"
+msgstr ""
+
+#: fixtures/pages/index.page.tsx:67
+msgid "Wonderful framework <0>Next.js</0>say hi."
+msgstr ""
+
+#: fixtures/pages/index.page.tsx:72
+msgid "Wonderful framework <0>Next.js</0>say hi. And <1>Next.js</1>say hi."
+msgstr ""

packages/cli/test/extractor-experimental-1797/fixtures/components/AboutText.tsx

@@ -0,0 +1,18 @@
+import { Trans } from '@lingui/macro'
+
+export function AboutText() {
+ return (
+ <p>
+ <Trans>Hello, world</Trans>
+ <br />
+ <Trans id="message.next-explanation">
+ Next.js is an open-source React front-end development web framework that
+ enables functionality such as server-side rendering and generating
+ static websites for React based web applications. It is a
+ production-ready framework that allows developers to quickly create
+ static and dynamic JAMstack websites and is used widely by many large
+ companies.
+ </Trans>
+ </p>
+ )
+}

packages/cli/test/extractor-experimental-1797/fixtures/components/Developers.tsx

@@ -0,0 +1,25 @@
+import { useState } from 'react'
+import { Trans, Plural } from '@lingui/macro'
+
+export default function Developers() {
+ const [selected, setSelected] = useState('1')
+ return (
+ <div>
+ <p>
+ <Trans>Plural Test: How many developers?</Trans>
+ </p>
+ <div style={{ display: 'flex', justifyContent: 'space-evenly' }}>
+ <select
+ value={selected}
+ onChange={(evt) => setSelected(evt.target.value)}
+ >
+ <option value={'1'}>1</option>
+ <option value={'2'}>2</option>
+ </select>
+ <p>
+ <Plural value={selected} one={'Developer'} other={`Developers`} />
+ </p>
+ </div>
+ </div>
+ )
+}