vite-userscript-plugin 2.1.1 → 2.2.0

package/README.md

@@ -133,13 +133,12 @@ See [examples/sourcemap](./examples/sourcemap).
 | Option | Default | Description |
 | --- | --- | --- |
 | `entry` | — | Userscript entry. Required. |
-| `header` | — | Metablock. Required: `name`, `version`, `match`. |
+| `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. |
 | `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.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. |
-| `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. |
+| `headerAlign` | `1` | Extra spaces after the longest `@key`. `false` — one space. |
 | `generate` | — | Rewrite the generated metablock. |
 | `autoMetaUrls` | `false` | Fill empty `updateURL` / `downloadURL` from `homepage` / `homepageURL` / `website` / `source`. |
 | `metaFile` | `true` | Emit `{fileName}.meta.js`. |
@@ -181,6 +180,8 @@ In serve mode the header lists every grant. In production the plugin scans the b
 
 > [!NOTE]
 > Userscripts run on someone else’s origin. Import the file so Vite inlines it. `public/` only works for the `index.html` app on the Vite origin.
+>
+> `@icon`, `@require`, and `@resource` are different: the manager fetches them from the metablock URL, not from the `match` site. Write `icon: 'greasify.svg'` plus `homepage` (GitHub Pages, etc.) — the plugin joins them. Leave `https://…` as-is.
 
 ### `@run-at document-start` feels late in dev
 
@@ -204,6 +205,8 @@ In serve mode the header lists every grant. In production the plugin scans the b
 | Vite 3–7 | Vite 8 |
 | `scripts` + shared `header` | `userscript([config, config, …])` |
 | `ScriptOptions` | removed |
+| `cssInject` | removed; imported CSS always appends a `<style>` node |
+| `align` | `headerAlign` |
 
 ## License
 

package/dist/index.d.ts

@@ -173,7 +173,6 @@ interface HeaderGenerateContext {
   userscript: string;
   mode: HeaderMode;
 }
-type CssInject = 'auto' | string | ((css: string) => void);
 /**
  * One userscript. Pass an object, or an array of these, to {@link UserscriptPluginConfig}.
  */
@@ -196,18 +195,12 @@ interface UserscriptConfig {
    * Serve-mode options.
    */
   server?: ServerConfig;
-  /**
-   * How to inject collected CSS in production builds.
-   *
-   * @default 'auto'
-   */
-  cssInject?: CssInject;
   /**
    * Extra spaces after the longest `@key`, or `false` for a single space.
    *
    * @default 1
    */
-  align?: number | false;
+  headerAlign?: number | false;
   /**
    * Rewrite the generated metablock.
    */
@@ -240,32 +233,13 @@ interface ResolvedScript {
     prefix: string | false;
     file: boolean;
   };
-  cssInject: CssInject;
-  align: number | false;
+  headerAlign: number | false;
   generate?: (ctx: HeaderGenerateContext) => string;
   autoMetaUrls: boolean;
   metaFile: boolean;
 }
 //#endregion
-//#region src/header.d.ts
-interface HeaderOptions {
-  align?: number | false;
-  autoMetaUrls?: boolean;
-  fileName?: string;
-  generate?: (ctx: HeaderGenerateContext) => string;
-  mode?: HeaderMode;
-}
-declare function resolveHomePage(header: HeaderConfig): string | undefined;
-declare function resolvePublicFileUrl(header: HeaderConfig, fileName: string): string | undefined;
-declare function generateHeader(config: HeaderConfig, options?: HeaderOptions): string;
-declare class Header {
-  private readonly config;
-  private readonly options;
-  constructor(config: HeaderConfig, options?: HeaderOptions);
-  generate(): string;
-}
-//#endregion
 //#region src/plugin.d.ts
 declare function UserscriptPlugin(config: UserscriptPluginConfig): Plugin[];
 //#endregion
-export { type CssInject, Header, type HeaderConfig, type HeaderGenerateContext, type ResolvedScript, type ServerConfig, type UserscriptConfig, type UserscriptPluginConfig, UserscriptPlugin as default, generateHeader, resolveHomePage, resolvePublicFileUrl };
+export { type HeaderConfig, type HeaderGenerateContext, type ResolvedScript, type ServerConfig, type UserscriptConfig, type UserscriptPluginConfig, UserscriptPlugin as default };

package/dist/index.js

@@ -5,6 +5,88 @@ 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",
+	"getValue",
+	"deleteValue",
+	"listValues",
+	"setValues",
+	"getValues",
+	"deleteValues",
+	"setClipboard",
+	"addStyle",
+	"addElement",
+	"addValueChangeListener",
+	"removeValueChangeListener",
+	"registerMenuCommand",
+	"unregisterMenuCommand",
+	"download",
+	"getTab",
+	"getTabs",
+	"saveTab",
+	"openInTab",
+	"notification",
+	"getResourceURL",
+	"getResourceText",
+	"xmlhttpRequest",
+	"webRequest",
+	"cookie",
+	"audio",
+	"log",
+	"info"
+];
+const GMwindow = [
+	"unsafeWindow",
+	"window.onurlchange",
+	"window.focus",
+	"window.close"
+];
+const GM_DOT_ALIASES = ["GM.xmlHttpRequest", "GM.getResourceUrl"];
+const grants = [
+	...GM.flatMap((grant) => [`GM_${grant}`, `GM.${grant}`]),
+	...GMwindow,
+	...GM_DOT_ALIASES
+];
+const gmIdentifiers = [
+	"GM",
+	"unsafeWindow",
+	...GM.map((grant) => `GM_${grant}`)
+];
+//#endregion
+//#region src/grants/scan.ts
+const grantMatchers = grants.map((grant) => ({
+	grant,
+	pattern: new RegExp(`\\b${grant.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}\\b`)
+}));
+function removeDuplicates(arr) {
+	if (Array.isArray(arr)) return [...new Set(arr)];
+	return arr ? [arr] : [];
+}
+function defineGrants(code) {
+	return grantMatchers.filter(({ pattern }) => pattern.test(code)).map(({ grant }) => grant);
+}
+//#endregion
+//#region src/grants/policy.ts
+function withServeGrants(header) {
+	if (header.grant === "none") return header;
+	return {
+		...header,
+		grant: [.../* @__PURE__ */ new Set([...header.grant ?? [], ...grants])]
+	};
+}
+function withBuildGrants(header, code, extraGrants = []) {
+	if (header.grant === "none") return header;
+	return {
+		...header,
+		grant: removeDuplicates([
+			...defineGrants(code),
+			...removeDuplicates(header.grant),
+			...extraGrants
+		])
+	};
+}
+//#endregion
 //#region src/names.ts
 function sanitizeFileName(name) {
 	return name.replace(/[<>:"/\\|?*\u0000-\u001F]+/g, "-").replace(/\s+/g, "-").replace(/-+/g, "-").replace(/^-|-$/g, "") || "userscript";
@@ -16,6 +98,18 @@ function toIdentifier(name) {
 }
 //#endregion
 //#region src/header.ts
+const ABSOLUTE_URL_RE = /^[a-z][a-z0-9+.-]*:/i;
+const HOMEPAGE_RELATIVE_FIELDS = [
+	"icon",
+	"iconURL",
+	"defaulticon",
+	"icon64",
+	"icon64URL",
+	"require",
+	"supportURL",
+	"updateURL",
+	"downloadURL"
+];
 function ensureTrailingSlash(url) {
 	return url.endsWith("/") ? url : `${url}/`;
 }
@@ -25,6 +119,29 @@ function resolveHomePage(header) {
 	const trimmed = homePage.trim();
 	return trimmed === "" ? void 0 : trimmed;
 }
+function isResolvableHeaderPath(value) {
+	const trimmed = value.trim();
+	if (!trimmed) 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);
+	if (!Array.isArray(value)) return false;
+	return value.some((item) => typeof item === "string" && isResolvableHeaderPath(item));
+}
+function containsResolvableResourcePath(resource) {
+	if (!Array.isArray(resource)) return false;
+	return resource.some((item) => {
+		return Array.isArray(item) && typeof item[1] === "string" && isResolvableHeaderPath(item[1]);
+	});
+}
+function listHomepageRelativeFields(header) {
+	const fields = [];
+	for (const key of HOMEPAGE_RELATIVE_FIELDS) if (containsResolvableHeaderPath(header[key])) fields.push(key);
+	if (containsResolvableResourcePath(header.resource)) fields.push("resource");
+	return fields;
+}
 function resolvePublicFileUrl(header, fileName) {
 	const homePage = resolveHomePage(header);
 	if (!homePage) return;
@@ -32,6 +149,31 @@ function resolvePublicFileUrl(header, fileName) {
 		return new URL(fileName, ensureTrailingSlash(homePage)).href;
 	} catch {}
 }
+function resolveHeaderUrlValue(header, value) {
+	if (typeof value === "string") {
+		if (!isResolvableHeaderPath(value)) return value;
+		return resolvePublicFileUrl(header, value.trim()) ?? value;
+	}
+	if (Array.isArray(value)) return value.map((item) => typeof item === "string" ? resolveHeaderUrlValue(header, item) : item);
+	return value;
+}
+function resolveResourceUrls(header, resource) {
+	if (!Array.isArray(resource)) return resource;
+	return resource.map((item) => {
+		if (!Array.isArray(item) || typeof item[1] !== "string") return item;
+		const [key, url] = item;
+		if (!isResolvableHeaderPath(url)) return item;
+		const resolved = resolvePublicFileUrl(header, url.trim());
+		return resolved ? [key, resolved] : item;
+	});
+}
+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]) });
+	if (next.resource != null) next.resource = resolveResourceUrls(next, next.resource);
+	return next;
+}
 function applyAutoMetaUrls(header, fileName) {
 	const updateURL = header.updateURL ?? resolvePublicFileUrl(header, `${fileName}.meta.js`);
 	const downloadURL = header.downloadURL ?? resolvePublicFileUrl(header, `${fileName}.user.js`);
@@ -53,7 +195,8 @@ function formatValue(value) {
 }
 function generateHeader(config, options = {}) {
 	const fileName = options.fileName ?? sanitizeFileName(config.name);
-	const header = options.autoMetaUrls ? applyAutoMetaUrls({ ...config }, fileName) : { ...config };
+	const withRelativeUrls = applyHomepageRelativeUrls({ ...config });
+	const header = options.autoMetaUrls ? applyAutoMetaUrls(withRelativeUrls, fileName) : withRelativeUrls;
 	const keys = Object.keys(header).filter((key) => {
 		const value = header[key];
 		return value !== void 0 && value !== null && value !== false;
@@ -88,99 +231,6 @@ function generateHeader(config, options = {}) {
 		mode: options.mode ?? "build"
 	});
 }
-var Header = class {
-	config;
-	options;
-	constructor(config, options = {}) {
-		this.config = config;
-		this.options = options;
-	}
-	generate() {
-		return generateHeader(this.config, this.options);
-	}
-};
-//#endregion
-//#region src/grants/catalog.ts
-const GM = [
-	"setValue",
-	"getValue",
-	"deleteValue",
-	"listValues",
-	"setValues",
-	"getValues",
-	"deleteValues",
-	"setClipboard",
-	"addStyle",
-	"addElement",
-	"addValueChangeListener",
-	"removeValueChangeListener",
-	"registerMenuCommand",
-	"unregisterMenuCommand",
-	"download",
-	"getTab",
-	"getTabs",
-	"saveTab",
-	"openInTab",
-	"notification",
-	"getResourceURL",
-	"getResourceText",
-	"xmlhttpRequest",
-	"webRequest",
-	"cookie",
-	"audio",
-	"log",
-	"info"
-];
-const GMwindow = [
-	"unsafeWindow",
-	"window.onurlchange",
-	"window.focus",
-	"window.close"
-];
-const GM_DOT_ALIASES = ["GM.xmlHttpRequest", "GM.getResourceUrl"];
-const grants = [
-	...GM.flatMap((grant) => [`GM_${grant}`, `GM.${grant}`]),
-	...GMwindow,
-	...GM_DOT_ALIASES
-];
-const gmIdentifiers = [
-	"GM",
-	"unsafeWindow",
-	...GM.map((grant) => `GM_${grant}`)
-];
-//#endregion
-//#region src/grants/scan.ts
-const grantMatchers = grants.map((grant) => ({
-	grant,
-	pattern: new RegExp(`\\b${grant.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}\\b`)
-}));
-function removeDuplicates(arr) {
-	if (Array.isArray(arr)) return [...new Set(arr)];
-	return arr ? [arr] : [];
-}
-function defineGrants(code) {
-	return grantMatchers.filter(({ pattern }) => pattern.test(code)).map(({ grant }) => grant);
-}
-//#endregion
-//#region src/grants/policy.ts
-function withServeGrants(header) {
-	if (header.grant === "none") return header;
-	return {
-		...header,
-		grant: [.../* @__PURE__ */ new Set([...header.grant ?? [], ...grants])]
-	};
-}
-function withBuildGrants(header, code, extraGrants = []) {
-	if (header.grant === "none") return header;
-	return {
-		...header,
-		grant: removeDuplicates([
-			...defineGrants(code),
-			...removeDuplicates(header.grant),
-			...extraGrants
-		])
-	};
-}
 //#endregion
 //#region src/sourcemap.ts
 function countHeaderLines(prefix) {
@@ -264,13 +314,9 @@ function isAsset(item) {
 //#endregion
 //#region src/build/css.ts
 const defaultCssInjector = `(function (css) {
-  if (typeof GM_addStyle === 'function') {
-    GM_addStyle(css)
-  } else {
-    var style = document.createElement('style')
-    style.textContent = css
-    ;(document.head || document.documentElement).appendChild(style)
-  }
+  var style = document.createElement('style')
+  style.textContent = css
+  ;(document.head || document.documentElement).appendChild(style)
 })`;
 function collectImportedCss(chunk, bundle, seen = /* @__PURE__ */ new Set()) {
 	const files = [...chunk.viteMetadata?.importedCss ?? []];
@@ -297,11 +343,8 @@ function collectCss(chunk, bundle) {
 		files
 	};
 }
-function createCssInject(css, cssInject = "auto") {
-	const payload = JSON.stringify(css);
-	if (cssInject === "auto") return `${defaultCssInjector}(${payload});\n`;
-	if (typeof cssInject === "function") return `(${cssInject.toString()})(${payload});\n`;
-	return `(${cssInject})(${payload});\n`;
+function createCssInject(css) {
+	return `${defaultCssInjector}(${JSON.stringify(css)});\n`;
 }
 //#endregion
 //#region src/build/iife.ts
@@ -345,7 +388,7 @@ function createWatchProxyHeader(script, jsAbsPath) {
 }
 function generateWatchProxy(script, jsAbsPath) {
 	return generateHeader(createWatchProxyHeader(script, jsAbsPath), {
-		align: script.align,
+		align: script.headerAlign,
 		autoMetaUrls: false,
 		fileName: script.fileName,
 		generate: script.generate,
@@ -407,9 +450,9 @@ 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 headerConfig = withBuildGrants(script.header, options.wrapped);
 	const prefix = `${generateHeader(headerConfig, {
-		align: script.align,
+		align: script.headerAlign,
 		autoMetaUrls: script.autoMetaUrls,
 		fileName: script.fileName,
 		generate: script.generate,
@@ -457,10 +500,9 @@ function applyUserscriptBundle(bundle, config, context) {
 		const inlined = stripSourceMappingUrl(inlineImportedChunks(chunk, bundle));
 		const { css, files: cssFiles } = collectCss(chunk, bundle);
 		for (const cssFile of cssFiles) if (!keptCss.has(cssFile)) leftoverAssets.push(...withSourceMaps([cssFile]));
-		const cssPrelude = css ? createCssInject(css, script.cssInject) : "";
+		const cssPrelude = css ? createCssInject(css) : "";
 		const body = `${inlined}${chunk.code}`;
 		const wrapped = ensureIife(body);
-		const extraGrants = css && script.cssInject === "auto" ? ["GM_addStyle"] : [];
 		const code = `${cssPrelude}${wrapped}`;
 		const emitFileProxy = Boolean(context.emitProxy && context.outDir && script.server.file);
 		leftoverAssets.push(`${fileName}.map`);
@@ -468,7 +510,6 @@ function applyUserscriptBundle(bundle, config, context) {
 			body,
 			code,
 			cssPrelude,
-			extraGrants,
 			inlined,
 			map: chunk.map,
 			wrapped
@@ -491,7 +532,7 @@ function applyUserscriptBundle(bundle, config, context) {
 		chunk.code = headed.code;
 		chunk.fileName = `${script.fileName}.user.js`;
 		if (script.metaFile) emitFile(`${script.fileName}.meta.js`, generateHeader(headed.headerConfig, {
-			align: script.align,
+			align: script.headerAlign,
 			autoMetaUrls: script.autoMetaUrls,
 			fileName: script.fileName,
 			generate: script.generate,
@@ -612,8 +653,7 @@ function toResolvedScript(config) {
 			prefix: config.server?.prefix ?? "server:",
 			file: config.server?.file ?? false
 		},
-		cssInject: config.cssInject ?? "auto",
-		align: config.align ?? 1,
+		headerAlign: config.headerAlign ?? 1,
 		generate: config.generate,
 		autoMetaUrls: config.autoMetaUrls ?? false,
 		metaFile: config.metaFile ?? true
@@ -628,6 +668,19 @@ function collectAutoMetaUrlsWarnings(config) {
 	}
 	return warnings;
 }
+function collectHomepageRelativeUrlWarnings(config) {
+	const warnings = [];
+	for (const script of config.scripts) {
+		if (resolveHomePage(script.header)) continue;
+		const fields = listHomepageRelativeFields(script.header);
+		if (!fields.length) continue;
+		warnings.push(`[${PLUGIN_NAME}] "${script.fileName}" has relative header URLs (${fields.join(", ")}) but no homepage, homepageURL, website, or source`);
+	}
+	return warnings;
+}
+function collectConfigWarnings(config) {
+	return [...collectAutoMetaUrlsWarnings(config), ...collectHomepageRelativeUrlWarnings(config)];
+}
 function resolvePluginConfig(config) {
 	const items = Array.isArray(config) ? config : [config];
 	if (!items.length) throw new Error(`[${PLUGIN_NAME}] Provide a userscript config or a non-empty array`);
@@ -813,7 +866,7 @@ function createDevUserscript(options) {
 		root: options.root,
 		prefix: options.script.server.prefix,
 		headerOptions: {
-			align: options.script.align,
+			align: options.script.headerAlign,
 			autoMetaUrls: options.script.autoMetaUrls,
 			generate: options.script.generate
 		},
@@ -1029,7 +1082,7 @@ function UserscriptPlugin(config) {
 				command = viteConfig.command;
 				resolved = absolutizeEntries(resolved, viteConfig.root);
 				reactPreamble = hasReactRefreshPlugin(viteConfig.plugins);
-				for (const message of collectAutoMetaUrlsWarnings(resolved)) viteConfig.logger.warn(message);
+				for (const message of collectConfigWarnings(resolved)) viteConfig.logger.warn(message);
 			}
 		},
 		{
@@ -1087,4 +1140,4 @@ function UserscriptPlugin(config) {
 	];
 }
 //#endregion
-export { Header, UserscriptPlugin as default, generateHeader, resolveHomePage, resolvePublicFileUrl };
+export { UserscriptPlugin as default };

package/package.json

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