@formatjs/unplugin 1.0.0

package/LICENSE.md

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

package/README.md

@@ -0,0 +1,106 @@
+# @formatjs/unplugin
+
+Universal build plugin for FormatJS AST transformations. Supports Vite, Webpack, Rollup, esbuild, and Rspack with one codebase.
+
+Replicates the functionality of `babel-plugin-formatjs` and `@formatjs/ts-transformer` using `oxc-parser` + `magic-string` for fast, compiler-agnostic builds.
+
+## Installation
+
+```bash
+npm install @formatjs/unplugin --save-dev
+```
+
+## Usage
+
+### Vite
+
+```ts
+// vite.config.ts
+import {defineConfig} from 'vite'
+import formatjs from '@formatjs/unplugin/vite'
+
+export default defineConfig({
+  plugins: [
+    formatjs({
+      idInterpolationPattern: '[sha512:contenthash:base64:6]',
+      ast: true,
+    }),
+  ],
+})
+```
+
+### Webpack
+
+```js
+// webpack.config.js
+const formatjs = require('@formatjs/unplugin/webpack').default
+
+module.exports = {
+  plugins: [
+    formatjs({
+      idInterpolationPattern: '[sha512:contenthash:base64:6]',
+      ast: true,
+    }),
+  ],
+}
+```
+
+### Rollup
+
+```js
+// rollup.config.js
+import formatjs from '@formatjs/unplugin/rollup'
+
+export default {
+  plugins: [
+    formatjs({
+      idInterpolationPattern: '[sha512:contenthash:base64:6]',
+      ast: true,
+    }),
+  ],
+}
+```
+
+### esbuild
+
+```js
+import esbuild from 'esbuild'
+import formatjs from '@formatjs/unplugin/esbuild'
+
+esbuild.build({
+  plugins: [
+    formatjs({
+      idInterpolationPattern: '[sha512:contenthash:base64:6]',
+      ast: true,
+    }),
+  ],
+})
+```
+
+### Rspack
+
+```js
+// rspack.config.js
+const formatjs = require('@formatjs/unplugin/rspack').default
+
+module.exports = {
+  plugins: [
+    formatjs({
+      idInterpolationPattern: '[sha512:contenthash:base64:6]',
+      ast: true,
+    }),
+  ],
+}
+```
+
+## Options
+
+| Option                     | Type       | Default                         | Description                             |
+| -------------------------- | ---------- | ------------------------------- | --------------------------------------- |
+| `idInterpolationPattern`   | `string`   | `[sha512:contenthash:base64:6]` | Pattern for generating message IDs      |
+| `overrideIdFn`             | `function` | —                               | Custom function to generate message IDs |
+| `removeDefaultMessage`     | `boolean`  | `false`                         | Remove `defaultMessage` from output     |
+| `additionalComponentNames` | `string[]` | `[]`                            | Extra JSX component names to process    |
+| `additionalFunctionNames`  | `string[]` | `[]`                            | Extra function names to process         |
+| `ast`                      | `boolean`  | `false`                         | Pre-parse `defaultMessage` into AST     |
+| `preserveWhitespace`       | `boolean`  | `false`                         | Keep original whitespace in messages    |

package/esbuild.d.ts

@@ -0,0 +1,5 @@
+import { type UnpluginInstance } from "unplugin";
+import type { Options } from "./transform.js";
+declare const plugin: UnpluginInstance<Options | undefined>["esbuild"];
+export default plugin;
+export type { Options } from "./transform.js";

package/esbuild.js

@@ -0,0 +1,4 @@
+import { createEsbuildPlugin } from "unplugin";
+import { unpluginFactory } from "./index.js";
+const plugin = createEsbuildPlugin(unpluginFactory);
+export default plugin;

package/index.d.ts

@@ -0,0 +1,6 @@
+import { type UnpluginFactory, type UnpluginInstance } from "unplugin";
+import { type Options } from "./transform.js";
+export type { Options } from "./transform.js";
+export declare const unpluginFactory: UnpluginFactory<Options | undefined>;
+export declare const unplugin: UnpluginInstance<Options | undefined>;
+export default unplugin;

package/index.js

@@ -0,0 +1,14 @@
+import { createUnplugin } from "unplugin";
+import { transform } from "./transform.js";
+export const unpluginFactory = (options = {}) => ({
+	name: "formatjs",
+	enforce: "pre",
+	transformInclude(id) {
+		return /\.[jt]sx?$/.test(id) && !id.includes("node_modules");
+	},
+	transform(code, id) {
+		return transform(code, id, options);
+	}
+});
+export const unplugin = /* @__PURE__ */ createUnplugin(unpluginFactory);
+export default unplugin;

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@formatjs/unplugin",
+  "description": "Universal build plugin for FormatJS — supports Vite, Webpack, Rollup, esbuild, and Rspack",
+  "version": "1.0.0",
+  "license": "MIT",
+  "author": "Long Ho <holevietlong@gmail.com>",
+  "type": "module",
+  "types": "index.d.ts",
+  "exports": {
+    ".": "./index.js",
+    "./vite": "./vite.js",
+    "./webpack": "./webpack.js",
+    "./rollup": "./rollup.js",
+    "./esbuild": "./esbuild.js",
+    "./rspack": "./rspack.js",
+    "./transform": "./transform.js"
+  },
+  "dependencies": {
+    "@formatjs/icu-messageformat-parser": "workspace:*",
+    "@formatjs/ts-transformer": "workspace:*",
+    "magic-string": "^0.30.0",
+    "oxc-parser": "^0.114.0",
+    "unplugin": "^2.3.0"
+  },
+  "peerDependencies": {
+    "@rspack/core": ">=1",
+    "esbuild": ">=0.17",
+    "rollup": ">=3",
+    "vite": ">=5",
+    "webpack": "^5.104.1"
+  },
+  "bugs": "https://github.com/formatjs/formatjs/issues",
+  "homepage": "https://github.com/formatjs/formatjs#readme",
+  "keywords": [
+    "esbuild-plugin",
+    "formatjs",
+    "i18n",
+    "internationalization",
+    "react-intl",
+    "rollup-plugin",
+    "rspack-plugin",
+    "unplugin",
+    "vite-plugin",
+    "webpack-plugin"
+  ],
+  "main": "index.js",
+  "peerDependenciesMeta": {
+    "vite": {
+      "optional": true
+    },
+    "webpack": {
+      "optional": true
+    },
+    "rollup": {
+      "optional": true
+    },
+    "esbuild": {
+      "optional": true
+    },
+    "@rspack/core": {
+      "optional": true
+    }
+  },
+  "repository": "formatjs/formatjs.git"
+}

package/rollup.d.ts

@@ -0,0 +1,5 @@
+import { type UnpluginInstance } from "unplugin";
+import type { Options } from "./transform.js";
+declare const plugin: UnpluginInstance<Options | undefined>["rollup"];
+export default plugin;
+export type { Options } from "./transform.js";

package/rollup.js

@@ -0,0 +1,4 @@
+import { createRollupPlugin } from "unplugin";
+import { unpluginFactory } from "./index.js";
+const plugin = createRollupPlugin(unpluginFactory);
+export default plugin;

package/rspack.d.ts

@@ -0,0 +1,5 @@
+import { type UnpluginInstance } from "unplugin";
+import type { Options } from "./transform.js";
+declare const plugin: UnpluginInstance<Options | undefined>["rspack"];
+export default plugin;
+export type { Options } from "./transform.js";

package/rspack.js

@@ -0,0 +1,4 @@
+import { createRspackPlugin } from "unplugin";
+import { unpluginFactory } from "./index.js";
+const plugin = createRspackPlugin(unpluginFactory);
+export default plugin;

package/transform.d.ts

@@ -0,0 +1,14 @@
+import MagicString from "magic-string";
+export interface Options {
+	overrideIdFn?: (id: string | undefined, defaultMessage: string | undefined, description: string | undefined, filePath: string) => string;
+	idInterpolationPattern?: string;
+	removeDefaultMessage?: boolean;
+	additionalComponentNames?: string[];
+	additionalFunctionNames?: string[];
+	ast?: boolean;
+	preserveWhitespace?: boolean;
+}
+export declare function transform(code: string, id: string, options: Options): {
+	code: string;
+	map: ReturnType<MagicString["generateMap"]>;
+} | undefined;

package/transform.js

@@ -0,0 +1,310 @@
+import { parseSync, Visitor } from "oxc-parser";
+import MagicString from "magic-string";
+import { interpolateName } from "@formatjs/ts-transformer";
+import { parse } from "@formatjs/icu-messageformat-parser";
+const DEFAULT_ID_INTERPOLATION_PATTERN = "[sha512:contenthash:base64:6]";
+export function transform(code, id, options) {
+	const { overrideIdFn, idInterpolationPattern = DEFAULT_ID_INTERPOLATION_PATTERN, removeDefaultMessage = false, additionalComponentNames = [], additionalFunctionNames = [], ast: preParseAst = false, preserveWhitespace = false } = options;
+	const componentNames = new Set(["FormattedMessage", ...additionalComponentNames]);
+	const functionNames = new Set([
+		"formatMessage",
+		"$t",
+		"$formatMessage",
+		"defineMessage",
+		"defineMessages",
+		...additionalFunctionNames
+	]);
+	// Compiled JSX runtime functions: _jsx(Component, props), React.createElement(Component, props)
+	const jsxRuntimeFunctions = new Set([
+		"jsx",
+		"_jsx",
+		"jsxs",
+		"_jsxs",
+		"jsxDEV",
+		"_jsxDEV",
+		"createElement"
+	]);
+	const result = parseSync(id, code, { sourceType: "module" });
+	const program = result.program;
+	let s;
+	function getStaticValue(node) {
+		if (!node) return undefined;
+		if (node.type === "StringLiteral" || node.type === "Literal") {
+			if (typeof node.value === "string") return node.value;
+			return undefined;
+		}
+		if (node.type === "TemplateLiteral") {
+			if (node.quasis.length === 1 && node.expressions.length === 0) {
+				return node.quasis[0].value.cooked ?? node.quasis[0].value.raw;
+			}
+			return undefined;
+		}
+		if (node.type === "BinaryExpression" && node.operator === "+") {
+			const left = getStaticValue(node.left);
+			const right = getStaticValue(node.right);
+			if (left !== undefined && right !== undefined) return left + right;
+			return undefined;
+		}
+		return undefined;
+	}
+	function extractDescriptor(objNode) {
+		const properties = objNode.properties;
+		const descriptor = {};
+		const locations = {};
+		// Use the position right after `{` as a stable insertion point
+		locations.insertionPoint = objNode.start + 1;
+		for (const prop of properties) {
+			if (prop.type !== "Property" && prop.type !== "ObjectProperty") continue;
+			const key = prop.key;
+			let name;
+			if (key.type === "Identifier") name = key.name;
+			else if (key.type === "StringLiteral" || key.type === "Literal") {
+				name = key.value;
+			}
+			if (!name) continue;
+			if (name !== "id" && name !== "defaultMessage" && name !== "description") continue;
+			const keyName = name;
+			const val = getStaticValue(prop.value);
+			if (val === undefined) continue;
+			descriptor[keyName] = val;
+			locations[keyName] = {
+				start: prop.value.start,
+				end: prop.value.end,
+				value: val
+			};
+		}
+		if (!descriptor.defaultMessage && !descriptor.id) return undefined;
+		return {
+			descriptor,
+			locations
+		};
+	}
+	function extractJSXDescriptor(elementNode) {
+		const attributes = elementNode.attributes || [];
+		const descriptor = {};
+		const locations = {};
+		// Use the position right after the element name as the insertion point
+		// Find the first attribute start, or use the end of the element name
+		const firstAttr = attributes[0];
+		locations.insertionPoint = firstAttr ? firstAttr.start : elementNode.name.end;
+		for (const attr of attributes) {
+			if (attr.type !== "JSXAttribute") continue;
+			const attrName = attr.name;
+			if (!attrName || attrName.type !== "JSXIdentifier") continue;
+			const n = attrName.name;
+			if (n !== "id" && n !== "defaultMessage" && n !== "description") continue;
+			const keyName = n;
+			let val;
+			const valueNode = attr.value;
+			if (!valueNode) continue;
+			if (valueNode.type === "StringLiteral" || valueNode.type === "Literal") {
+				val = valueNode.value;
+			} else if (valueNode.type === "JSXExpressionContainer") {
+				val = getStaticValue(valueNode.expression);
+			}
+			if (val === undefined) continue;
+			descriptor[keyName] = val;
+			locations[keyName] = {
+				start: attr.value.start,
+				end: attr.value.end,
+				value: val
+			};
+		}
+		if (!descriptor.defaultMessage && !descriptor.id) return undefined;
+		return {
+			descriptor,
+			locations
+		};
+	}
+	function processDescriptor(descriptor, locations, isJSX) {
+		let { defaultMessage, description } = descriptor;
+		let existingId = descriptor.id;
+		// Normalize whitespace on defaultMessage
+		if (defaultMessage && !preserveWhitespace) {
+			defaultMessage = defaultMessage.trim().replace(/\s+/gm, " ");
+		}
+		// Generate ID
+		let newId = existingId;
+		if (overrideIdFn) {
+			newId = overrideIdFn(existingId, defaultMessage, description, id);
+		} else if (!existingId && idInterpolationPattern && defaultMessage) {
+			newId = interpolateName({ resourcePath: id }, idInterpolationPattern, { content: description ? `${defaultMessage}#${description}` : defaultMessage });
+		}
+		if (!newId && !defaultMessage) return;
+		if (!s) s = new MagicString(code);
+		// Insert/update id
+		if (newId) {
+			if (locations.id) {
+				// Replace existing id value
+				s.overwrite(locations.id.start, locations.id.end, JSON.stringify(newId));
+			} else if (locations.insertionPoint != null) {
+				// Insert id at a stable position (after `{` for objects, before first attr for JSX)
+				if (isJSX) {
+					s.appendLeft(locations.insertionPoint, `id=${JSON.stringify(newId)} `);
+				} else {
+					s.appendRight(locations.insertionPoint, `id: ${JSON.stringify(newId)}, `);
+				}
+			}
+		}
+		// Remove description
+		if (locations.description) {
+			if (isJSX) {
+				// For JSX, we need to remove the whole attribute including the key
+				// Find the JSX attribute that contains this value
+				removeJSXAttribute(locations.description);
+			} else {
+				removeObjectProperty(locations.description);
+			}
+		}
+		// Handle defaultMessage
+		if (locations.defaultMessage) {
+			if (removeDefaultMessage) {
+				if (isJSX) {
+					removeJSXAttribute(locations.defaultMessage);
+				} else {
+					removeObjectProperty(locations.defaultMessage);
+				}
+			} else if (defaultMessage) {
+				if (preParseAst) {
+					const parsed = parse(defaultMessage);
+					const jsonStr = JSON.stringify(parsed);
+					s.overwrite(locations.defaultMessage.start, locations.defaultMessage.end, isJSX ? `{${jsonStr}}` : jsonStr);
+				} else if (defaultMessage !== locations.defaultMessage.value) {
+					// Whitespace was normalized, update the value
+					s.overwrite(locations.defaultMessage.start, locations.defaultMessage.end, JSON.stringify(defaultMessage));
+				}
+			}
+		}
+	}
+	function removeObjectProperty(loc) {
+		if (!s) return;
+		// Find the property boundaries: walk back to find key start, walk forward past trailing comma
+		let propStart = loc.start;
+		// Walk backward past value, colon, key, and any whitespace
+		let i = loc.start - 1;
+		while (i >= 0 && (code[i] === " " || code[i] === "	" || code[i] === "\n" || code[i] === "\r")) i--;
+		// Skip colon
+		if (i >= 0 && code[i] === ":") i--;
+		while (i >= 0 && (code[i] === " " || code[i] === "	" || code[i] === "\n" || code[i] === "\r")) i--;
+		// Walk backward through key (identifier or string literal)
+		if (i >= 0 && (code[i] === "\"" || code[i] === "'")) {
+			const quote = code[i];
+			i--;
+			while (i >= 0 && code[i] !== quote) i--;
+			if (i >= 0) i--;
+		} else {
+			while (i >= 0 && /[a-zA-Z0-9_$]/.test(code[i])) i--;
+		}
+		propStart = i + 1;
+		let propEnd = loc.end;
+		// Walk forward past trailing comma and whitespace
+		let j = loc.end;
+		while (j < code.length && (code[j] === " " || code[j] === "	")) j++;
+		if (j < code.length && code[j] === ",") {
+			j++;
+			// Also skip whitespace after comma
+			while (j < code.length && (code[j] === " " || code[j] === "	")) j++;
+			// Skip one newline
+			if (j < code.length && code[j] === "\n") j++;
+			else if (j < code.length && code[j] === "\r") {
+				j++;
+				if (j < code.length && code[j] === "\n") j++;
+			}
+		}
+		propEnd = j;
+		// Also remove leading whitespace/newline
+		let k = propStart - 1;
+		while (k >= 0 && (code[k] === " " || code[k] === "	")) k--;
+		if (k >= 0 && (code[k] === "\n" || code[k] === ",")) {
+			propStart = k + 1;
+		}
+		s.remove(propStart, propEnd);
+	}
+	function removeJSXAttribute(loc) {
+		if (!s) return;
+		// Walk backward from the value to find attribute name
+		let i = loc.start - 1;
+		// Skip the `=`
+		if (i >= 0 && code[i] === "=") i--;
+		// Walk backward through attribute name
+		while (i >= 0 && /[a-zA-Z0-9_$]/.test(code[i])) i--;
+		const attrStart = i + 1;
+		let attrEnd = loc.end;
+		// Skip trailing whitespace
+		let j = attrEnd;
+		while (j < code.length && (code[j] === " " || code[j] === "	")) j++;
+		attrEnd = j;
+		// Also remove leading whitespace
+		let k = attrStart - 1;
+		while (k >= 0 && (code[k] === " " || code[k] === "	")) k--;
+		const removeStart = k + 1;
+		s.remove(removeStart, attrEnd);
+	}
+	function getCalleeName(node) {
+		if (node.type === "Identifier") return node.name;
+		if (node.type === "MemberExpression" || node.type === "OptionalMemberExpression") {
+			if (node.property?.type === "Identifier") return node.property.name;
+		}
+		return undefined;
+	}
+	function handleCallExpression(node) {
+		const calleeName = getCalleeName(node.callee);
+		// Handle compiled JSX: _jsx(FormattedMessage, { id, description, defaultMessage })
+		if (calleeName && jsxRuntimeFunctions.has(calleeName)) {
+			const firstArg = node.arguments?.[0];
+			const componentName = firstArg?.type === "Identifier" ? firstArg.name : undefined;
+			if (componentName && componentNames.has(componentName)) {
+				const propsArg = node.arguments?.[1];
+				if (propsArg?.type === "ObjectExpression") {
+					const result = extractDescriptor(propsArg);
+					if (result) {
+						processDescriptor(result.descriptor, result.locations, false);
+					}
+				}
+			}
+		}
+		if (calleeName && functionNames.has(calleeName)) {
+			if (calleeName === "defineMessages") {
+				// Process each value in the object
+				const arg = node.arguments?.[0];
+				if (arg?.type === "ObjectExpression") {
+					for (const prop of arg.properties) {
+						if (prop.type === "Property" && prop.value?.type === "ObjectExpression") {
+							const result = extractDescriptor(prop.value);
+							if (result) {
+								processDescriptor(result.descriptor, result.locations, false);
+							}
+						}
+					}
+				}
+			} else {
+				const arg = node.arguments?.[0];
+				if (arg?.type === "ObjectExpression") {
+					const result = extractDescriptor(arg);
+					if (result) {
+						processDescriptor(result.descriptor, result.locations, false);
+					}
+				}
+			}
+		}
+	}
+	function handleJSXOpeningElement(node) {
+		const name = node.name?.type === "JSXIdentifier" ? node.name.name : undefined;
+		if (name && componentNames.has(name)) {
+			const result = extractJSXDescriptor(node);
+			if (result) {
+				processDescriptor(result.descriptor, result.locations, true);
+			}
+		}
+	}
+	const visitor = new Visitor({
+		CallExpression: handleCallExpression,
+		JSXOpeningElement: handleJSXOpeningElement
+	});
+	visitor.visit(program);
+	if (!s) return undefined;
+	return {
+		code: s.toString(),
+		map: s.generateMap({ hires: "boundary" })
+	};
+}

package/vite.d.ts

@@ -0,0 +1,5 @@
+import { type UnpluginInstance } from "unplugin";
+import type { Options } from "./transform.js";
+declare const plugin: UnpluginInstance<Options | undefined>["vite"];
+export default plugin;
+export type { Options } from "./transform.js";

package/vite.js

@@ -0,0 +1,4 @@
+import { createVitePlugin } from "unplugin";
+import { unpluginFactory } from "./index.js";
+const plugin = createVitePlugin(unpluginFactory);
+export default plugin;

package/webpack.d.ts

@@ -0,0 +1,5 @@
+import { type UnpluginInstance } from "unplugin";
+import type { Options } from "./transform.js";
+declare const plugin: UnpluginInstance<Options | undefined>["webpack"];
+export default plugin;
+export type { Options } from "./transform.js";

package/webpack.js

@@ -0,0 +1,4 @@
+import { createWebpackPlugin } from "unplugin";
+import { unpluginFactory } from "./index.js";
+const plugin = createWebpackPlugin(unpluginFactory);
+export default plugin;