unplugin-raw 0.5.0 → 0.6.0

package/README.md

@@ -2,12 +2,14 @@
 
 [![Unit Test](https://github.com/unplugin/unplugin-raw/actions/workflows/unit-test.yml/badge.svg)](https://github.com/unplugin/unplugin-raw/actions/workflows/unit-test.yml)
 
-Transform file to a default-export string. It will be transformed to JavaScript, then a string.
+Transform file to a default-export string, and can be transformed by esbuild.
 
 ## Installation
 
 ```bash
 npm i -D unplugin-raw
+
+npm i -D esbuild # Optional, if you want to transform TypeScript to JavaScript
 ```
 
 <details>
@@ -38,6 +40,20 @@ export default {
 
 <br></details>
 
+<details>
+<summary>Rolldown</summary><br>
+
+```ts
+// rolldown.config.js
+import Raw from 'unplugin-raw/rolldown'
+
+export default {
+  plugins: [Raw()],
+}
+```
+
+<br></details>
+
 <details>
 <summary>esbuild</summary><br>
 
@@ -52,18 +68,28 @@ build({
 
 <br></details>
 
-<!-- <details>
-<summary>Webpack</summary><br>
+## Options
 
 ```ts
-// webpack.config.js
-module.exports = {
-  /* ... */
-  plugins: [require('unplugin-raw/webpack')()],
+export interface TransformOptions {
+  /** @default [/\.[cm]?[jt]sx?$/] */
+  include?: FilterPattern
+  /** @default [/node_modules/] */
+  exclude?: FilterPattern
+  /** @default {} */
+  options?: EsbuildTransformOptions
 }
-```
 
-<br></details> -->
+export interface Options {
+  /** @default 'pre' */
+  enforce?: 'pre' | 'post' | undefined
+  /**
+   * Transform
+   * @default false
+   */
+  transform?: TransformOptions | boolean
+}
+```
 
 ## Usage
 

package/dist/api.d.ts

@@ -0,0 +1,9 @@
+import { Options, OptionsResolved, TransformOptions, resolveOptions } from "./options-DupdgTT1.js";
+import * as esbuild0 from "esbuild";
+import { TransformOptions as TransformOptions$1 } from "esbuild";
+import { Buffer } from "node:buffer";
+
+//#region src/core/transform.d.ts
+declare function transformRaw(file: string, isBytes: boolean, transform?: typeof esbuild0.transform, transformFilter?: (id: string | unknown) => boolean, options?: TransformOptions$1): Promise<string | Buffer>;
+//#endregion
+export { type Options, type OptionsResolved, type TransformOptions, resolveOptions, transformRaw };

package/dist/api.js

@@ -0,0 +1,3 @@
+import { resolveOptions, transformRaw } from "./options-BTT0I76V.js";
+
+export { resolveOptions, transformRaw };

package/dist/esbuild.d.ts

@@ -1,19 +1,7 @@
-import { unplugin } from "./index-DfjJYIkP.js";
+import "./options-DupdgTT1.js";
+import { unplugin } from "./index-BMXQlGcW.js";
 
 //#region src/esbuild.d.ts
-/**
-* Esbuild plugin
-*
-* @example
-* ```ts
-* // esbuild.config.js
-* import { build } from 'esbuild'
-*
-* build({
-*   plugins: [require('unplugin-raw/esbuild')()],
-* })
-* ```
-*/
 
 /**
 * Esbuild plugin
@@ -28,5 +16,6 @@ import { unplugin } from "./index-DfjJYIkP.js";
 * })
 * ```
 */
-declare const esbuild: typeof unplugin.esbuild; //#endregion
+declare const esbuild: typeof unplugin.esbuild;
+//#endregion
 export { esbuild as default, esbuild as "module.exports" };

package/dist/esbuild.js

@@ -1,4 +1,5 @@
-import { src_default } from "./src-i5caNZ-U.js";
+import "./options-BTT0I76V.js";
+import { src_default } from "./src-BAcSYQaW.js";
 
 //#region src/esbuild.ts
 /**

package/dist/index-BMXQlGcW.d.ts

@@ -0,0 +1,7 @@
+import { Options } from "./options-DupdgTT1.js";
+import { UnpluginInstance } from "unplugin";
+
+//#region src/index.d.ts
+declare const unplugin: UnpluginInstance<Options | undefined, false>;
+//#endregion
+export { unplugin };

package/dist/index.d.ts

@@ -1,2 +1,3 @@
-import { guessLoader$1 as guessLoader, unplugin } from "./index-DfjJYIkP.js";
-export { unplugin as default, guessLoader };
+import "./options-DupdgTT1.js";
+import { unplugin } from "./index-BMXQlGcW.js";
+export { unplugin as default };

package/dist/index.js

@@ -1,3 +1,4 @@
-import { guessLoader, src_default } from "./src-i5caNZ-U.js";
+import "./options-BTT0I76V.js";
+import { src_default } from "./src-BAcSYQaW.js";
 
-export { src_default as default, guessLoader };
+export { src_default as default };

package/dist/options-BTT0I76V.js

@@ -0,0 +1,55 @@
+import { readFile } from "node:fs/promises";
+import path from "node:path";
+
+//#region src/core/transform.ts
+async function transformRaw(file, isBytes, transform, transformFilter, options) {
+	let contents = await readFile(file, isBytes ? void 0 : "utf8");
+	if (!isBytes && transformFilter?.(file)) {
+		transform ||= (await import("esbuild")).transform;
+		contents = (await transform(contents, {
+			loader: guessLoader(file),
+			...options
+		})).code;
+	}
+	return isBytes ? contents : `export default ${JSON.stringify(contents)}`;
+}
+const ExtToLoader = {
+	".js": "js",
+	".mjs": "js",
+	".cjs": "js",
+	".jsx": "jsx",
+	".ts": "ts",
+	".cts": "ts",
+	".mts": "ts",
+	".tsx": "tsx",
+	".css": "css",
+	".less": "css",
+	".stylus": "css",
+	".scss": "css",
+	".sass": "css",
+	".json": "json",
+	".txt": "text"
+};
+function guessLoader(id) {
+	return ExtToLoader[path.extname(id).toLowerCase()] || "js";
+}
+
+//#endregion
+//#region src/core/options.ts
+function resolveOptions(options) {
+	let { transform = false } = options;
+	if (transform === true) transform = {};
+	return {
+		...options,
+		enforce: "enforce" in options ? options.enforce : "pre",
+		transform: transform ? {
+			...transform,
+			include: transform.include || [/\.[cm]?[jt]sx?$/],
+			exclude: transform.exclude || [/node_modules/],
+			options: transform.options || {}
+		} : false
+	};
+}
+
+//#endregion
+export { resolveOptions, transformRaw };

package/dist/options-DupdgTT1.d.ts

@@ -0,0 +1,27 @@
+import { FilterPattern } from "unplugin-utils";
+import { TransformOptions } from "esbuild";
+
+//#region src/core/options.d.ts
+interface TransformOptions$1 {
+  /** @default [/\.[cm]?[jt]sx?$/] */
+  include?: FilterPattern;
+  /** @default [/node_modules/] */
+  exclude?: FilterPattern;
+  /** @default {} */
+  options?: TransformOptions;
+}
+interface Options {
+  /** @default 'pre' */
+  enforce?: "pre" | "post" | undefined;
+  /**
+  * Transform
+  * @default false
+  */
+  transform?: TransformOptions$1 | boolean;
+}
+type OptionsResolved = Pick<Options, "enforce"> & {
+  transform: TransformOptions$1 | false;
+};
+declare function resolveOptions(options: Options): OptionsResolved;
+//#endregion
+export { Options, OptionsResolved, TransformOptions$1 as TransformOptions, resolveOptions };

package/dist/rolldown.d.ts

@@ -1,19 +1,7 @@
-import { unplugin } from "./index-DfjJYIkP.js";
+import "./options-DupdgTT1.js";
+import { unplugin } from "./index-BMXQlGcW.js";
 
 //#region src/rolldown.d.ts
-/**
-* Rolldown plugin
-*
-* @example
-* ```ts
-* // rolldown.config.js
-* import Raw from 'unplugin-raw/rolldown'
-*
-* export default {
-*   plugins: [Raw()],
-* }
-* ```
-*/
 
 /**
 * Rolldown plugin
@@ -28,5 +16,6 @@ import { unplugin } from "./index-DfjJYIkP.js";
 * }
 * ```
 */
-declare const rolldown: typeof unplugin.rolldown; //#endregion
+declare const rolldown: typeof unplugin.rolldown;
+//#endregion
 export { rolldown as default, rolldown as "module.exports" };

package/dist/rolldown.js

@@ -1,4 +1,5 @@
-import { src_default } from "./src-i5caNZ-U.js";
+import "./options-BTT0I76V.js";
+import { src_default } from "./src-BAcSYQaW.js";
 
 //#region src/rolldown.ts
 /**

package/dist/rollup.d.ts

@@ -1,19 +1,7 @@
-import { unplugin } from "./index-DfjJYIkP.js";
+import "./options-DupdgTT1.js";
+import { unplugin } from "./index-BMXQlGcW.js";
 
 //#region src/rollup.d.ts
-/**
-* Rollup plugin
-*
-* @example
-* ```ts
-* // rollup.config.js
-* import Raw from 'unplugin-raw/rollup'
-*
-* export default {
-*   plugins: [Raw()],
-* }
-* ```
-*/
 
 /**
 * Rollup plugin
@@ -28,5 +16,6 @@ import { unplugin } from "./index-DfjJYIkP.js";
 * }
 * ```
 */
-declare const rollup: typeof unplugin.rollup; //#endregion
+declare const rollup: typeof unplugin.rollup;
+//#endregion
 export { rollup as default, rollup as "module.exports" };

package/dist/rollup.js

@@ -1,4 +1,5 @@
-import { src_default } from "./src-i5caNZ-U.js";
+import "./options-BTT0I76V.js";
+import { src_default } from "./src-BAcSYQaW.js";
 
 //#region src/rollup.ts
 /**

package/dist/rspack.d.ts

@@ -1,17 +1,7 @@
-import { unplugin } from "./index-DfjJYIkP.js";
+import "./options-DupdgTT1.js";
+import { unplugin } from "./index-BMXQlGcW.js";
 
 //#region src/rspack.d.ts
-/**
-* Rspack plugin
-*
-* @example
-* ```ts
-* // rspack.config.js
-* module.exports = {
-*  plugins: [require('unplugin-raw/rspack')()],
-* }
-* ```
-*/
 
 /**
 * Rspack plugin
@@ -24,5 +14,6 @@ import { unplugin } from "./index-DfjJYIkP.js";
 * }
 * ```
 */
-declare const rspack: typeof unplugin.rspack; //#endregion
+declare const rspack: typeof unplugin.rspack;
+//#endregion
 export { rspack as default, rspack as "module.exports" };

package/dist/rspack.js

@@ -1,4 +1,5 @@
-import { src_default } from "./src-i5caNZ-U.js";
+import "./options-BTT0I76V.js";
+import { src_default } from "./src-BAcSYQaW.js";
 
 //#region src/rspack.ts
 /**

package/dist/src-BAcSYQaW.js

@@ -0,0 +1,58 @@
+import { resolveOptions, transformRaw } from "./options-BTT0I76V.js";
+import { createUnplugin } from "unplugin";
+import { createFilter } from "unplugin-utils";
+
+//#region src/index.ts
+const rawRE = /[&?]raw(?:&|$)/;
+const postfixRE = /[#?].*$/s;
+function cleanUrl(url) {
+	return url.replace(postfixRE, "");
+}
+const unplugin = createUnplugin((rawOptions = {}, meta) => {
+	const options = resolveOptions(rawOptions);
+	const transformFilter = options.transform ? createFilter(options.transform.include, options.transform.exclude) : void 0;
+	return {
+		name: "unplugin-raw",
+		enforce: options.enforce,
+		resolveId: [
+			"rollup",
+			"rolldown",
+			"vite"
+		].includes(meta.framework) ? async function(id, importer, options$1) {
+			const attributeType = options$1?.attributes?.type;
+			if (attributeType === "text") id += `${id.includes("?") ? "&" : "?"}raw`;
+			else if (attributeType === "bytes") id += `${id.includes("?") ? "&" : "?"}bytes`;
+			if (!rawRE.test(id)) return;
+			const file = cleanUrl(id);
+			const resolved = await this.resolve(file, importer);
+			if (!resolved) return;
+			return id.replace(file, resolved.id);
+		} : void 0,
+		load: {
+			filter: { id: { include: rawRE } },
+			async handler(id) {
+				const file = cleanUrl(id);
+				const context = this.getNativeBuildContext?.();
+				const transform = context?.framework === "esbuild" ? context.build.esbuild.transform : void 0;
+				const contents = await transformRaw(file, false, transform, transformFilter, options.transform ? options.transform.options : void 0);
+				return contents;
+			}
+		},
+		esbuild: { setup(build) {
+			build.onLoad({ filter: /.*/ }, async (args) => {
+				const isBytes = args.with.type === "bytes";
+				if (args.with.type === "text" || isBytes) {
+					const contents = await transformRaw(args.path, isBytes, build.esbuild.transform, transformFilter, options.transform ? options.transform.options : void 0);
+					return {
+						contents,
+						loader: typeof contents === "string" ? "js" : "binary"
+					};
+				}
+			});
+		} }
+	};
+});
+var src_default = unplugin;
+
+//#endregion
+export { src_default };

package/dist/vite.d.ts

@@ -1,19 +1,7 @@
-import { unplugin } from "./index-DfjJYIkP.js";
+import "./options-DupdgTT1.js";
+import { unplugin } from "./index-BMXQlGcW.js";
 
 //#region src/vite.d.ts
-/**
-* Vite plugin
-*
-* @example
-* ```ts
-* // vite.config.ts
-* import Raw from 'unplugin-raw/vite'
-*
-* export default defineConfig({
-*   plugins: [Raw()],
-* })
-* ```
-*/
 
 /**
 * Vite plugin
@@ -28,5 +16,6 @@ import { unplugin } from "./index-DfjJYIkP.js";
 * })
 * ```
 */
-declare const vite: typeof unplugin.vite; //#endregion
+declare const vite: typeof unplugin.vite;
+//#endregion
 export { vite as default, vite as "module.exports" };

package/dist/vite.js

@@ -1,4 +1,5 @@
-import { src_default } from "./src-i5caNZ-U.js";
+import "./options-BTT0I76V.js";
+import { src_default } from "./src-BAcSYQaW.js";
 
 //#region src/vite.ts
 /**

package/dist/webpack.d.ts

@@ -1,17 +1,7 @@
-import { unplugin } from "./index-DfjJYIkP.js";
+import "./options-DupdgTT1.js";
+import { unplugin } from "./index-BMXQlGcW.js";
 
 //#region src/webpack.d.ts
-/**
-* Webpack plugin
-*
-* @example
-* ```ts
-* // webpack.config.js
-* module.exports = {
-*  plugins: [require('unplugin-raw/webpack')()],
-* }
-* ```
-*/
 
 /**
 * Webpack plugin
@@ -24,5 +14,6 @@ import { unplugin } from "./index-DfjJYIkP.js";
 * }
 * ```
 */
-declare const webpack: typeof unplugin.webpack; //#endregion
+declare const webpack: typeof unplugin.webpack;
+//#endregion
 export { webpack as default, webpack as "module.exports" };

package/dist/webpack.js

@@ -1,4 +1,5 @@
-import { src_default } from "./src-i5caNZ-U.js";
+import "./options-BTT0I76V.js";
+import { src_default } from "./src-BAcSYQaW.js";
 
 //#region src/webpack.ts
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unplugin-raw",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Transform file to a default-export string.",
   "type": "module",
   "keywords": [
@@ -48,24 +48,32 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "esbuild": ">=0.25.0"
+  },
+  "peerDependenciesMeta": {
+    "esbuild": {
+      "optional": true
+    }
+  },
   "dependencies": {
-    "esbuild": "^0.25.4",
-    "unplugin": "^2.3.2",
-    "unplugin-utils": "^0.2.4"
+    "unplugin": "^2.3.5",
+    "unplugin-utils": "^0.2.5"
   },
   "devDependencies": {
-    "@sxzz/eslint-config": "^7.0.0",
-    "@sxzz/prettier-config": "^2.2.1",
-    "@types/node": "^22.15.17",
-    "bumpp": "^10.1.0",
-    "eslint": "^9.26.0",
-    "prettier": "^3.5.3",
-    "rollup": "^4.40.2",
-    "tsdown": "^0.11.1",
-    "tsx": "^4.19.4",
-    "typescript": "^5.8.3",
-    "vite": "^6.3.5",
-    "vitest": "^3.1.3"
+    "@sxzz/eslint-config": "^7.1.2",
+    "@sxzz/prettier-config": "^2.2.3",
+    "@types/node": "^24.2.1",
+    "bumpp": "^10.2.3",
+    "esbuild": "^0.25.9",
+    "eslint": "^9.33.0",
+    "prettier": "^3.6.2",
+    "rollup": "^4.46.2",
+    "tsdown": "^0.14.1",
+    "tsx": "^4.20.4",
+    "typescript": "^5.9.2",
+    "vite": "^7.1.2",
+    "vitest": "^3.2.4"
   },
   "engines": {
     "node": ">=20.18.0"

package/dist/index-DfjJYIkP.d.ts

@@ -1,24 +0,0 @@
-import { UnpluginInstance } from "unplugin";
-import { FilterPattern } from "unplugin-utils";
-import { Loader, TransformOptions } from "esbuild";
-
-//#region src/core/options.d.ts
-interface Options {
-  /** @default 'pre' */
-  enforce?: "pre" | "post" | undefined;
-  /** Transform */
-  transform?: {
-    /** @default [/\.[cm]?[jt]sx?$/] */
-    include?: FilterPattern;
-    /** @default [/node_modules/] */
-    exclude?: FilterPattern;
-    /** @default {} */
-    options?: TransformOptions;
-  };
-} //#endregion
-//#region src/index.d.ts
-declare const unplugin: UnpluginInstance<Options | undefined, false>;
-declare function guessLoader(id: string): Loader;
-
-//#endregion
-export { guessLoader as guessLoader$1, unplugin };

package/dist/src-i5caNZ-U.js

@@ -1,90 +0,0 @@
-import { readFile } from "node:fs/promises";
-import path from "node:path";
-import { createUnplugin } from "unplugin";
-import { createFilter } from "unplugin-utils";
-
-//#region src/core/options.ts
-function resolveOptions(options) {
-	return {
-		...options,
-		enforce: "enforce" in options ? options.enforce : "pre",
-		transform: {
-			...options.transform,
-			include: options.transform?.include || [/\.[cm]?[jt]sx?$/],
-			exclude: options.transform?.exclude || [/node_modules/],
-			options: options.transform?.options || {}
-		}
-	};
-}
-
-//#endregion
-//#region src/index.ts
-const unplugin = createUnplugin((rawOptions = {}, meta) => {
-	const options = resolveOptions(rawOptions);
-	const transformFilter = createFilter(options.transform.include, options.transform.exclude);
-	return {
-		name: "unplugin-raw",
-		enforce: options.enforce,
-		resolveId: meta.framework === "rollup" ? async function(id, importer, opt) {
-			if (opt?.attributes?.type === "text") if (id.includes("?")) id += "&raw";
-			else id += "?raw";
-			if (!rawRE.test(id)) return;
-			const file = cleanUrl(id);
-			const resolved = await this.resolve(file, importer);
-			if (!resolved) return;
-			return id.replace(file, resolved.id);
-		} : void 0,
-		load: {
-			filter: { id: { include: rawRE } },
-			async handler(id) {
-				const file = cleanUrl(id);
-				let contents = await readFile(file, "utf-8");
-				if (transformFilter(file)) {
-					let transform;
-					const nativeContext = this.getNativeBuildContext?.();
-					if (nativeContext?.framework === "esbuild") ({transform} = nativeContext.build.esbuild);
-					else transform = (await import("esbuild")).transform;
-					contents = (await transform(contents, {
-						loader: guessLoader(file),
-						...options.transform.options
-					})).code;
-				}
-				return `export default ${JSON.stringify(contents)}`;
-			}
-		},
-		esbuild: { setup(build) {
-			build.onLoad({ filter: /.*/ }, (args) => {
-				if (args.with.type === "text") return { contents: "export default \"123\"" };
-			});
-		} }
-	};
-});
-var src_default = unplugin;
-const rawRE = /[&?]raw(?:&|$)/;
-const postfixRE = /[#?].*$/s;
-function cleanUrl(url) {
-	return url.replace(postfixRE, "");
-}
-const ExtToLoader = {
-	".js": "js",
-	".mjs": "js",
-	".cjs": "js",
-	".jsx": "jsx",
-	".ts": "ts",
-	".cts": "ts",
-	".mts": "ts",
-	".tsx": "tsx",
-	".css": "css",
-	".less": "css",
-	".stylus": "css",
-	".scss": "css",
-	".sass": "css",
-	".json": "json",
-	".txt": "text"
-};
-function guessLoader(id) {
-	return ExtToLoader[path.extname(id).toLowerCase()] || "js";
-}
-
-//#endregion
-export { guessLoader, src_default };