vite-userscript-plugin 0.5.0 → 0.8.0

package/README.md

@@ -1,6 +1,5 @@
 # vite-userscript-plugin
 
-![ci](https://img.shields.io/github/workflow/status/crashmax-dev/vite-userscript-plugin/npm-publish)
 ![npm](https://img.shields.io/npm/v/vite-userscript-plugin)
 ![license](https://img.shields.io/github/license/crashmax-dev/vite-userscript-plugin)
 
@@ -85,11 +84,6 @@ export interface UserscriptPluginConfig {
    * @default true
    */
   autoGrants?: boolean
-
-  /**
-   * Server config (used in development mode for hot reloading).
-   */
-  server?: ServerConfig
 }
 ```
 

package/dist/hot-reload.cjs

@@ -0,0 +1 @@
+"use strict";async function n(){let o=new WebSocket("ws://localhost:__PORT__");o.addEventListener("open",()=>{let{script:e}=GM_info;console.group(`${e.name}@${e.version}`),console.log(GM_info),console.groupEnd()}),o.addEventListener("close",()=>{setTimeout(n,1e3)}),o.addEventListener("error",()=>{o.close()}),o.addEventListener("message",()=>{location.reload()})}n().then(()=>console.info("Connection to ws...")).finally(()=>console.clear());

package/dist/hot-reload.d.ts

@@ -0,0 +1 @@
+

package/dist/hot-reload.js

@@ -0,0 +1 @@
+async function n(){let o=new WebSocket("ws://localhost:__PORT__");o.addEventListener("open",()=>{let{script:e}=GM_info;console.group(`${e.name}@${e.version}`),console.log(GM_info),console.groupEnd()}),o.addEventListener("close",()=>{setTimeout(n,1e3)}),o.addEventListener("error",()=>{o.close()}),o.addEventListener("message",()=>{location.reload()})}n().then(()=>console.info("Connection to ws...")).finally(()=>console.clear());

package/dist/index.cjs

@@ -0,0 +1,5 @@
+"use strict";var W=Object.create;var h=Object.defineProperty;var N=Object.getOwnPropertyDescriptor;var K=Object.getOwnPropertyNames;var z=Object.getPrototypeOf,I=Object.prototype.hasOwnProperty;var J=(e,t)=>{for(var r in t)h(e,r,{get:t[r],enumerable:!0})},R=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of K(t))!I.call(e,o)&&o!==r&&h(e,o,{get:()=>t[o],enumerable:!(n=N(t,o))||n.enumerable});return e};var C=(e,t,r)=>(r=e!=null?W(z(e)):{},R(t||!e||!e.__esModule?h(r,"default",{value:e,enumerable:!0}):r,e)),H=e=>R(h({},"__esModule",{value:!0}),e);var X={};J(X,{UserscriptPlugin:()=>V,default:()=>Q});module.exports=H(X);var k=C(require("get-port"),1),c=require("fs"),q=require("http"),d=require("path"),v=require("url"),F=C(require("sanitize-filename"),1),L=require("websocket");function j(e){let t=[],r=Object.keys(e),n=Math.max(...r.map(a=>a.length))+1,o=a=>" ".repeat(n-a.length),g=(a,i)=>{let s=typeof i=="boolean";s&&!i||(i=s?"":o(a)+i.toString(),t.push(`// @${a}${i}`))};for(let[a,i]of Object.entries(e))if(Array.isArray(i))i.forEach(s=>g(a,s));else{if(i===void 0)continue;g(a,i)}return["// ==UserScript==",...t,"// ==/UserScript=="].join(`
+`)}var T=new RegExp(/\.(tsx?|jsx?)$/),$=new RegExp(/\.(s?css|sass)$/),S='console.warn("__TEMPLATE__")',x=["unsafeWindow","window.onurlchange","window.focus","window.close","GM_setValue","GM_getValue","GM_deleteValue","GM_listValues","GM_setClipboard","GM_addStyle","GM_addElement","GM_addValueChangeListener","GM_removeValueChangeListener","GM_registerMenuCommand","GM_unregisterMenuCommand","GM_download","GM_getTab","GM_getTabs","GM_saveTab","GM_openInTab","GM_notification","GM_getResourceURL","GM_getResourceText","GM_xmlhttpRequest","GM_webRequest","GM_log","GM_info"];var O=require("vite");function u(e){return[...new Set(Array.isArray(e)?e:e?[e]:[])]}async function G({file:e,name:t,loader:r}){let{code:n}=await(0,O.transformWithEsbuild)(e,t,{loader:r,minify:!0});return n}function E(e){let t=[];for(let r of x)e.indexOf(r)!==-1&&t.push(r);return t}var P=class{styles=new Map;async add(t,r){let n=await G({file:t,name:r,loader:"css"});return this.styles.set(r,n.replace(`
+`,"")),""}inject(){let t=[...this.styles.values()].join("");if(!!t)return`GM_addStyle(\`${t}\`)`}merge(t){let r=[];for(let n of t){let o=this.styles.get(n);!o||r.push([n,o])}this.styles.clear(),r.forEach(n=>this.styles.set(...n))}},w=new P;var U={};function V(e){let t,r,n=null,o=null,g=(0,q.createServer)(),a=L.server;return new a({httpServer:g}).on("request",s=>{o=s.accept(null,s.origin)}),{name:"vite-userscript-plugin",apply:"build",config(){return{build:{lib:{entry:e.entry,name:e.metadata.name,formats:["iife"],fileName:()=>`${e.metadata.name}.js`},rollupOptions:{output:{exports:"none",extend:!0}}}}},configResolved(s){t=s,r=s.build.watch??!1;let{name:l,match:y,require:p,include:f,exclude:_,resource:M,connect:b}=e.metadata;e.metadata.name=(0,F.default)(l),e.metadata.match=u(y),e.metadata.require=u(p),e.metadata.include=u(f),e.metadata.exclude=u(_),e.metadata.resource=u(M),e.metadata.connect=u(b)},async transform(s,l){return $.test(l)?{code:await w.add(s,l)}:l.includes(e.entry)?{code:s+S}:null},generateBundle(s,l){for(let[y,p]of Object.entries(l)){let f=Object.keys(p.modules);w.merge(f)}},async writeBundle(s,l){!n&&r&&(n=await(0,k.default)(),g.listen(n));for(let[y]of Object.entries(l))if(T.test(y)){let p=t.root,f=t.build.outDir||"dist",_=(0,d.resolve)(p,f,y),M=(0,d.resolve)((0,d.dirname)((0,v.fileURLToPath)(U.url)),`hot-reload-${e.metadata.name}.js`),b=(0,d.resolve)(p,f,`${e.metadata.name}.proxy.user.js`),A=(0,d.resolve)(p,f,`${e.metadata.name}.user.js`);try{let m=(0,c.readFileSync)(_,"utf8");if(e.metadata.grant=u(r?x:e.autoGrants??!0?E(m):[...e.metadata.grant??[],"GM_addStyle","GM_info"]),r){let D=(0,c.readFileSync)((0,d.resolve)((0,d.dirname)((0,v.fileURLToPath)(U.url)),"hot-reload.js"),"utf8"),B=await G({file:D.replace("__PORT__",n.toString()),name:M,loader:"js"});(0,c.writeFileSync)(M,B),(0,c.writeFileSync)(b,j({...e.metadata,require:[...e.metadata.require,"file://"+M,"file://"+_]}))}m=m.replace(S,`${w.inject()}`),m=await G({file:m,name:y,loader:"js"}),(0,c.writeFileSync)(_,m),(0,c.writeFileSync)(A,`${j(e.metadata)}
+
+${m}`)}catch(m){console.log(m)}}r||(g.close(),process.exit(0))},buildEnd(){o&&o.sendUTF(JSON.stringify({message:"reload"}))}}}var Q=V;0&&(module.exports={UserscriptPlugin});

package/dist/index.d.ts

@@ -1,6 +1,208 @@
 import { PluginOption } from 'vite';
-import type { UserscriptPluginConfig } from './types.js';
+
+declare const grants: readonly ["unsafeWindow", "window.onurlchange", "window.focus", "window.close", "GM_setValue", "GM_getValue", "GM_deleteValue", "GM_listValues", "GM_setClipboard", "GM_addStyle", "GM_addElement", "GM_addValueChangeListener", "GM_removeValueChangeListener", "GM_registerMenuCommand", "GM_unregisterMenuCommand", "GM_download", "GM_getTab", "GM_getTabs", "GM_saveTab", "GM_openInTab", "GM_notification", "GM_getResourceURL", "GM_getResourceText", "GM_xmlhttpRequest", "GM_webRequest", "GM_log", "GM_info"];
+
+declare type RunAt = 'document-start' | 'document-body' | 'document-end' | 'document-idle' | 'context-menu';
+declare type Grants = typeof grants[number];
+declare type MetadataConfig = {
+    [property: string]: string | boolean | number | string[] | undefined;
+    /**
+     * The name of the script.
+     * Internationalization is done by adding an appendix naming the locale.
+     */
+    name: string;
+    /**
+     * Version of the script,
+     * it can be used to check if a script has new versions. It is composed
+     * of several parts, joined by `.` Each part must start with numbers,
+     * and can be followed by alphabetic characters.
+     */
+    version: string;
+    /**
+     * A brief summary to describe the script.
+     */
+    description?: string;
+    /**
+     * The scripts author.
+     */
+    author?: string;
+    /**
+     * The script license.
+     */
+    license?: string;
+    /**
+     * The combination of `@namespace` and `@name` is the unique identifier for
+     * a userscript. `@namespace` can be any string, for example the homepage
+     * of a group of userscripts by the same author. If not provided
+     * the `@namespace` falls back to an empty string ('').
+     */
+    namespace?: string;
+    /**
+     * The authors homepage that is used at the options page to link from
+     * the scripts name to the given page. Please note that if the `@namespace`
+     * tag starts with `https://` its content will be used for this too.
+     */
+    homepage?: string;
+    /**
+     * An update URL for the userscript.
+     * Note:
+     * - a `@version` tag is required to make update checks work.
+     */
+    updateURL?: string;
+    /**
+     * Defines the URL where the script will be downloaded from when an update was
+     * detected. If the value none is used, then no update check will be done.
+     */
+    downloadURL?: string;
+    /**
+     * Defines the URL where the user can report issues and get personal support.
+     */
+    supportURL?: string;
+    /**
+     * Specify an icon for the script. Almost any image will work,
+     * but a 32x32 pixel size is best. This value may be specified relative
+     * to the URL the script itself is downloaded from.
+     */
+    icon?: string;
+    icon64?: string;
+    /**
+     * Each `@include` and `@exclude` rule can be one of the following:
+     * - a normal string
+     *   > If the string does not start or end with a slash (/),
+     *   > it will be used as a normal string.
+     *   > If there are wildcards (*), each of them matches any characters.
+     *   > e.g. https://www.google.com/* matches the following:
+     *    - https://www.google.com/
+     *    - https://www.google.com/any/subview
+     *   > but not the following:
+     *    - http://www.google.com/
+     *    - https://www.google.com.hk/
+     *   > If there is no wildcard in the string, the rule matches the entire URL.
+     *   > e.g. https://www.google.com/ matches only https://www.google.com/
+     *   > but not https://www.google.com/any/subview.
+     *   > The host part accepts .tld to match top level domain suffix.
+     *   > e.g. https://www.google.tld/ matches both https://www.google.com/
+     *   > and https://www.google.co.jp/.
+     *
+     * - a regular expression
+     *   > If the string starts and ends with a slash (/),
+     *   > it will be compiled as a regular expression.
+     *   > e.g. /\.google\.com[\.\/]/ matches the following:
+     *    - https://www.google.com/,
+     *    - https://www.google.com/any/subview
+     *    - http://www.google.com/
+     *    - https://www.google.com.hk/
+     */
+    include?: string[] | string;
+    exclude?: string[] | string;
+    /**
+     * More or less equal to the `@include` tag.
+     * You can get more information
+     * [here](https://developer.chrome.com/docs/extensions/mv2/match_patterns/).
+     *
+     * Note:
+     * - The `<all_urls>` statement is not yet supported and the scheme part also
+     * accepts `http*://`.
+     */
+    match: string[] | string;
+    /**
+     * Points to a JavaScript file that is loaded and executed before the script
+     * itself starts running.
+     *
+     * Note:
+     * - The scripts loaded via `@require` and their "use strict" statements
+     * might influence the userscript's strict mode!
+     */
+    require?: string[] | string;
+    /**
+     * Preloads resources that can by accessed
+     * via `GM_getResourceURL` and `GM_getResourceText` by the script.
+     */
+    resource?: string[] | string;
+    /**
+     * This tag defines the domains (no top-level domains) including subdomains
+     * which are allowed to be retrieved by `GM_xmlhttpRequest`
+     *
+     * - domains like tampermonkey.net (this will also allow all sub-domains)
+     * - sub-domains i.e. safari.tampermonkey.net
+     * - self to whitelist the domain the script is currently running at
+     * - localhost to access the localhost
+     * - 1.2.3.4 to connect to an IP address
+     *
+     * If it's not possible to declare all domains a userscript might connect
+     * to then it's a good practice to do the following: ***Declare all known or
+     * at least all common domains*** that might be connected by the script.
+     * This way the confirmation dialog can be avoided for most of the users.
+     *
+     * Additionally add `@connect *` to the script. By doing so Tampermonkey will
+     * still ask the user whether the next connection to a not mentioned domain
+     * is allowed, but also ***offer a "Always allow all domains" button***.
+     * If the user clicks at this button then all future requestswill
+     * be permitted automatically.
+     */
+    connect?: string[] | string;
+    /**
+     * This tag makes the script running on the main pages, but not at iframes.
+     * @default false
+     */
+    noframes?: boolean;
+    /**
+     * `@grant` is used to whitelist GM_* functions, the `unsafeWindow` object and
+     * some powerful window functions. If no `@grant` tag is given TM guesses
+     * the scripts needs.
+     */
+    grant?: Exclude<Grants, 'GM_addStyle' | 'GM_info'>[];
+    /**
+     * Defines the moment the script is injected. In opposition to other script
+     * handlers, `@run-at` defines the first possible moment a script wants to
+     * run. This means it may happen, that a script that uses the `@require` tag
+     * may be executed after the document is already loaded, cause fetching the
+     * required script took that long. Anyhow, all `DOMNodeInserted` and
+     * `DOMContentLoaded` events that happended after the given injection
+     * moment are cached and delivered to the script when it is injected.
+     *
+     * - `document-start`
+     * The script will be injected as fast as possible.
+     *
+     * - `document-body`
+     * The script will be injected if the body element exists.
+     *
+     * - `document-end`
+     * The script will be injected when or after the `DOMContentLoaded` event
+     * was dispatched.
+     *
+     * - `document-idle`
+     * The script will be injected after the DOMContentLoaded event was
+     * dispatched. This is the default value if no `@run-at` tag is given.
+     *
+     * - `context-menu`
+     * The script will be injected if it is clicked at the browser context menu
+     * (desktop Chrome-based browsers only).
+     *
+     * Note:
+     * - all `@include` and `@exclude` statements will be ignored if this value
+     * is used, but this may change in the future.
+     *
+     * @default 'document-idle'
+     */
+    'run-at'?: RunAt;
+};
+interface UserscriptPluginConfig {
+    /**
+     * Path of userscript entry.
+     */
+    entry: string;
+    /**
+     * Userscript header config.
+     */
+    metadata: MetadataConfig;
+    /**
+     * Import all `@grant` in development mode.
+     * @default true
+     */
+    autoGrants?: boolean;
+}
+
 declare function UserscriptPlugin(config: UserscriptPluginConfig): PluginOption;
-export { UserscriptPlugin };
-export default UserscriptPlugin;
-export type { UserscriptPluginConfig };
+
+export { UserscriptPlugin, UserscriptPluginConfig, UserscriptPlugin as default };

package/dist/index.js

@@ -1,130 +1,5 @@
-import { readFileSync, writeFileSync } from 'node:fs';
-import { createServer } from 'node:http';
-import { dirname, resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
-import websocket from 'websocket';
-import { banner } from './banner.js';
-import { grants, regexpScripts, template } from './constants.js';
-import css from './css.js';
-import { defineGrants, removeDuplicates, transform } from './helpers.js';
-function UserscriptPlugin(config) {
-    let pluginConfig;
-    let isBuildWatch;
-    let socketConnection = null;
-    const port = config.server?.port || 8000;
-    const server = createServer((_, res) => {
-        // const index = resolve(
-        //   dirname(fileURLToPath(import.meta.url)), '..', 'src', 'index.html'
-        // )
-        // res.writeHead(200, { 'Content-Type': 'html' })
-        // res.end(readFileSync(index))
-    });
-    server.listen(port);
-    const WebSocketServer = websocket.server;
-    const ws = new WebSocketServer({ httpServer: server });
-    ws.on('request', (request) => {
-        socketConnection = request.accept(null, request.origin);
-    });
-    return {
-        name: 'vite-userscript-plugin',
-        apply: 'build',
-        config() {
-            return {
-                build: {
-                    lib: {
-                        entry: config.entry,
-                        name: config.metadata.name,
-                        formats: ['iife'],
-                        fileName: () => `${config.metadata.name}.js`
-                    },
-                    rollupOptions: {
-                        output: {
-                            exports: 'none',
-                            extend: true
-                        }
-                    }
-                }
-            };
-        },
-        configResolved(cfg) {
-            pluginConfig = cfg;
-            isBuildWatch = (cfg.build.watch ?? false);
-            const { match, require, include, exclude, resource, connect } = config.metadata;
-            config.metadata.match = removeDuplicates(match);
-            config.metadata.require = removeDuplicates(require);
-            config.metadata.include = removeDuplicates(include);
-            config.metadata.exclude = removeDuplicates(exclude);
-            config.metadata.resource = removeDuplicates(resource);
-            config.metadata.connect = removeDuplicates(connect);
-        },
-        async transform(code, path) {
-            const style = await css.minify(code, path);
-            return css.add(config.entry, style.replace('\n', ''), path);
-        },
-        generateBundle(_, bundle) {
-            for (const [_, file] of Object.entries(bundle)) {
-                const styleModules = Object.keys(file.modules);
-                css.merge(styleModules);
-            }
-        },
-        async writeBundle(_, bundle) {
-            for (const [fileName] of Object.entries(bundle)) {
-                if (regexpScripts.test(fileName)) {
-                    const rootDir = pluginConfig.root;
-                    const outDir = pluginConfig.build.outDir;
-                    const outPath = resolve(rootDir, outDir, fileName);
-                    const hmrPath = resolve(rootDir, outDir, 'hmr.js');
-                    const proxyFilePath = resolve(rootDir, outDir, `${config.metadata.name}.proxy.user.js`);
-                    const userFilePath = resolve(rootDir, outDir, `${config.metadata.name}.user.js`);
-                    try {
-                        let source = readFileSync(outPath, 'utf8');
-                        // prettier-ignore
-                        config.metadata.grant = removeDuplicates(isBuildWatch
-                            ? grants
-                            : config.autoGrants ?? true
-                                ? defineGrants(source)
-                                : [...(config.metadata.grant ?? []), 'GM_addStyle', 'GM_info']);
-                        // prettier-ignore-end
-                        if (isBuildWatch) {
-                            const hmrFile = readFileSync(resolve(dirname(fileURLToPath(import.meta.url)), 'hmr.js'), 'utf8');
-                            const hmrScript = await transform({
-                                file: hmrFile.replace('__PORT__', port.toString()),
-                                name: hmrPath,
-                                loader: 'js'
-                            });
-                            writeFileSync(hmrPath, hmrScript);
-                            writeFileSync(proxyFilePath, banner({
-                                ...config.metadata,
-                                require: [
-                                    ...config.metadata.require,
-                                    'file://' + hmrPath,
-                                    'file://' + outPath
-                                ]
-                            }));
-                        }
-                        source = source.replace(template, `${css.inject()}`);
-                        source = await transform({
-                            file: source,
-                            name: fileName,
-                            loader: 'js'
-                        });
-                        writeFileSync(outPath, source);
-                        writeFileSync(userFilePath, `${banner(config.metadata)}\n\n${source}`);
-                    }
-                    catch (err) {
-                        console.log(err);
-                    }
-                }
-            }
-        },
-        buildEnd() {
-            if (socketConnection) {
-                socketConnection.sendUTF(JSON.stringify({
-                    message: 'reload'
-                }));
-            }
-        }
-    };
-}
-export { UserscriptPlugin };
-export default UserscriptPlugin;
+import q from"get-port";import{readFileSync as C,writeFileSync as x}from"fs";import{createServer as F}from"http";import{dirname as T,resolve as M}from"path";import{fileURLToPath as $}from"url";import L from"sanitize-filename";import{server as V}from"websocket";function b(e){let t=[],r=Object.keys(e),n=Math.max(...r.map(o=>o.length))+1,m=o=>" ".repeat(n-o.length),p=(o,a)=>{let s=typeof a=="boolean";s&&!a||(a=s?"":m(o)+a.toString(),t.push(`// @${o}${a}`))};for(let[o,a]of Object.entries(e))if(Array.isArray(a))a.forEach(s=>p(o,s));else{if(a===void 0)continue;p(o,a)}return["// ==UserScript==",...t,"// ==/UserScript=="].join(`
+`)}var P=new RegExp(/\.(tsx?|jsx?)$/),v=new RegExp(/\.(s?css|sass)$/),j='console.warn("__TEMPLATE__")',G=["unsafeWindow","window.onurlchange","window.focus","window.close","GM_setValue","GM_getValue","GM_deleteValue","GM_listValues","GM_setClipboard","GM_addStyle","GM_addElement","GM_addValueChangeListener","GM_removeValueChangeListener","GM_registerMenuCommand","GM_unregisterMenuCommand","GM_download","GM_getTab","GM_getTabs","GM_saveTab","GM_openInTab","GM_notification","GM_getResourceURL","GM_getResourceText","GM_xmlhttpRequest","GM_webRequest","GM_log","GM_info"];import{transformWithEsbuild as k}from"vite";function d(e){return[...new Set(Array.isArray(e)?e:e?[e]:[])]}async function _({file:e,name:t,loader:r}){let{code:n}=await k(e,t,{loader:r,minify:!0});return n}function R(e){let t=[];for(let r of G)e.indexOf(r)!==-1&&t.push(r);return t}var S=class{styles=new Map;async add(t,r){let n=await _({file:t,name:r,loader:"css"});return this.styles.set(r,n.replace(`
+`,"")),""}inject(){let t=[...this.styles.values()].join("");if(!!t)return`GM_addStyle(\`${t}\`)`}merge(t){let r=[];for(let n of t){let m=this.styles.get(n);!m||r.push([n,m])}this.styles.clear(),r.forEach(n=>this.styles.set(...n))}},h=new S;function A(e){let t,r,n=null,m=null,p=F(),o=V;return new o({httpServer:p}).on("request",s=>{m=s.accept(null,s.origin)}),{name:"vite-userscript-plugin",apply:"build",config(){return{build:{lib:{entry:e.entry,name:e.metadata.name,formats:["iife"],fileName:()=>`${e.metadata.name}.js`},rollupOptions:{output:{exports:"none",extend:!0}}}}},configResolved(s){t=s,r=s.build.watch??!1;let{name:i,match:f,require:u,include:c,exclude:g,resource:y,connect:w}=e.metadata;e.metadata.name=L(i),e.metadata.match=d(f),e.metadata.require=d(u),e.metadata.include=d(c),e.metadata.exclude=d(g),e.metadata.resource=d(y),e.metadata.connect=d(w)},async transform(s,i){return v.test(i)?{code:await h.add(s,i)}:i.includes(e.entry)?{code:s+j}:null},generateBundle(s,i){for(let[f,u]of Object.entries(i)){let c=Object.keys(u.modules);h.merge(c)}},async writeBundle(s,i){!n&&r&&(n=await q(),p.listen(n));for(let[f]of Object.entries(i))if(P.test(f)){let u=t.root,c=t.build.outDir||"dist",g=M(u,c,f),y=M(T($(import.meta.url)),`hot-reload-${e.metadata.name}.js`),w=M(u,c,`${e.metadata.name}.proxy.user.js`),O=M(u,c,`${e.metadata.name}.user.js`);try{let l=C(g,"utf8");if(e.metadata.grant=d(r?G:e.autoGrants??!0?R(l):[...e.metadata.grant??[],"GM_addStyle","GM_info"]),r){let E=C(M(T($(import.meta.url)),"hot-reload.js"),"utf8"),U=await _({file:E.replace("__PORT__",n.toString()),name:y,loader:"js"});x(y,U),x(w,b({...e.metadata,require:[...e.metadata.require,"file://"+y,"file://"+g]}))}l=l.replace(j,`${h.inject()}`),l=await _({file:l,name:f,loader:"js"}),x(g,l),x(O,`${b(e.metadata)}
+
+${l}`)}catch(l){console.log(l)}}r||(p.close(),process.exit(0))},buildEnd(){m&&m.sendUTF(JSON.stringify({message:"reload"}))}}}var oe=A;export{A as UserscriptPlugin,oe as default};

package/package.json

@@ -1,9 +1,14 @@
 {
   "name": "vite-userscript-plugin",
-  "version": "0.5.0",
+  "version": "0.8.0",
   "type": "module",
   "types": "./dist/index.d.ts",
-  "main": "./dist/index.js",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "exports": {
+    "require": "./dist/index.cjs",
+    "import": "./dist/index.js"
+  },
   "files": [
     "dist"
   ],
@@ -27,17 +32,18 @@
     "url": "https://github.com/crashmax-dev/vite-userscript-plugin/issues"
   },
   "dependencies": {
+    "get-port": "^6.1.2",
+    "sanitize-filename": "^1.6.3",
     "websocket": "^1.0.34"
   },
   "devDependencies": {
     "@types/websocket": "^1.0.5"
   },
   "peerDependencies": {
-    "@types/tampermonkey": "latest"
+    "@types/tampermonkey": ">=4.0.0"
   },
   "scripts": {
-    "dev": "tsc --build --watch",
-    "build": "pnpm clean && tsc --build",
-    "clean": "del-cli dist"
+    "dev": "tsup --watch",
+    "build": "tsup"
   }
 }

package/dist/banner.d.ts

@@ -1,2 +0,0 @@
-import type { MetadataConfig } from './types.js';
-export declare function banner(config: MetadataConfig): string;

package/dist/banner.js

@@ -1,30 +0,0 @@
-export function banner(config) {
-    const metadata = [];
-    const configKeys = Object.keys(config);
-    const maxKeyLength = Math.max(...configKeys.map((key) => key.length)) + 1;
-    const addSpaces = (str) => {
-        return ' '.repeat(maxKeyLength - str.length);
-    };
-    const addMetadata = (key, value) => {
-        const isBoolean = typeof value === 'boolean';
-        if (isBoolean && !value)
-            return;
-        value = !isBoolean ? addSpaces(key) + value.toString() : '';
-        metadata.push(`// @${key}${value}`);
-    };
-    for (const [key, value] of Object.entries(config)) {
-        if (Array.isArray(value)) {
-            value.forEach((value) => addMetadata(key, value));
-        }
-        else {
-            if (value === undefined)
-                continue;
-            addMetadata(key, value);
-        }
-    }
-    return [
-        '// ==UserScript==',
-        ...metadata,
-        '// ==/UserScript=='
-    ].join('\n');
-}

package/dist/constants.d.ts

@@ -1,4 +0,0 @@
-export declare const regexpScripts: RegExp;
-export declare const regexpStyles: RegExp;
-export declare const template = "console.warn(\"__TEMPLATE__\")";
-export declare const grants: readonly ["unsafeWindow", "window.onurlchange", "window.focus", "window.close", "GM_setValue", "GM_getValue", "GM_deleteValue", "GM_listValues", "GM_setClipboard", "GM_addStyle", "GM_addElement", "GM_addValueChangeListener", "GM_removeValueChangeListener", "GM_registerMenuCommand", "GM_unregisterMenuCommand", "GM_download", "GM_getTab", "GM_getTabs", "GM_saveTab", "GM_openInTab", "GM_notification", "GM_getResourceURL", "GM_getResourceText", "GM_xmlhttpRequest", "GM_webRequest", "GM_log", "GM_info"];

package/dist/constants.js

@@ -1,32 +0,0 @@
-export const regexpScripts = new RegExp(/\.js/);
-export const regexpStyles = new RegExp(/\.css|\.sass|\.scss|\.less/);
-export const template = `console.warn("__TEMPLATE__")`;
-export const grants = [
-    'unsafeWindow',
-    'window.onurlchange',
-    'window.focus',
-    'window.close',
-    'GM_setValue',
-    'GM_getValue',
-    'GM_deleteValue',
-    'GM_listValues',
-    'GM_setClipboard',
-    'GM_addStyle',
-    'GM_addElement',
-    'GM_addValueChangeListener',
-    'GM_removeValueChangeListener',
-    'GM_registerMenuCommand',
-    'GM_unregisterMenuCommand',
-    'GM_download',
-    'GM_getTab',
-    'GM_getTabs',
-    'GM_saveTab',
-    'GM_openInTab',
-    'GM_notification',
-    'GM_getResourceURL',
-    'GM_getResourceText',
-    'GM_xmlhttpRequest',
-    'GM_webRequest',
-    'GM_log',
-    'GM_info'
-];

package/dist/css.d.ts

@@ -1,11 +0,0 @@
-declare class CSS {
-    private readonly styles;
-    add(entry: string, code: string, path: string): {
-        code: string;
-    } | null;
-    minify(file: string, name: string): Promise<string>;
-    inject(): string | void;
-    merge(modules: string[]): void;
-}
-declare const _default: CSS;
-export default _default;

package/dist/css.js

@@ -1,51 +0,0 @@
-import { regexpStyles, template } from './constants.js';
-import { transform } from './helpers.js';
-class CSS {
-    constructor() {
-        Object.defineProperty(this, "styles", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: new Map()
-        });
-    }
-    add(entry, code, path) {
-        if (regexpStyles.test(path)) {
-            this.styles.set(path, code);
-            return {
-                code: ''
-            };
-        }
-        if (path.includes(entry)) {
-            return {
-                code: code + template
-            };
-        }
-        return null;
-    }
-    async minify(file, name) {
-        return await transform({
-            file,
-            name,
-            loader: 'css'
-        });
-    }
-    inject() {
-        const styles = [...this.styles.values()].join('');
-        if (!styles)
-            return;
-        return `GM_addStyle(\`${styles}\`)`;
-    }
-    merge(modules) {
-        const styleModules = [];
-        for (const module of modules) {
-            const style = this.styles.get(module);
-            if (!style)
-                continue;
-            styleModules.push([module, style]);
-        }
-        this.styles.clear();
-        styleModules.forEach((value) => this.styles.set(...value));
-    }
-}
-export default new CSS();

package/dist/helpers.d.ts

@@ -1,4 +0,0 @@
-import { Grants, Transform } from './types.js';
-export declare function removeDuplicates(arr: string | string[] | readonly string[] | undefined): any[];
-export declare function transform({ file, name, loader }: Transform): Promise<string>;
-export declare function defineGrants(code: string): Grants[];

package/dist/helpers.js

@@ -1,21 +0,0 @@
-import { transformWithEsbuild } from 'vite';
-import { grants } from './constants.js';
-export function removeDuplicates(arr) {
-    return [...new Set(Array.isArray(arr) ? arr : arr ? [arr] : [])];
-}
-export async function transform({ file, name, loader }) {
-    const { code } = await transformWithEsbuild(file, name, {
-        loader,
-        minify: true
-    });
-    return code;
-}
-export function defineGrants(code) {
-    const definedGrants = [];
-    for (const grant of grants) {
-        if (code.indexOf(grant) !== -1) {
-            definedGrants.push(grant);
-        }
-    }
-    return definedGrants;
-}

package/dist/hmr.d.ts

@@ -1 +0,0 @@
-declare function HRM(): void;

package/dist/hmr.js

@@ -1,22 +0,0 @@
-"use strict";
-function HRM() {
-    const ws = new WebSocket('ws://localhost:__PORT__');
-    ws.addEventListener('open', () => {
-        console.clear();
-        const { script } = GM_info;
-        console.group(`${script.name}@${script.version}`);
-        console.log(GM_info);
-        console.groupEnd();
-    });
-    ws.addEventListener('close', (event) => {
-        console.warn('Socket is closed. Reconnect will be attempted in 1 second.', event.reason);
-        setTimeout(HRM, 1000);
-    });
-    ws.addEventListener('error', () => {
-        ws.close();
-    });
-    ws.addEventListener('message', () => {
-        location.reload();
-    });
-}
-HRM();

package/dist/types.d.ts

@@ -1,217 +0,0 @@
-import { grants } from './constants.js';
-export interface Transform {
-    file: string;
-    name: string;
-    loader: 'js' | 'css';
-}
-export declare type RunAt = 'document-start' | 'document-body' | 'document-end' | 'document-idle' | 'context-menu';
-export declare type Grants = typeof grants[number];
-export declare type MetadataConfig = {
-    [property: string]: string | boolean | number | string[] | undefined;
-    /**
-     * The name of the script.
-     * Internationalization is done by adding an appendix naming the locale.
-     */
-    name: string;
-    /**
-     * Version of the script,
-     * it can be used to check if a script has new versions. It is composed
-     * of several parts, joined by `.` Each part must start with numbers,
-     * and can be followed by alphabetic characters.
-     */
-    version: string;
-    /**
-     * A brief summary to describe the script.
-     */
-    description?: string;
-    /**
-     * The scripts author.
-     */
-    author?: string;
-    /**
-     * The script license.
-     */
-    license?: string;
-    /**
-     * The combination of `@namespace` and `@name` is the unique identifier for
-     * a userscript. `@namespace` can be any string, for example the homepage
-     * of a group of userscripts by the same author. If not provided
-     * the `@namespace` falls back to an empty string ('').
-     */
-    namespace?: string;
-    /**
-     * The authors homepage that is used at the options page to link from
-     * the scripts name to the given page. Please note that if the `@namespace`
-     * tag starts with `https://` its content will be used for this too.
-     */
-    homepage?: string;
-    /**
-     * An update URL for the userscript.
-     * Note:
-     * - a `@version` tag is required to make update checks work.
-     */
-    updateURL?: string;
-    /**
-     * Defines the URL where the script will be downloaded from when an update was
-     * detected. If the value none is used, then no update check will be done.
-     */
-    downloadURL?: string;
-    /**
-     * Defines the URL where the user can report issues and get personal support.
-     */
-    supportURL?: string;
-    /**
-     * Specify an icon for the script. Almost any image will work,
-     * but a 32x32 pixel size is best. This value may be specified relative
-     * to the URL the script itself is downloaded from.
-     */
-    icon?: string;
-    icon64?: string;
-    /**
-     * Each `@include` and `@exclude` rule can be one of the following:
-     * - a normal string
-     *   > If the string does not start or end with a slash (/),
-     *   > it will be used as a normal string.
-     *   > If there are wildcards (*), each of them matches any characters.
-     *   > e.g. https://www.google.com/* matches the following:
-     *    - https://www.google.com/
-     *    - https://www.google.com/any/subview
-     *   > but not the following:
-     *    - http://www.google.com/
-     *    - https://www.google.com.hk/
-     *   > If there is no wildcard in the string, the rule matches the entire URL.
-     *   > e.g. https://www.google.com/ matches only https://www.google.com/
-     *   > but not https://www.google.com/any/subview.
-     *   > The host part accepts .tld to match top level domain suffix.
-     *   > e.g. https://www.google.tld/ matches both https://www.google.com/
-     *   > and https://www.google.co.jp/.
-     *
-     * - a regular expression
-     *   > If the string starts and ends with a slash (/),
-     *   > it will be compiled as a regular expression.
-     *   > e.g. /\.google\.com[\.\/]/ matches the following:
-     *    - https://www.google.com/,
-     *    - https://www.google.com/any/subview
-     *    - http://www.google.com/
-     *    - https://www.google.com.hk/
-     */
-    include?: string[] | string;
-    exclude?: string[] | string;
-    /**
-     * More or less equal to the `@include` tag.
-     * You can get more information
-     * [here](https://developer.chrome.com/docs/extensions/mv2/match_patterns/).
-     *
-     * Note:
-     * - The `<all_urls>` statement is not yet supported and the scheme part also
-     * accepts `http*://`.
-     */
-    match: string[] | string;
-    /**
-     * Points to a JavaScript file that is loaded and executed before the script
-     * itself starts running.
-     *
-     * Note:
-     * - The scripts loaded via `@require` and their "use strict" statements
-     * might influence the userscript's strict mode!
-     */
-    require?: string[] | string;
-    /**
-     * Preloads resources that can by accessed
-     * via `GM_getResourceURL` and `GM_getResourceText` by the script.
-     */
-    resource?: string[] | string;
-    /**
-     * This tag defines the domains (no top-level domains) including subdomains
-     * which are allowed to be retrieved by `GM_xmlhttpRequest`
-     *
-     * - domains like tampermonkey.net (this will also allow all sub-domains)
-     * - sub-domains i.e. safari.tampermonkey.net
-     * - self to whitelist the domain the script is currently running at
-     * - localhost to access the localhost
-     * - 1.2.3.4 to connect to an IP address
-     *
-     * If it's not possible to declare all domains a userscript might connect
-     * to then it's a good practice to do the following: ***Declare all known or
-     * at least all common domains*** that might be connected by the script.
-     * This way the confirmation dialog can be avoided for most of the users.
-     *
-     * Additionally add `@connect *` to the script. By doing so Tampermonkey will
-     * still ask the user whether the next connection to a not mentioned domain
-     * is allowed, but also ***offer a "Always allow all domains" button***.
-     * If the user clicks at this button then all future requestswill
-     * be permitted automatically.
-     */
-    connect?: string[] | string;
-    /**
-     * This tag makes the script running on the main pages, but not at iframes.
-     * @default false
-     */
-    noframes?: boolean;
-    /**
-     * `@grant` is used to whitelist GM_* functions, the `unsafeWindow` object and
-     * some powerful window functions. If no `@grant` tag is given TM guesses
-     * the scripts needs.
-     */
-    grant?: Exclude<Grants, 'GM_addStyle' | 'GM_info'>[];
-    /**
-     * Defines the moment the script is injected. In opposition to other script
-     * handlers, `@run-at` defines the first possible moment a script wants to
-     * run. This means it may happen, that a script that uses the `@require` tag
-     * may be executed after the document is already loaded, cause fetching the
-     * required script took that long. Anyhow, all `DOMNodeInserted` and
-     * `DOMContentLoaded` events that happended after the given injection
-     * moment are cached and delivered to the script when it is injected.
-     *
-     * - `document-start`
-     * The script will be injected as fast as possible.
-     *
-     * - `document-body`
-     * The script will be injected if the body element exists.
-     *
-     * - `document-end`
-     * The script will be injected when or after the `DOMContentLoaded` event
-     * was dispatched.
-     *
-     * - `document-idle`
-     * The script will be injected after the DOMContentLoaded event was
-     * dispatched. This is the default value if no `@run-at` tag is given.
-     *
-     * - `context-menu`
-     * The script will be injected if it is clicked at the browser context menu
-     * (desktop Chrome-based browsers only).
-     *
-     * Note:
-     * - all `@include` and `@exclude` statements will be ignored if this value
-     * is used, but this may change in the future.
-     *
-     * @default 'document-idle'
-     */
-    'run-at'?: RunAt;
-};
-export interface ServerConfig {
-    /**
-     * Server port.
-     * @default 8000
-     */
-    port?: number;
-}
-export interface UserscriptPluginConfig {
-    /**
-     * Path of userscript entry.
-     */
-    entry: string;
-    /**
-     * Userscript header config.
-     */
-    metadata: MetadataConfig;
-    /**
-     * Import all `@grant` in development mode.
-     * @default true
-     */
-    autoGrants?: boolean;
-    /**
-     * Server config (used in development mode for hot reloading).
-     */
-    server?: ServerConfig;
-}

package/dist/types.js

@@ -1 +0,0 @@
-export {};