unplugin-raw 0.5.1 → 0.6.1

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright © 2023-PRESENT 三咲智子 (https://github.com/sxzz)
+Copyright © 2023-PRESENT Kevin Deng (https://github.com/sxzz)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,13 +1,17 @@
-# unplugin-raw [![npm](https://img.shields.io/npm/v/unplugin-raw.svg)](https://npmjs.com/package/unplugin-raw)
+# unplugin-raw
 
-[![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)
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![Unit Test][unit-test-src]][unit-test-href]
 
-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 +42,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 +70,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
 
@@ -84,4 +112,13 @@ import text4 from './with.js' with { type: 'text' }
 
 ## License
 
-[MIT](./LICENSE) License © 2023-PRESENT [三咲智子](https://github.com/sxzz)
+[MIT](./LICENSE) License © 2023-PRESENT [Kevin Deng](https://github.com/sxzz)
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/unplugin-raw.svg
+[npm-version-href]: https://npmjs.com/package/unplugin-raw
+[npm-downloads-src]: https://img.shields.io/npm/dm/unplugin-raw
+[npm-downloads-href]: https://www.npmcharts.com/compare/unplugin-raw?interval=30
+[unit-test-src]: https://github.com/unplugin/unplugin-raw/actions/workflows/unit-test.yml/badge.svg
+[unit-test-href]: https://github.com/unplugin/unplugin-raw/actions/workflows/unit-test.yml

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,4 +1,5 @@
-import { unplugin } from "./index-CbkvuMB_.js";
+import "./options-DupdgTT1.js";
+import { unplugin } from "./index-BMXQlGcW.js";
 
 //#region src/esbuild.d.ts
 

package/dist/esbuild.js

@@ -1,4 +1,5 @@
-import { src_default } from "./src-DE-h8IJW.js";
+import "./options-BTT0I76V.js";
+import { unplugin } from "./src-Dwv4ealK.js";
 
 //#region src/esbuild.ts
 /**
@@ -14,8 +15,7 @@ import { src_default } from "./src-DE-h8IJW.js";
 * })
 * ```
 */
-const esbuild = src_default.esbuild;
-var esbuild_default = esbuild;
+const esbuild = unplugin.esbuild;
 
 //#endregion
-export { esbuild_default as default, esbuild as "module.exports" };
+export { esbuild as default, esbuild as "module.exports" };

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, unplugin } from "./index-CbkvuMB_.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-DE-h8IJW.js";
+import "./options-BTT0I76V.js";
+import { unplugin } from "./src-Dwv4ealK.js";
 
-export { src_default as default, guessLoader };
+export { unplugin 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,4 +1,5 @@
-import { unplugin } from "./index-CbkvuMB_.js";
+import "./options-DupdgTT1.js";
+import { unplugin } from "./index-BMXQlGcW.js";
 
 //#region src/rolldown.d.ts
 

package/dist/rolldown.js

@@ -1,4 +1,5 @@
-import { src_default } from "./src-DE-h8IJW.js";
+import "./options-BTT0I76V.js";
+import { unplugin } from "./src-Dwv4ealK.js";
 
 //#region src/rolldown.ts
 /**
@@ -14,8 +15,7 @@ import { src_default } from "./src-DE-h8IJW.js";
 * }
 * ```
 */
-const rolldown = src_default.rolldown;
-var rolldown_default = rolldown;
+const rolldown = unplugin.rolldown;
 
 //#endregion
-export { rolldown_default as default, rolldown as "module.exports" };
+export { rolldown as default, rolldown as "module.exports" };

package/dist/rollup.d.ts

@@ -1,4 +1,5 @@
-import { unplugin } from "./index-CbkvuMB_.js";
+import "./options-DupdgTT1.js";
+import { unplugin } from "./index-BMXQlGcW.js";
 
 //#region src/rollup.d.ts
 

package/dist/rollup.js

@@ -1,4 +1,5 @@
-import { src_default } from "./src-DE-h8IJW.js";
+import "./options-BTT0I76V.js";
+import { unplugin } from "./src-Dwv4ealK.js";
 
 //#region src/rollup.ts
 /**
@@ -14,8 +15,7 @@ import { src_default } from "./src-DE-h8IJW.js";
 * }
 * ```
 */
-const rollup = src_default.rollup;
-var rollup_default = rollup;
+const rollup = unplugin.rollup;
 
 //#endregion
-export { rollup_default as default, rollup as "module.exports" };
+export { rollup as default, rollup as "module.exports" };

package/dist/rspack.d.ts

@@ -1,4 +1,5 @@
-import { unplugin } from "./index-CbkvuMB_.js";
+import "./options-DupdgTT1.js";
+import { unplugin } from "./index-BMXQlGcW.js";
 
 //#region src/rspack.d.ts
 

package/dist/rspack.js

@@ -1,4 +1,5 @@
-import { src_default } from "./src-DE-h8IJW.js";
+import "./options-BTT0I76V.js";
+import { unplugin } from "./src-Dwv4ealK.js";
 
 //#region src/rspack.ts
 /**
@@ -12,8 +13,7 @@ import { src_default } from "./src-DE-h8IJW.js";
 * }
 * ```
 */
-const rspack = src_default.rspack;
-var rspack_default = rspack;
+const rspack = unplugin.rspack;
 
 //#endregion
-export { rspack_default as default, rspack as "module.exports" };
+export { rspack as default, rspack as "module.exports" };

package/dist/src-Dwv4ealK.js

@@ -0,0 +1,57 @@
+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"
+					};
+				}
+			});
+		} }
+	};
+});
+
+//#endregion
+export { unplugin };

package/dist/vite.d.ts

@@ -1,4 +1,5 @@
-import { unplugin } from "./index-CbkvuMB_.js";
+import "./options-DupdgTT1.js";
+import { unplugin } from "./index-BMXQlGcW.js";
 
 //#region src/vite.d.ts
 

package/dist/vite.js

@@ -1,4 +1,5 @@
-import { src_default } from "./src-DE-h8IJW.js";
+import "./options-BTT0I76V.js";
+import { unplugin } from "./src-Dwv4ealK.js";
 
 //#region src/vite.ts
 /**
@@ -14,8 +15,7 @@ import { src_default } from "./src-DE-h8IJW.js";
 * })
 * ```
 */
-const vite = src_default.vite;
-var vite_default = vite;
+const vite = unplugin.vite;
 
 //#endregion
-export { vite_default as default, vite as "module.exports" };
+export { vite as default, vite as "module.exports" };

package/dist/webpack.d.ts

@@ -1,4 +1,5 @@
-import { unplugin } from "./index-CbkvuMB_.js";
+import "./options-DupdgTT1.js";
+import { unplugin } from "./index-BMXQlGcW.js";
 
 //#region src/webpack.d.ts
 

package/dist/webpack.js

@@ -1,4 +1,5 @@
-import { src_default } from "./src-DE-h8IJW.js";
+import "./options-BTT0I76V.js";
+import { unplugin } from "./src-Dwv4ealK.js";
 
 //#region src/webpack.ts
 /**
@@ -12,8 +13,7 @@ import { src_default } from "./src-DE-h8IJW.js";
 * }
 * ```
 */
-const webpack = src_default.webpack;
-var webpack_default = webpack;
+const webpack = unplugin.webpack;
 
 //#endregion
-export { webpack_default as default, webpack as "module.exports" };
+export { webpack as default, webpack as "module.exports" };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unplugin-raw",
-  "version": "0.5.1",
+  "version": "0.6.1",
   "description": "Transform file to a default-export string.",
   "type": "module",
   "keywords": [
@@ -19,7 +19,7 @@
     "type": "git",
     "url": "git+https://github.com/unplugin/unplugin-raw.git"
   },
-  "author": "三咲智子 Kevin Deng <sxzz@sxzz.moe>",
+  "author": "Kevin Deng <sxzz@sxzz.moe>",
   "funding": "https://github.com/sponsors/sxzz",
   "files": [
     "dist"
@@ -29,13 +29,14 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": "./dist/index.js",
+    "./api": "./dist/api.js",
+    "./esbuild": "./dist/esbuild.js",
+    "./rolldown": "./dist/rolldown.js",
+    "./rollup": "./dist/rollup.js",
+    "./rspack": "./dist/rspack.js",
     "./vite": "./dist/vite.js",
     "./webpack": "./dist/webpack.js",
-    "./rspack": "./dist/rspack.js",
-    "./rollup": "./dist/rollup.js",
-    "./rolldown": "./dist/rolldown.js",
-    "./esbuild": "./dist/esbuild.js",
-    "./*": "./*"
+    "./package.json": "./package.json"
   },
   "typesVersions": {
     "*": {
@@ -48,23 +49,30 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "esbuild": ">=0.25.0"
+  },
+  "peerDependenciesMeta": {
+    "esbuild": {
+      "optional": true
+    }
+  },
   "dependencies": {
-    "esbuild": "^0.25.8",
     "unplugin": "^2.3.5",
-    "unplugin-utils": "^0.2.4"
+    "unplugin-utils": "^0.2.5"
   },
   "devDependencies": {
     "@sxzz/eslint-config": "^7.1.2",
     "@sxzz/prettier-config": "^2.2.3",
-    "@types/node": "^24.1.0",
-    "bumpp": "^10.2.2",
-    "eslint": "^9.32.0",
+    "@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.13.2",
-    "tsx": "^4.20.3",
+    "tsdown": "^0.14.1",
     "typescript": "^5.9.2",
-    "vite": "^7.0.6",
+    "vite": "^7.1.2",
     "vitest": "^3.2.4"
   },
   "engines": {
@@ -78,6 +86,6 @@
     "dev": "tsdown --watch",
     "test": "vitest",
     "typecheck": "tsc --noEmit",
-    "release": "bumpp && pnpm publish"
+    "release": "bumpp"
   }
 }

package/dist/index-CbkvuMB_.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, unplugin };

package/dist/src-DE-h8IJW.js

@@ -1,105 +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: [
-			"rollup",
-			"rolldown",
-			"vite"
-		].includes(meta.framework) ? async function(id, importer, opt) {
-			const attributeType = opt?.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, transformFilter, false, options.transform.options, transform);
-				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, transformFilter, isBytes, options.transform.options, build.esbuild.transform);
-					return {
-						contents,
-						loader: typeof contents === "string" ? "js" : "binary"
-					};
-				}
-			});
-		} }
-	};
-});
-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";
-}
-async function transformRaw(file, transformFilter, isBytes, options, transform) {
-	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)}`;
-}
-
-//#endregion
-export { guessLoader, src_default };