@lingui/swc-plugin 6.2.0 → 6.4.0

package/README.md

@@ -56,7 +56,7 @@ module.exports = nextConfig;
 ```
 
 > **Note**
-> Consult with full working example for NextJS in the `/examples` folder in this repo.
+> Consult with [full working example](https://github.com/lingui/js-lingui/tree/main/examples/nextjs-swc) for NextJS with SWC.
 
 #### `vite.config.ts`
 
@@ -128,6 +128,18 @@ When using SWC directly via CLI or a JSON-only configuration, pass options manua
 
 ## Options
 
+### `corePackage`
+
+Defines which module specifiers the plugin should treat as core macro imports.
+
+Defaults to `[@lingui/macro, @lingui/core/macro]` for backwards compatibility with the legacy combined macro entrypoint.
+
+### `jsxPackage`
+
+Defines which module specifiers the plugin should treat as JSX macro imports.
+
+Defaults to `[@lingui/macro, @lingui/react/macro]` for backwards compatibility with the legacy combined macro entrypoint.
+
 ### `descriptorFields`
 
 Controls which fields are preserved in the transformed message descriptors. Accepts one of:

package/dist/map-options.d.ts

@@ -0,0 +1,45 @@
+import type { LinguiConfigNormalized } from "@lingui/conf" with { "resolution-mode": "import" };
+export type RuntimeModuleConfig = readonly [modulePath: string, exportName?: string];
+/** Options accepted by the `@lingui/swc-plugin` WASM plugin. */
+export type LinguiMacroOptions = {
+    /** Module specifiers treated as core macro imports, such as `t`, `msg`, and `defineMessage`. */
+    corePackage?: string[];
+    /** Module specifiers treated as JSX macro imports, such as `Trans` and `useLingui`. */
+    jsxPackage?: string[];
+    /** JSX attribute name used to provide explicit placeholder names inside `<Trans>` content. */
+    jsxPlaceholderAttribute?: string;
+    /** Default placeholder names for JSX tags when no explicit placeholder attribute is present. */
+    jsxPlaceholderDefaults?: Record<string, string>;
+    /** Overrides the runtime imports used by the plugin. Unlike the Babel macro configuration, must be passed as an object. */
+    runtimeModules: {
+        i18n: RuntimeModuleConfig;
+        Trans: RuntimeModuleConfig;
+        useLingui: RuntimeModuleConfig;
+    };
+    /**
+     * Compatibility option for using the v6 SWC plugin with `@lingui/cli@5.*`.
+     * - `false` (default) — URL-safe Base64 alphabet (Lingui v6).
+     * - `true` — Standard Base64 alphabet (Lingui v5).
+     *
+     * Temporary — will be removed in the next major release.
+     */
+    useLinguiV5IdGeneration?: boolean;
+    /**
+     * Controls which descriptor fields are preserved in output.
+     * - `"auto"` (default) — `"id-only"` in production, `"all"` otherwise.
+     * - `"all"` — Keeps id, message, context, and comment.
+     * - `"id-only"` — Keeps only id. Most optimized for production bundles.
+     * - `"message"` — Keeps id, message, and context (not comment).
+     */
+    descriptorFields?: 'auto' | 'all' | 'id-only' | 'message';
+    /** Restricts directive-based `idPrefix` to explicit ids starting with this leader string. When omitted, `idPrefix` is prepended to all explicit static ids. */
+    idPrefixLeader?: string;
+};
+/** Makes all properties in `T` optional, recursing into nested objects but preserving tuples/arrays as-is. */
+export type DeepPartial<T> = {
+    [Key in keyof T]?: T[Key] extends readonly unknown[] ? T[Key] : T[Key] extends object ? DeepPartial<T[Key]> : T[Key];
+};
+/**
+ * Maps relevant options from the Lingui config to the SWC plugin format
+ */
+export declare function mapOptions(linguiConfig: LinguiConfigNormalized, overrides?: DeepPartial<LinguiMacroOptions>): LinguiMacroOptions;

package/dist/map-options.js

@@ -0,0 +1,17 @@
+/**
+ * Maps relevant options from the Lingui config to the SWC plugin format
+ */
+export function mapOptions(linguiConfig, overrides) {
+    return {
+        corePackage: linguiConfig.macro.corePackage,
+        jsxPackage: linguiConfig.macro.jsxPackage,
+        jsxPlaceholderAttribute: linguiConfig.macro.jsxPlaceholderAttribute,
+        jsxPlaceholderDefaults: linguiConfig.macro.jsxPlaceholderDefaults,
+        idPrefixLeader: linguiConfig.macro.idPrefixLeader,
+        ...overrides,
+        runtimeModules: {
+            ...linguiConfig.runtimeConfigModule,
+            ...overrides?.runtimeModules,
+        },
+    };
+}

package/dist/options.d.ts

@@ -1,39 +1,6 @@
-export type RuntimeModuleConfig = readonly [modulePath: string, exportName?: string];
-/** Options accepted by the `@lingui/swc-plugin` WASM plugin. */
-export type LinguiMacroOptions = {
-    /** JSX attribute name used to provide explicit placeholder names inside `<Trans>` content. */
-    jsxPlaceholderAttribute?: string;
-    /** Default placeholder names for JSX tags when no explicit placeholder attribute is present. */
-    jsxPlaceholderDefaults?: Record<string, string>;
-    /** Overrides the runtime imports used by the plugin. Unlike the Babel macro configuration, must be passed as an object. */
-    runtimeModules: {
-        i18n: RuntimeModuleConfig;
-        Trans: RuntimeModuleConfig;
-        useLingui: RuntimeModuleConfig;
-    };
-    /**
-     * Compatibility option for using the v6 SWC plugin with `@lingui/cli@5.*`.
-     * - `false` (default) — URL-safe Base64 alphabet (Lingui v6).
-     * - `true` — Standard Base64 alphabet (Lingui v5).
-     *
-     * Temporary — will be removed in the next major release.
-     */
-    useLinguiV5IdGeneration?: boolean;
-    /**
-     * Controls which descriptor fields are preserved in output.
-     * - `"auto"` (default) — `"id-only"` in production, `"all"` otherwise.
-     * - `"all"` — Keeps id, message, context, and comment.
-     * - `"id-only"` — Keeps only id. Most optimized for production bundles.
-     * - `"message"` — Keeps id, message, and context (not comment).
-     */
-    descriptorFields?: 'auto' | 'all' | 'id-only' | 'message';
-    /** Restricts directive-based `idPrefix` to explicit ids starting with this leader string. When omitted, `idPrefix` is prepended to all explicit static ids. */
-    idPrefixLeader?: string;
-};
-/** Makes all properties in `T` optional, recursing into nested objects but preserving tuples/arrays as-is. */
-export type DeepPartial<T> = {
-    [Key in keyof T]?: T[Key] extends readonly unknown[] ? T[Key] : T[Key] extends object ? DeepPartial<T[Key]> : T[Key];
-};
+import { DeepPartial, LinguiMacroOptions } from "./map-options";
+export type { RuntimeModuleConfig, LinguiMacroOptions } from "./map-options";
+export { mapOptions } from "./map-options";
 /** Controls how the Lingui config is located and loaded. */
 export type GetConfigOptions = {
     /** Working directory for config discovery. Defaults to `process.cwd()`. */
@@ -60,4 +27,4 @@ export type GetConfigOptions = {
  * @param overrides - Plugin options merged over values derived from the Lingui config.
  * @param configOptions - Controls how the Lingui config is discovered or loaded.
  */
-export declare function linguiMacroSwcPlugin(overrides?: DeepPartial<LinguiMacroOptions>, configOptions?: GetConfigOptions): (string | LinguiMacroOptions)[];
+export declare function linguiMacroSwcPlugin(overrides?: DeepPartial<LinguiMacroOptions>, configOptions?: GetConfigOptions): [wasmPackage: string, config: LinguiMacroOptions];

package/dist/options.js

@@ -1,4 +1,6 @@
 import { getConfig } from "@lingui/conf";
+import { mapOptions } from "./map-options";
+export { mapOptions } from "./map-options";
 /**
  * Loads the Lingui config, maps relevant options to the SWC plugin format,
  * and returns a ready-to-use `["@lingui/swc-plugin", options]` tuple.
@@ -18,14 +20,5 @@ import { getConfig } from "@lingui/conf";
  */
 export function linguiMacroSwcPlugin(overrides, configOptions = {}) {
     const config = getConfig(configOptions);
-    const macroOptions = {
-        jsxPlaceholderAttribute: config.macro.jsxPlaceholderAttribute,
-        jsxPlaceholderDefaults: config.macro.jsxPlaceholderDefaults,
-        ...overrides,
-        runtimeModules: {
-            ...config.runtimeConfigModule,
-            ...overrides?.runtimeModules,
-        },
-    };
-    return ["@lingui/swc-plugin", macroOptions];
+    return ["@lingui/swc-plugin", mapOptions(config, overrides)];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingui/swc-plugin",
-  "version": "6.2.0",
+  "version": "6.4.0",
   "description": "A SWC Plugin for LinguiJS",
   "author": {
     "name": "Timofei Iatsenko",
@@ -21,9 +21,9 @@
     "i18n",
     "internationalization"
   ],
-  "main": "target/wasm32-wasip1/release/lingui_macro_plugin.wasm",
+  "main": "./lingui_macro.wasm",
   "exports": {
-    ".": "./target/wasm32-wasip1/release/lingui_macro_plugin.wasm",
+    ".": "./lingui_macro.wasm",
     "./options": {
       "types": "./dist/options.d.ts",
       "default": "./dist/options.js"
@@ -32,14 +32,13 @@
   "scripts": {
     "prepublishOnly": "yarn build:ts && yarn build:wasm",
     "build:ts": "tsc -p tsconfig.build.json",
-    "build:wasm": "cargo build-wasi --release",
-    "test:e2e": "cargo build-wasi --release && vitest run"
+    "build:wasm": "cargo build -p lingui_macro --target wasm32-wasip1 --release && cp ../../target/wasm32-wasip1/release/lingui_macro.wasm lingui_macro.wasm",
+    "test:e2e": "yarn build:wasm && vitest run"
   },
   "files": [
-    "LICENSE",
     "README.md",
     "dist/",
-    "target/wasm32-wasip1/release/lingui_macro_plugin.wasm"
+    "lingui_macro.wasm"
   ],
   "dependencies": {
     "@lingui/conf": "5 || 6"
@@ -60,6 +59,5 @@
     "@types/node": "22.13.14",
     "typescript": "^6.0.3",
     "vitest": "^4.1.7"
-  },
-  "packageManager": "yarn@4.12.0+sha512.f45ab632439a67f8bc759bf32ead036a1f413287b9042726b7cc4818b7b49e14e9423ba49b18f9e06ea4941c1ad062385b1d8760a8d5091a1a31e5f6219afca8"
+  }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Lingui
-
-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.