vite-userscript-plugin 2.2.0 → 2.3.1

package/README.md

@@ -133,9 +133,9 @@ See [examples/sourcemap](./examples/sourcemap).
 | Option | Default | Description |
 | --- | --- | --- |
 | `entry` | — | Userscript entry. Required. |
-| `header` | — | Metablock. Required: `name`, `version`, `match`. Relative `icon` / `require` / `resource` / `supportURL` / `updateURL` / `downloadURL` join `homepage` (`homepageURL` / `website` / `source`). Absolute `http(s):` URLs stay as-is. |
+| `header` | — | Metablock. Required: `name`, `version`, `match`. Relative `icon` / `require` / `resource` / `supportURL` / `updateURL` / `downloadURL` join `homepage` (`homepageURL` / `website` / `source`). Absolute `http(s):` URLs stay as-is. `updateURL` / `downloadURL` of `none` disable updates and are not joined. |
 | `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`: `.user.js` URL. |
+| `server.open` | `false` | Open the install target when Vite starts (`true`, `'user'`, `'proxy'`). HMR: `.dev.user.js`. `file`: `.user.js` or `.proxy.user.js`. Vite opens one URL. |
 | `server.prefix` | `'server:'` | Prefix for `@name` in serve mode. `false` disables it. |
 | `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. |
 | `headerAlign` | `1` | Extra spaces after the longest `@key`. `false` — one space. |

package/dist/index.d.ts

@@ -63,18 +63,33 @@ type HeaderConfig = {
    */
   'author'?: string;
   /**
+   * Script homepage. Also the base for relative `icon`, `iconURL`,
+   * `defaulticon`, `icon64`, `icon64URL`, `require`, `resource`, `supportURL`,
+   * `updateURL`, and `downloadURL`. Absolute `http(s):` URLs stay as-is.
+   * `updateURL` / `downloadURL` of `none` are not joined.
+   *
+   * Fallback order: `homepage`, `homepageURL`, `website`, `source`.
+   *
    * @see https://www.tampermonkey.net/documentation.php#meta:homepage
    */
   'homepage'?: string;
   /**
+   * Alias of `homepage`. Used as the relative-URL base when `homepage` is empty.
+   *
    * @see https://www.tampermonkey.net/documentation.php#meta:homepage
    */
   'homepageURL'?: string;
   /**
+   * Alias of `homepage`. Used as the relative-URL base when `homepage` and
+   * `homepageURL` are empty.
+   *
    * @see https://www.tampermonkey.net/documentation.php#meta:homepage
    */
   'website'?: string;
   /**
+   * Alias of `homepage`. Used as the relative-URL base when `homepage`,
+   * `homepageURL`, and `website` are empty.
+   *
    * @see https://www.tampermonkey.net/documentation.php#meta:homepage
    */
   'source'?: string;
@@ -124,13 +139,17 @@ type HeaderConfig = {
    */
   'noframes'?: boolean;
   /**
+   * `none` disables update checks. It is not joined with homepage.
+   *
    * @see https://www.tampermonkey.net/documentation.php#meta:updateURL
    */
-  'updateURL'?: string;
+  'updateURL'?: 'none' | (string & {});
   /**
+   * `none` disables update checks (pinned / non-latest installs). It is not joined with homepage.
+   *
    * @see https://www.tampermonkey.net/documentation.php#meta:downloadURL
    */
-  'downloadURL'?: string;
+  'downloadURL'?: 'none' | (string & {});
   /**
    * @see https://www.tampermonkey.net/documentation.php#meta:supportURL
    */
@@ -144,14 +163,17 @@ type HeaderConfig = {
    */
   'unwrap'?: boolean;
 };
+type ServerOpen = boolean | 'user' | 'proxy';
+type ResolvedServerOpen = false | 'dev' | 'user' | 'proxy';
 interface ServerConfig {
   /**
    * Open the install target when Vite starts.
-   * HMR: `.dev.user.js` URL. `file`: `{fileName}.user.js` URL.
+   * `true`: HMR → `.dev.user.js`; `file` → `{fileName}.user.js`.
+   * `'user'` / `'proxy'`: file-mode install URL. Vite opens one path.
    *
    * @default false
    */
-  open?: boolean;
+  open?: ServerOpen;
   /**
    * Prefix applied to `@name` in serve mode.
    * Set `false` to disable.
@@ -229,7 +251,7 @@ interface ResolvedScript {
   iifeName: string;
   header: HeaderConfig;
   server: {
-    open: boolean;
+    open: ResolvedServerOpen;
     prefix: string | false;
     file: boolean;
   };
@@ -242,4 +264,4 @@ interface ResolvedScript {
 //#region src/plugin.d.ts
 declare function UserscriptPlugin(config: UserscriptPluginConfig): Plugin[];
 //#endregion
-export { type HeaderConfig, type HeaderGenerateContext, type ResolvedScript, type ServerConfig, type UserscriptConfig, type UserscriptPluginConfig, UserscriptPlugin as default };
+export { type HeaderConfig, type HeaderGenerateContext, type ResolvedScript, type ResolvedServerOpen, type ServerConfig, type ServerOpen, type UserscriptConfig, type UserscriptPluginConfig, UserscriptPlugin as default };

package/dist/index.js

@@ -4,7 +4,6 @@ import { Buffer } from "node:buffer";
 import { pathToFileURL } from "node:url";
 import { existsSync, readFileSync } from "node:fs";
 import { styleText } from "node:util";
-import openLink from "open";
 //#region src/grants/catalog.ts
 const GM = [
 	"setValue",
@@ -119,16 +118,17 @@ function resolveHomePage(header) {
 	const trimmed = homePage.trim();
 	return trimmed === "" ? void 0 : trimmed;
 }
-function isResolvableHeaderPath(value) {
+function isResolvableHeaderPath(value, field) {
 	const trimmed = value.trim();
 	if (!trimmed) return false;
+	if ((field === "updateURL" || field === "downloadURL") && trimmed.toLowerCase() === "none") return false;
 	if (ABSOLUTE_URL_RE.test(trimmed) || trimmed.startsWith("//") || trimmed.startsWith("/")) return false;
 	return true;
 }
-function containsResolvableHeaderPath(value) {
-	if (typeof value === "string") return isResolvableHeaderPath(value);
+function containsResolvableHeaderPath(value, field) {
+	if (typeof value === "string") return isResolvableHeaderPath(value, field);
 	if (!Array.isArray(value)) return false;
-	return value.some((item) => typeof item === "string" && isResolvableHeaderPath(item));
+	return value.some((item) => typeof item === "string" && isResolvableHeaderPath(item, field));
 }
 function containsResolvableResourcePath(resource) {
 	if (!Array.isArray(resource)) return false;
@@ -138,7 +138,7 @@ function containsResolvableResourcePath(resource) {
 }
 function listHomepageRelativeFields(header) {
 	const fields = [];
-	for (const key of HOMEPAGE_RELATIVE_FIELDS) if (containsResolvableHeaderPath(header[key])) fields.push(key);
+	for (const key of HOMEPAGE_RELATIVE_FIELDS) if (containsResolvableHeaderPath(header[key], key)) fields.push(key);
 	if (containsResolvableResourcePath(header.resource)) fields.push("resource");
 	return fields;
 }
@@ -149,12 +149,12 @@ function resolvePublicFileUrl(header, fileName) {
 		return new URL(fileName, ensureTrailingSlash(homePage)).href;
 	} catch {}
 }
-function resolveHeaderUrlValue(header, value) {
+function resolveHeaderUrlValue(header, value, field) {
 	if (typeof value === "string") {
-		if (!isResolvableHeaderPath(value)) return value;
+		if (!isResolvableHeaderPath(value, field)) return value;
 		return resolvePublicFileUrl(header, value.trim()) ?? value;
 	}
-	if (Array.isArray(value)) return value.map((item) => typeof item === "string" ? resolveHeaderUrlValue(header, item) : item);
+	if (Array.isArray(value)) return value.map((item) => typeof item === "string" ? resolveHeaderUrlValue(header, item, field) : item);
 	return value;
 }
 function resolveResourceUrls(header, resource) {
@@ -170,7 +170,7 @@ function resolveResourceUrls(header, resource) {
 function applyHomepageRelativeUrls(header) {
 	if (!resolveHomePage(header)) return header;
 	const next = { ...header };
-	for (const key of HOMEPAGE_RELATIVE_FIELDS) if (next[key] != null) Object.assign(next, { [key]: resolveHeaderUrlValue(next, next[key]) });
+	for (const key of HOMEPAGE_RELATIVE_FIELDS) if (next[key] != null) Object.assign(next, { [key]: resolveHeaderUrlValue(next, next[key], key) });
 	if (next.resource != null) next.resource = resolveResourceUrls(next, next.resource);
 	return next;
 }
@@ -639,19 +639,25 @@ function assertHeader(header, label) {
 		"match"
 	]) if (isEmptyHeaderField(header[field])) throw new Error(`[${PLUGIN_NAME}] ${label} is missing required header.${field}`);
 }
+function resolveServerOpen(open, file) {
+	if (!open) return false;
+	if (open === true) return file ? "user" : "dev";
+	return file ? open : "dev";
+}
 function toResolvedScript(config) {
 	if (!config.entry) throw new Error(`[${PLUGIN_NAME}] Provide an "entry" for each userscript`);
 	assertHeader(config.header ?? {}, config.entry);
 	const fileName = sanitizeFileName(config.fileName ?? config.header.name);
+	const file = config.server?.file ?? false;
 	return {
 		entry: config.entry,
 		fileName,
 		iifeName: toIdentifier(fileName),
 		header: config.header,
 		server: {
-			open: config.server?.open ?? false,
+			open: resolveServerOpen(config.server?.open, file),
 			prefix: config.server?.prefix ?? "server:",
-			file: config.server?.file ?? false
+			file
 		},
 		headerAlign: config.headerAlign ?? 1,
 		generate: config.generate,
@@ -678,8 +684,23 @@ function collectHomepageRelativeUrlWarnings(config) {
 	}
 	return warnings;
 }
-function collectConfigWarnings(config) {
-	return [...collectAutoMetaUrlsWarnings(config), ...collectHomepageRelativeUrlWarnings(config)];
+function collectServerOpenWarnings(config, input) {
+	const warnings = [];
+	const items = Array.isArray(input) ? input : [input];
+	for (const [index, script] of config.scripts.entries()) {
+		const open = items[index]?.server?.open;
+		if ((open === "user" || open === "proxy") && !script.server.file) warnings.push(`[${PLUGIN_NAME}] server.open: "${open}" requires server.file for "${script.fileName}" — opening .dev.user.js instead`);
+	}
+	const opened = config.scripts.filter((script) => script.server.open);
+	if (opened.length > 1) warnings.push(`[${PLUGIN_NAME}] server.open is set on multiple scripts; Vite opens only "${opened[0]?.fileName}"`);
+	return warnings;
+}
+function collectConfigWarnings(config, input) {
+	return [
+		...collectAutoMetaUrlsWarnings(config),
+		...collectHomepageRelativeUrlWarnings(config),
+		...collectServerOpenWarnings(config, input)
+	];
 }
 function resolvePluginConfig(config) {
 	const items = Array.isArray(config) ? config : [config];
@@ -717,16 +738,24 @@ function shimModule(code, id) {
 }
 //#endregion
 //#region src/serve/logger.ts
+const INSTALL_LABEL_WIDTH = 10;
+function colonPadFor(label) {
+	return " ".repeat(Math.max(0, INSTALL_LABEL_WIDTH - label.length) + 1);
+}
+function formatLabeledLine(label, value) {
+	return `  ${styleText("green", "➜")}  ${styleText("bold", label)}:${colonPadFor(label)}${value}`;
+}
+function alignViteUrlLine(message) {
+	return message.replace(/(Local(?:\u001B\[[0-9;]*m)*:)(\s+)/, (_match, prefix) => `${prefix}${colonPadFor("Local")}`);
+}
 function formatInstallLine(installUrl, label = "Userscript") {
-	const coloredUrl = styleText("cyan", installUrl.replace(/:(\d+)\//, (_match, port) => `:${styleText("bold", port)}/`));
-	const padded = label.padEnd(10);
-	return `  ${styleText("green", "➜")}  ${styleText("bold", padded)}: ${coloredUrl}`;
+	return formatLabeledLine(label, styleText("cyan", installUrl.replace(/:(\d+)\//, (_match, port) => `:${styleText("bold", port)}/`)));
 }
 function formatRebuildLine(elapsedMs) {
 	return `${styleText("green", "Userscript rebuilt")} ${styleText("dim", `(${elapsedMs}ms)`)}`;
 }
 function formatFaqHint() {
-	return `${`  ${styleText("green", "➜")}  ${styleText("bold", "FAQ")}: `}${styleText("cyan", FAQ_URL)}\n`;
+	return `${formatLabeledLine("FAQ", styleText("cyan", FAQ_URL))}\n`;
 }
 function stripAnsi(text) {
 	return text.replace(/\u001B\[[0-9;]*m/g, "");
@@ -744,7 +773,7 @@ function createAfterLocalLogger(info, localCount, onAfterLocal) {
 	};
 	return {
 		info: (msg, options) => {
-			info(msg, options);
+			info(typeof msg === "string" ? alignViteUrlLine(msg) : msg, options);
 			if (remaining > 0 && isViteLocalUrlLine(String(msg))) {
 				remaining -= 1;
 				if (remaining === 0) flush();
@@ -793,13 +822,18 @@ function matchProxyUserscript(url, fileName) {
 function matchFileUserscript(url, fileName) {
 	return (url.split("?")[0] ?? "") === `/${fileName}.user.js`;
 }
-function toInstallUrl(origin, fileName, kind = "dev") {
-	const names = {
+function toInstallFileName(fileName, kind) {
+	return {
 		dev: `${fileName}.dev.user.js`,
 		proxy: toProxyFileName(fileName),
 		user: `${fileName}.user.js`
-	};
-	return `${origin.replace(/\/$/, "")}/${names[kind]}`;
+	}[kind];
+}
+function toInstallPath(fileName, kind = "dev") {
+	return `/${toInstallFileName(fileName, kind)}`;
+}
+function toInstallUrl(origin, fileName, kind = "dev") {
+	return `${origin.replace(/\/$/, "")}${toInstallPath(fileName, kind)}`;
 }
 function toServeEntryPath(root, entry) {
 	const absolute = resolve(root, entry);
@@ -959,14 +993,6 @@ function configureDevServer(server, resolved, reactPreamble) {
 			logger.flush();
 		}
 	};
-	server.httpServer?.once("listening", () => {
-		const toOpen = resolved.scripts.filter((script) => script.server.open);
-		if (!toOpen.length) return;
-		queueMicrotask(() => {
-			const origin = resolveServerOrigin(server.resolvedUrls);
-			for (const script of toOpen) openLink(toInstallUrl(origin, script.fileName, script.server.file ? "user" : "dev"));
-		});
-	});
 }
 //#endregion
 //#region src/plugin.ts
@@ -1053,13 +1079,18 @@ function UserscriptPlugin(config) {
 				userConfig.build.rolldownOptions.input = input;
 				const userOutput = userConfig.build.rolldownOptions.output;
 				const userEntryFileNames = userOutput && !Array.isArray(userOutput) ? userOutput.entryFileNames : void 0;
+				const openScript = resolved.scripts.find((script) => script.server.open);
+				const openPath = openScript?.server.open ? toInstallPath(openScript.fileName, openScript.server.open) : void 0;
 				return {
 					appType: userConfig.appType ?? (hasHtml ? "spa" : "custom"),
 					optimizeDeps: {
 						entries: Object.values(input),
 						exclude: [VIRTUAL_MODULE_ID]
 					},
-					server: { cors: userConfig.server?.cors ?? true },
+					server: {
+						cors: userConfig.server?.cors ?? true,
+						...openPath ? { open: openPath } : {}
+					},
 					build: {
 						minify: userConfig.build?.minify ?? false,
 						assetsInlineLimit: userConfig.build?.assetsInlineLimit ?? Number.MAX_SAFE_INTEGER,
@@ -1082,7 +1113,7 @@ function UserscriptPlugin(config) {
 				command = viteConfig.command;
 				resolved = absolutizeEntries(resolved, viteConfig.root);
 				reactPreamble = hasReactRefreshPlugin(viteConfig.plugins);
-				for (const message of collectConfigWarnings(resolved)) viteConfig.logger.warn(message);
+				for (const message of collectConfigWarnings(resolved, config)) viteConfig.logger.warn(message);
 			}
 		},
 		{

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vite-userscript-plugin",
   "type": "module",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "author": {
     "name": "Vitalij Ryndin",
     "url": "https://github.com/crashmax-dev"
@@ -41,9 +41,6 @@
   "peerDependencies": {
     "vite": "^8.0.0"
   },
-  "dependencies": {
-    "open": "11.0.1"
-  },
   "devDependencies": {
     "@antfu/eslint-config": "7.2.0",
     "@sveltejs/vite-plugin-svelte": "7.3.0",
@@ -54,13 +51,13 @@
     "eslint": "9.39.2",
     "eslint-plugin-format": "2.0.1",
     "prettier-plugin-css-order": "2.2.0",
-    "svelte": "5.56.10",
+    "svelte": "5.57.0",
     "tsdown": "0.22.14",
-    "turbo": "2.10.11",
+    "turbo": "2.10.12",
     "typescript": "npm:@typescript/typescript6@6.0.2",
     "vite": "8.2.2",
     "vitest": "4.1.11",
-    "vue": "3.5.41"
+    "vue": "3.5.42"
   },
   "scripts": {
     "dev": "tsdown --watch",