chore(vite-plugin): add error handling for dynamic import of @lingui/core/macro (#2056)

Co-authored-by: Timofei Iatsenko <[email protected]>

Author: maastrich

packages/vite-plugin/src/index.ts

@@ -54,6 +54,16 @@ export function lingui({
           )
         }
       },
+      resolveDynamicImport(id, importer) {
+        if (macroIds.has(id as string)) {
+          throw new Error(
+            `The macro you imported from "${id}" cannot be dynamically imported. \n` +
+              `Please check the import statement in file "${importer}". \n` +
+              `Please see the documentation for how to configure Vite with Lingui correctly: ` +
+              "https://lingui.dev/tutorials/setup-vite"
+          )
+        }
+      },
     },
     {
       name: "vite-plugin-lingui",

packages/vite-plugin/test/dynamic-macro-error/entrypoint.js

@@ -0,0 +1,4 @@
+export async function load() {
+  const { t } = await import("@lingui/core/macro")
+  return t`Ola`
+}

packages/vite-plugin/test/dynamic-macro-error/lingui.config.js

@@ -0,0 +1,11 @@
+import { defineConfig } from "@lingui/cli"
+
+export default defineConfig({
+  locales: ["en"],
+  catalogs: [
+    {
+      path: "<rootDir>/locale/{locale}",
+    },
+  ],
+  format: "po",
+})

packages/vite-plugin/test/dynamic-macro-error/locale/en.po

@@ -0,0 +1,5 @@
+msgid "Hello World"
+msgstr "Hello World"
+
+msgid "My name is {name}"
+msgstr "My name is {name}"

packages/vite-plugin/test/dynamic-macro-error/vite.config.ts

@@ -0,0 +1,11 @@
+import { createDefaultViteConfig } from "../default-vite.config"
+import { UserConfig } from "vite"
+import macrosPlugin from "vite-plugin-babel-macros"
+
+const config: UserConfig = {
+  ...createDefaultViteConfig(__dirname),
+}
+
+config.plugins.push(macrosPlugin())
+
+export default config

packages/vite-plugin/test/index.ts

@@ -64,6 +64,17 @@ skipOnWindows("vite-plugin", () => {
 
     expect(res.stderr).toContain("Compilation error for 2 translation(s)")
   })
+
+  it("should report error when @lingui/macro is dynamically imported", async () => {
+    expect.assertions(1)
+    try {
+      await runVite(`dynamic-macro-error/vite.config.ts`)
+    } catch (e) {
+      expect(e.stderr).toContain(
+        'The macro you imported from "@lingui/core/macro" cannot be dynamically imported.'
+      )
+    }
+  })
 })
 
 async function runVite(configPath: string) {

packages/vite-plugin/test/macro-usage/.linguirc

@@ -0,0 +1,11 @@
+import { defineConfig } from "@lingui/cli"
+
+export default defineConfig({
+  locales: ["en"],
+  catalogs: [
+    {
+      path: "<rootDir>/locale/{locale}",
+    },
+  ],
+  format: "po",
+})

packages/vite-plugin/test/macro-usage/lingui.config.js

@@ -0,0 +1,11 @@
+import { defineConfig } from "@lingui/cli"
+
+export default defineConfig({
+  locales: ["en"],
+  catalogs: [
+    {
+      path: "<rootDir>/locale/{locale}",
+    },
+  ],
+  format: "po",
+})