vite-userscript-plugin 2.1.0 → 2.1.1

package/README.md

@@ -83,7 +83,7 @@ Details: [types/README.md](./types/README.md).
 
 `vite` prints `/{fileName}.dev.user.js` — install that URL once. HMR covers code and styles.
 
-`server.file: true` skips HMR. The same `vite` watch-builds `{fileName}.js` (headerless IIFE) and `{fileName}.proxy.user.js` with `@require file://` to that IIFE. Install the printed `/{fileName}.proxy.user.js` URL. See [examples/serve-file](./examples/serve-file).
+`server.file: true` skips HMR. The same `vite` watch-builds `{fileName}.user.js` (headed IIFE), `{fileName}.js`, and `{fileName}.proxy.user.js` (`@require file://` to the IIFE). Install the printed `/{fileName}.user.js` URL (Firefox-safe). The `Proxy` line is for managers that can poll `file://`. See [examples/serve-file](./examples/serve-file).
 
 > [!IMPORTANT]
 > Changing `@match`, `@grant`, or `@name` needs a reinstall.
@@ -135,9 +135,9 @@ See [examples/sourcemap](./examples/sourcemap).
 | `entry` | — | Userscript entry. Required. |
 | `header` | — | Metablock. Required: `name`, `version`, `match`. |
 | `fileName` | sanitized `header.name` | Output base name (`{fileName}.user.js`). |
-| `server.open` | `false` | Open the install target when Vite starts. HMR: `.dev.user.js`. `file`: `.proxy.user.js` URL. |
+| `server.open` | `false` | Open the install target when Vite starts. HMR: `.dev.user.js`. `file`: `.user.js` URL. |
 | `server.prefix` | `'server:'` | Prefix for `@name` in serve mode. `false` disables it. |
-| `server.file` | `false` | Watch-build `{fileName}.js` + `{fileName}.proxy.user.js` (`@require file://`). Install from the printed URL. No HMR. |
+| `server.file` | `false` | Watch-build `{fileName}.user.js` + `{fileName}.js` + `{fileName}.proxy.user.js`. Install `.user.js` (or the proxy if `file://` `@require` works). No HMR. |
 | `cssInject` | `'auto'` | How production CSS is injected. `'auto'` uses `GM_addStyle` or a `<style>` node. |
 | `align` | `1` | Extra spaces after the longest `@key`. `false` — one space. |
 | `generate` | — | Rewrite the generated metablock. |
@@ -161,7 +161,7 @@ In serve mode the header lists every grant. In production the plugin scans the b
 | [svelte](./examples/svelte) | SFC `<style>`. |
 | [multiple-entries](./examples/multiple-entries) | Two scripts. |
 | [sourcemap](./examples/sourcemap) | Inline map, HTML page, virtual module. |
-| [serve-file](./examples/serve-file) | `server.file`, install the proxy from the printed URL. |
+| [serve-file](./examples/serve-file) | `server.file`, install `.user.js` or the proxy from the printed URLs. |
 
 ## FAQ
 
@@ -190,7 +190,7 @@ In serve mode the header lists every grant. In production the plugin scans the b
 ### `file://` `@require` is blocked
 
 > [!NOTE]
-> Tampermonkey must allow local file access (`@require` from `file://`). Violentmonkey polls the required file after you install `{fileName}.proxy.user.js` from the printed URL. HTTP `@require` and page auto-reload are not part of this mode.
+> Firefox extensions cannot read `file://`. Install the printed `{fileName}.user.js` URL instead of the proxy. Tampermonkey on Chromium must allow local file access for the proxy `@require`. Violentmonkey can poll the local IIFE after you install the proxy.
 
 ## Migration from v1
 

package/dist/index.d.ts

@@ -147,7 +147,7 @@ type HeaderConfig = {
 interface ServerConfig {
   /**
    * Open the install target when Vite starts.
-   * HMR: `.dev.user.js` URL. `file`: `{fileName}.proxy.user.js` URL.
+   * HMR: `.dev.user.js` URL. `file`: `{fileName}.user.js` URL.
    *
    * @default false
    */
@@ -160,9 +160,9 @@ interface ServerConfig {
    */
   prefix?: string | false;
   /**
-   * Watch-build into `outDir`: headerless `{fileName}.js` and `{fileName}.proxy.user.js`
-   * with `@require file://` pointing at the IIFE.
-   * Install the proxy from the printed `/{fileName}.proxy.user.js` URL. No HMR for this script.
+   * Watch-build into `outDir`: `{fileName}.user.js`, headerless `{fileName}.js`,
+   * and `{fileName}.proxy.user.js` with `@require file://` pointing at the IIFE.
+   * Install `/{fileName}.user.js` (Firefox-safe) or the proxy URL. No HMR for this script.
    *
    * @default false
    */

package/dist/index.js

@@ -2,7 +2,7 @@ import { basename, posix, relative, resolve, sep } from "node:path";
 import { build } from "vite";
 import { Buffer } from "node:buffer";
 import { pathToFileURL } from "node:url";
-import { existsSync } from "node:fs";
+import { existsSync, readFileSync } from "node:fs";
 import { styleText } from "node:util";
 import openLink from "open";
 //#region src/names.ts
@@ -406,6 +406,28 @@ function withSourceMaps(fileNames) {
 function findScriptForChunk(chunk, fileName, scripts) {
 	return scripts.find((script) => chunk.name === script.fileName || fileName === `${script.fileName}.js` || fileName === `${script.fileName}.user.js`);
 }
+function createHeadedUserscript(script, options) {
+	const headerConfig = withBuildGrants(script.header, options.wrapped, options.extraGrants);
+	const prefix = `${generateHeader(headerConfig, {
+		align: script.align,
+		autoMetaUrls: script.autoMetaUrls,
+		fileName: script.fileName,
+		generate: script.generate,
+		mode: "build"
+	})}\n\n`;
+	const nextFileName = `${script.fileName}.user.js`;
+	let nextCode = `${prefix}${options.code}`;
+	if (options.map) {
+		const wrapOffset = isAlreadyIife(stripSourceMappingUrl(options.body)) ? 0 : 1;
+		const lineOffset = countHeaderLines(prefix) + countHeaderLines(options.cssPrelude) + wrapOffset + countHeaderLines(options.inlined);
+		const map = stripVendorSourcesContent(offsetSourceMap(options.map, lineOffset, nextFileName));
+		nextCode = `${stripSourceMappingUrl(nextCode).replace(/\n+$/g, "\n")}//# sourceMappingURL=${toInlineSourceMappingUrl(map)}\n`;
+	}
+	return {
+		headerConfig,
+		code: nextCode.endsWith("\n") ? nextCode : `${nextCode}\n`
+	};
+}
 function deleteBundleFiles(bundle, fileNames) {
 	for (const fileName of fileNames) delete bundle[fileName];
 }
@@ -442,6 +464,15 @@ function applyUserscriptBundle(bundle, config, context) {
 		const code = `${cssPrelude}${wrapped}`;
 		const emitFileProxy = Boolean(context.emitProxy && context.outDir && script.server.file);
 		leftoverAssets.push(`${fileName}.map`);
+		const headed = createHeadedUserscript(script, {
+			body,
+			code,
+			cssPrelude,
+			extraGrants,
+			inlined,
+			map: chunk.map,
+			wrapped
+		});
 		if (emitFileProxy) {
 			const requireName = toRequireFileName(script.fileName);
 			let nextCode = code.endsWith("\n") ? code : `${code}\n`;
@@ -454,27 +485,12 @@ function applyUserscriptBundle(bundle, config, context) {
 			chunk.code = nextCode;
 			chunk.fileName = requireName;
 			emitFile(toProxyFileName(script.fileName), `${generateWatchProxy(script, resolve(context.outDir, requireName))}\n`);
+			emitFile(`${script.fileName}.user.js`, headed.code);
 			continue;
 		}
-		const headerConfig = withBuildGrants(script.header, wrapped, extraGrants);
-		const prefix = `${generateHeader(headerConfig, {
-			align: script.align,
-			autoMetaUrls: script.autoMetaUrls,
-			fileName: script.fileName,
-			generate: script.generate,
-			mode: "build"
-		})}\n\n`;
-		const nextFileName = `${script.fileName}.user.js`;
-		let nextCode = `${prefix}${code}`;
-		if (chunk.map) {
-			const wrapOffset = isAlreadyIife(stripSourceMappingUrl(body)) ? 0 : 1;
-			const lineOffset = countHeaderLines(prefix) + countHeaderLines(cssPrelude) + wrapOffset + countHeaderLines(inlined);
-			chunk.map = stripVendorSourcesContent(offsetSourceMap(chunk.map, lineOffset, nextFileName));
-			nextCode = `${stripSourceMappingUrl(nextCode).replace(/\n+$/g, "\n")}//# sourceMappingURL=${toInlineSourceMappingUrl(chunk.map)}\n`;
-		}
-		chunk.code = nextCode;
-		chunk.fileName = nextFileName;
-		if (script.metaFile) emitFile(`${script.fileName}.meta.js`, generateHeader(headerConfig, {
+		chunk.code = headed.code;
+		chunk.fileName = `${script.fileName}.user.js`;
+		if (script.metaFile) emitFile(`${script.fileName}.meta.js`, generateHeader(headed.headerConfig, {
 			align: script.align,
 			autoMetaUrls: script.autoMetaUrls,
 			fileName: script.fileName,
@@ -495,7 +511,7 @@ function createClientSnapshot(scripts, command) {
 	return scripts.map((script) => {
 		let suffix = ".dev.user.js";
 		if (command === "build") suffix = ".user.js";
-		else if (script.server.file) suffix = ".proxy.user.js";
+		else if (script.server.file) suffix = ".user.js";
 		return {
 			name: script.header.name,
 			version: script.header.version,
@@ -648,9 +664,10 @@ function shimModule(code, id) {
 }
 //#endregion
 //#region src/serve/logger.ts
-function formatInstallLine(installUrl) {
+function formatInstallLine(installUrl, label = "Userscript") {
 	const coloredUrl = styleText("cyan", installUrl.replace(/:(\d+)\//, (_match, port) => `:${styleText("bold", port)}/`));
-	return `  ${styleText("green", "➜")}  ${styleText("bold", "Userscript")}: ${coloredUrl}`;
+	const padded = label.padEnd(10);
+	return `  ${styleText("green", "➜")}  ${styleText("bold", padded)}: ${coloredUrl}`;
 }
 function formatRebuildLine(elapsedMs) {
 	return `${styleText("green", "Userscript rebuilt")} ${styleText("dim", `(${elapsedMs}ms)`)}`;
@@ -720,9 +737,16 @@ function matchDevUserscript(url, fileName) {
 function matchProxyUserscript(url, fileName) {
 	return (url.split("?")[0] ?? "") === `/${toProxyFileName(fileName)}`;
 }
-function toInstallUrl(origin, fileName, file = false) {
-	const name = file ? toProxyFileName(fileName) : `${fileName}.dev.user.js`;
-	return `${origin.replace(/\/$/, "")}/${name}`;
+function matchFileUserscript(url, fileName) {
+	return (url.split("?")[0] ?? "") === `/${fileName}.user.js`;
+}
+function toInstallUrl(origin, fileName, kind = "dev") {
+	const names = {
+		dev: `${fileName}.dev.user.js`,
+		proxy: toProxyFileName(fileName),
+		user: `${fileName}.user.js`
+	};
+	return `${origin.replace(/\/$/, "")}/${names[kind]}`;
 }
 function toServeEntryPath(root, entry) {
 	const absolute = resolve(root, entry);
@@ -779,6 +803,9 @@ function findDevScript(url, scripts) {
 function findProxyScript(url, scripts) {
 	return scripts.find((script) => script.server.file && matchProxyUserscript(url, script.fileName));
 }
+function findFileUserscript(url, scripts) {
+	return scripts.find((script) => script.server.file && matchFileUserscript(url, script.fileName));
+}
 function createDevUserscript(options) {
 	return generateDevUserscript({
 		script: options.script,
@@ -824,6 +851,17 @@ function configureDevServer(server, resolved, reactPreamble) {
 			writeScript(res, createReactBootstrapModule(entry));
 			return;
 		}
+		const fileScript = findFileUserscript(url, resolved.scripts);
+		if (fileScript) {
+			const userJsPath = resolve(server.config.root, server.config.build.outDir, `${fileScript.fileName}.user.js`);
+			try {
+				writeScript(res, readFileSync(userJsPath, "utf8"));
+			} catch {
+				res.statusCode = 404;
+				res.end();
+			}
+			return;
+		}
 		const proxyScript = findProxyScript(url, resolved.scripts);
 		if (proxyScript) {
 			writeScript(res, `${generateWatchProxy(proxyScript, resolve(server.config.root, server.config.build.outDir, toRequireFileName(proxyScript.fileName)))}\n`);
@@ -848,7 +886,14 @@ function configureDevServer(server, resolved, reactPreamble) {
 		let origins = [];
 		if (urls) origins = urls.local.length ? urls.local : urls.network;
 		const printInstall = () => {
-			for (const origin of origins) for (const script of resolved.scripts) info(formatInstallLine(toInstallUrl(origin, script.fileName, script.server.file)));
+			for (const origin of origins) for (const script of resolved.scripts) {
+				if (script.server.file) {
+					info(formatInstallLine(toInstallUrl(origin, script.fileName, "user")));
+					info(formatInstallLine(toInstallUrl(origin, script.fileName, "proxy"), "Proxy"));
+					continue;
+				}
+				info(formatInstallLine(toInstallUrl(origin, script.fileName)));
+			}
 			info(formatFaqHint());
 		};
 		const logger = createAfterLocalLogger(info, urls?.local.length ?? 0, printInstall);
@@ -866,7 +911,7 @@ function configureDevServer(server, resolved, reactPreamble) {
 		if (!toOpen.length) return;
 		queueMicrotask(() => {
 			const origin = resolveServerOrigin(server.resolvedUrls);
-			for (const script of toOpen) openLink(toInstallUrl(origin, script.fileName, script.server.file));
+			for (const script of toOpen) openLink(toInstallUrl(origin, script.fileName, script.server.file ? "user" : "dev"));
 		});
 	});
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vite-userscript-plugin",
   "type": "module",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "author": {
     "name": "Vitalij Ryndin",
     "url": "https://github.com/crashmax-dev"