vite-tampermonkey 1.0.0

package/dist/builder.d.ts

@@ -0,0 +1,34 @@
+import type { ExternalResource, TampermonkeyMeta } from './types';
+/**
+ * 元数据构造器
+ */
+export declare class TampermonkeyMetaBuilder {
+    private lines;
+    add(key: string, value?: string | string[] | boolean): this;
+    addRecord(record?: Record<string, string | string[] | true>): this;
+    private push;
+    build(): string;
+}
+export declare class TampermonkeyBuilder {
+    private cssCode;
+    private jsCode;
+    private meta;
+    private external?;
+    private externalResources;
+    constructor(meta: TampermonkeyMeta, external?: ExternalResource);
+    /**
+     * 添加CSS代码
+     * @param source 源码
+     */
+    addCss(source: any): void;
+    /**
+     * 添加JS代码
+     * @param code 代码
+     */
+    addCode(code: string): void;
+    private getGrant;
+    private getExternalResources;
+    buildHeader(isDev?: boolean, filename?: string): string;
+    build(isDev?: boolean): string;
+}
+//# sourceMappingURL=builder.d.ts.map

package/dist/builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder.d.ts","sourceRoot":"","sources":["../src/builder.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAClE;;GAEG;AACH,qBAAa,uBAAuB;IAClC,OAAO,CAAC,KAAK,CAAmC;IAEhD,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO;IAqBpD,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;IAgB3D,OAAO,CAAC,IAAI;IAKZ,KAAK;CAIN;AAOD,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,OAAO,CAAc;IAC7B,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,IAAI,CAAwB;IACpC,OAAO,CAAC,QAAQ,CAAC,CAAmB;IACpC,OAAO,CAAC,iBAAiB,CAA2B;gBAExC,IAAI,EAAE,gBAAgB,EAAE,QAAQ,CAAC,EAAE,gBAAgB;IAM/D;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,GAAG;IAOlB;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM;IAIpB,OAAO,CAAC,QAAQ;IAQhB,OAAO,CAAC,oBAAoB;IAkB5B,WAAW,CAAC,KAAK,GAAE,OAAe,EAAE,QAAQ,CAAC,EAAE,MAAM;IAgDrD,KAAK,CAAC,KAAK,GAAE,OAAe;CAkB7B"}

package/dist/builder.js

@@ -0,0 +1,156 @@
+import crypto from 'crypto';
+import fs from 'fs';
+/**
+ * 元数据构造器
+ */
+export class TampermonkeyMetaBuilder {
+    lines = ['// ==UserScript=='];
+    add(key, value) {
+        if (value == null)
+            return this;
+        if (key === 'icon') {
+            // 判断是否是本地文件
+            if (typeof value === 'string' && !value.startsWith('http')) {
+                const iconBase64 = fs.readFileSync(value, 'base64');
+                value = `data:image/png;base64,${iconBase64}`;
+            }
+        }
+        if (Array.isArray(value)) {
+            const set = new Set(value);
+            set.forEach((v) => this.push(key, v));
+        }
+        else {
+            this.push(key, value === true ? '' : String(value));
+        }
+        return this;
+    }
+    addRecord(record) {
+        if (!record)
+            return this;
+        for (const [k, v] of Object.entries(record)) {
+            const key = k.replace(/([A-Z])/g, '-$1').toLowerCase();
+            if (Array.isArray(v)) {
+                v.forEach((val) => this.push(key, String(val)));
+            }
+            else {
+                this.push(key, v === true ? '' : String(v));
+            }
+        }
+        return this;
+    }
+    push(key, value) {
+        const spacing = ' '.repeat(Math.max(1, 12 - key.length));
+        this.lines.push(`// @${key}${spacing}${value}`.trimEnd());
+    }
+    build() {
+        return [...this.lines, '// ==/UserScript==', ''].join('\n');
+    }
+}
+export class TampermonkeyBuilder {
+    cssCode = '';
+    jsCode = '';
+    meta = {};
+    external;
+    externalResources = [];
+    constructor(meta, external) {
+        this.meta = meta;
+        this.external = external;
+        this.externalResources = this.getExternalResources();
+        this.addCode('var global = window;\n');
+    }
+    /**
+     * 添加CSS代码
+     * @param source 源码
+     */
+    addCss(source) {
+        this.cssCode +=
+            typeof source === 'string'
+                ? source
+                : Buffer.from(source).toString('utf8');
+    }
+    /**
+     * 添加JS代码
+     * @param code 代码
+     */
+    addCode(code) {
+        this.jsCode += code;
+    }
+    getGrant() {
+        let grant = this.meta.grant ?? [];
+        if (typeof grant === 'string') {
+            grant = [grant];
+        }
+        return grant;
+    }
+    getExternalResources() {
+        const externalResources = Array.from(new Set(Object.values(this.external?.resources ?? {})));
+        return externalResources.map((resource) => {
+            // md5(resource)
+            const md5 = crypto
+                .createHash('md5')
+                .update(resource)
+                .digest('hex')
+                .substring(0, 8);
+            return {
+                name: md5,
+                url: resource,
+            };
+        });
+    }
+    buildHeader(isDev = false, filename) {
+        const name = isDev ? `${this.meta.name} (Dev)` : this.meta.name;
+        const grant = this.getGrant();
+        if (this.cssCode.trim().length > 0) {
+            grant.push('GM_addStyle');
+        }
+        if (this.externalResources.length > 0 && !isDev) {
+            grant.push('GM_getResourceText');
+        }
+        const requires = [
+            ...(this.meta.require ?? []),
+            ...(isDev ? [] : Object.values(this.external?.modules ?? {})),
+            ...(filename && isDev ? [filename] : []),
+        ];
+        // 处理外部资源
+        const resources = [
+            ...(this.meta.resource ?? []),
+            ...(isDev && this.externalResources.length > 0
+                ? []
+                : this.externalResources.map((resource) => `${resource.name} ${resource.url}`)),
+        ];
+        return new TampermonkeyMetaBuilder()
+            .add('name', name)
+            .add('namespace', this.meta.namespace)
+            .add('version', this.meta.version)
+            .add('description', this.meta.description)
+            .add('author', this.meta.author)
+            .add('match', this.meta.match)
+            .add('include', this.meta.include)
+            .add('grant', this.meta.grant)
+            .add('run-at', this.meta.runAt)
+            .add('icon', this.meta.icon)
+            .add('require', requires)
+            .add('resource', resources)
+            .addRecord(this.meta.extra)
+            .add('license', this.meta.license)
+            .add('downloadUrl', this.meta.downloadUrl)
+            .add('updateUrl', this.meta.updateUrl)
+            .build();
+    }
+    build(isDev = false) {
+        const header = !isDev ? this.buildHeader(isDev) : '';
+        if (!isDev) {
+            this.externalResources.forEach((resource) => {
+                if (resource.url.endsWith('.css')) {
+                    this.jsCode =
+                        'GM_addStyle(GM_getResourceText("' +
+                            resource.name +
+                            '"));\n\n' +
+                            this.jsCode;
+                }
+            });
+        }
+        const code = `${header}\nGM_addStyle(${JSON.stringify(this.cssCode)});\n${this.jsCode}`;
+        return code;
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import type { Plugin } from 'vite';
+import type { TampermonkeyPluginOptions } from './types';
+/**
+ * 油猴插件
+ */
+export declare function tampermonkeyPlugin(options?: TampermonkeyPluginOptions): Plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAGnC,OAAO,KAAK,EAAoB,yBAAyB,EAAE,MAAM,SAAS,CAAC;AAU3E;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,GAAE,yBAA8B,GACtC,MAAM,CA8HR"}

package/dist/index.js

@@ -0,0 +1,124 @@
+import { readFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+import { pathToFileURL } from 'node:url';
+import { TampermonkeyBuilder } from './builder';
+import { createExternalResolver, resolveMeta } from './resovler';
+const DEFAULT_META = {
+    namespace: 'https://github.com/',
+    runAt: 'document-idle',
+    grant: [],
+};
+const DEFAULT_PKG_NAME = 'userscript';
+/**
+ * 油猴插件
+ */
+export function tampermonkeyPlugin(options = {}) {
+    const { root = process.cwd(), entry = 'src/main.tsx', packageJson = resolve(root, 'package.json'), meta: userMeta = {}, } = options;
+    // 解析package.json
+    const pkg = JSON.parse(readFileSync(packageJson, 'utf8'));
+    const pkgName = pkg.name || DEFAULT_PKG_NAME;
+    const baseName = pkgName.replace(/^@/, '').replace(/\//g, '-');
+    // 预处理外部资源
+    const externalResolver = createExternalResolver(options.external);
+    const meta = resolveMeta(pkg, { ...DEFAULT_META, ...userMeta });
+    // 创建构建器
+    const builder = new TampermonkeyBuilder(meta, options.external);
+    let isDev = false;
+    const fileName = `user.js`;
+    let outDirAbs = '';
+    return {
+        name: 'vite-tampermonkey-plugin',
+        enforce: 'post',
+        apply: 'build',
+        /**
+         * 配置
+         * @param mode 模式
+         * @returns 配置
+         */
+        config({ mode }) {
+            isDev = mode === 'development';
+            return {
+                publicDir: false,
+                build: {
+                    lib: {
+                        entry: resolve(root, entry),
+                        name: baseName.replace(/-/g, '_'),
+                        fileName: () => fileName,
+                        formats: ['iife'],
+                    },
+                    minify: false,
+                    cssMinify: true,
+                    sourcemap: false,
+                    emptyOutDir: true,
+                    cssCodeSplit: false,
+                    rolldownOptions: isDev ? undefined : {
+                        external: externalResolver.isModule,
+                        output: {
+                            globals: externalResolver.getGlobal,
+                            comments: false,
+                        },
+                    },
+                },
+                define: {
+                    'process.env.NODE_ENV': JSON.stringify(mode),
+                },
+            };
+        },
+        configResolved(config) {
+            outDirAbs = resolve(root, config.build.outDir);
+        },
+        /**
+         * 拦截外部资源,防止写入到输出文件,之后自定义代码注入到用户脚本中.
+         * @param code
+         * @param id
+         */
+        load(id) {
+            if (externalResolver.isResource(id) && !isDev) {
+                return {
+                    code: '',
+                    map: null,
+                };
+            }
+            return null;
+        },
+        /**
+         * 生成打包
+         * @param _options 选项
+         * @param bundle 打包
+         */
+        generateBundle(_, bundle) {
+            // 先处理一次css代码
+            for (const key of Object.keys(bundle)) {
+                const file = bundle[key];
+                if (file.type === 'asset' && file.fileName.endsWith('.css')) {
+                    builder.addCss(file.source);
+                    delete bundle[key];
+                }
+            }
+            // 再处理js代码
+            for (const key of Object.keys(bundle)) {
+                const file = bundle[key];
+                // 不是入口文件或者不是chunk,跳过
+                if (file.type !== 'chunk' || !file.isEntry)
+                    continue;
+                builder.addCode(file.code);
+                if (isDev) {
+                    const fileUrl = pathToFileURL(resolve(outDirAbs, fileName)).href;
+                    const header = builder.buildHeader(isDev, fileUrl);
+                    this.emitFile({
+                        type: 'asset',
+                        fileName: `user.dev.js`,
+                        source: header,
+                    });
+                }
+                file.code = builder.build(isDev);
+                // 产生一个meta.json文件
+                this.emitFile({
+                    type: 'asset',
+                    fileName: `meta.json`,
+                    source: JSON.stringify(meta, null, 2),
+                });
+            }
+        },
+    };
+}

package/dist/resovler.d.ts

@@ -0,0 +1,20 @@
+import type { ExternalResource, PackageJson, TampermonkeyMeta } from './types';
+/**
+ * 解析元数据
+ * @param pkg package.json
+ * @param userMeta 用户元数据
+ * @returns 元数据
+ */
+export declare function resolveMeta(pkg: PackageJson, userMeta: TampermonkeyMeta): TampermonkeyMeta;
+/**
+ * 创建外部资源解析器
+ * @param externals 外部资源
+ * @param globals 全局变量
+ * @returns 外部资源解析器
+ */
+export declare function createExternalResolver(external?: ExternalResource): {
+    isModule(id: string): boolean;
+    getGlobal(id: string): string;
+    isResource(id: string): boolean;
+};
+//# sourceMappingURL=resovler.d.ts.map

package/dist/resovler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resovler.d.ts","sourceRoot":"","sources":["../src/resovler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAC/E;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,GAAG,EAAE,WAAW,EAChB,QAAQ,EAAE,gBAAgB,GACzB,gBAAgB,CAWlB;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,CAAC,EAAE,gBAAgB;iBAajD,MAAM;kBAIL,MAAM;mBAGL,MAAM;EAIxB"}

package/dist/resovler.js

@@ -0,0 +1,45 @@
+/**
+ * 解析元数据
+ * @param pkg package.json
+ * @param userMeta 用户元数据
+ * @returns 元数据
+ */
+export function resolveMeta(pkg, userMeta) {
+    const grants = new Set(userMeta.grant ?? []);
+    return {
+        name: pkg.name,
+        version: pkg.version,
+        description: pkg.description,
+        author: pkg.author,
+        ...userMeta,
+        grant: Array.from(grants),
+    };
+}
+/**
+ * 创建外部资源解析器
+ * @param externals 外部资源
+ * @param globals 全局变量
+ * @returns 外部资源解析器
+ */
+export function createExternalResolver(external) {
+    if (!external)
+        return {
+            isModule: () => false,
+            getGlobal: () => '',
+            isResource: () => false,
+        };
+    const modules = Object.keys(external.modules ?? {});
+    const globals = external.globals ?? {};
+    const resources = Object.keys(external.resources ?? {});
+    return {
+        isModule(id) {
+            return modules.some((name) => id === name || id.startsWith(`${name}/`));
+        },
+        getGlobal(id) {
+            return globals[id] ?? id.replace(/[^\w$]/g, '_');
+        },
+        isResource(id) {
+            return resources.some((name) => id.endsWith(name));
+        },
+    };
+}

package/dist/types.d.ts

@@ -0,0 +1,63 @@
+/**
+ * 油猴元数据
+ */
+export type TampermonkeyMeta = {
+    name?: string;
+    namespace?: string;
+    version?: string;
+    description?: string;
+    author?: string;
+    /** 单条或多条 @match */
+    match?: string | string[];
+    /** 单条或多条 @include */
+    include?: string | string[];
+    /** 单条或多条 @grant */
+    grant?: string | string[];
+    runAt?: 'document-start' | 'document-end' | 'document-idle';
+    icon?: string;
+    exclude?: string | string[];
+    require?: string | string[];
+    connect?: string | string[];
+    resource?: string | string[];
+    /** 其它 // @key value，如 { noframes: '' } -> // @noframes */
+    extra?: Record<string, string | string[] | true>;
+    license?: string;
+    downloadUrl?: string;
+    updateUrl?: string;
+};
+/**
+ * 外部资源
+ */
+export type ExternalResource = {
+    /** 外部资源（JS/CSS 等），用于生成 @require/@resource */
+    resources?: Record<string, string>;
+    /** 外部模块（用于 rolldown external + @require） */
+    modules?: Record<string, string>;
+    /** 外部全局变量映射 */
+    globals?: Record<string, string>;
+};
+/**
+ * 油猴插件选项
+ */
+export type TampermonkeyPluginOptions = {
+    /** 用户脚本入口，默认 `src/userscript.tsx`（相对 root） */
+    entry?: string;
+    /** 工程根目录，默认 `process.cwd()` */
+    root?: string;
+    /** package.json 路径，默认 `<root>/package.json` */
+    packageJson?: string;
+    /** 覆盖 / 补充 UserScript 元数据 */
+    meta?: TampermonkeyMeta;
+    /** 外部资源 */
+    external?: ExternalResource;
+};
+/**
+ * package.json需要包含的字段
+ */
+export type PackageJson = {
+    name: string;
+    version: string;
+    description?: string;
+    author?: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mBAAmB;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1B,qBAAqB;IACrB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC5B,mBAAmB;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1B,KAAK,CAAC,EAAE,gBAAgB,GAAG,cAAc,GAAG,eAAe,CAAC;IAC5D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC7B,0DAA0D;IAC1D,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,6CAA6C;IAC7C,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,4CAA4C;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,eAAe;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6BAA6B;IAC7B,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,WAAW;IACX,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/types.js

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

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "vite-tampermonkey",
+  "version": "1.0.0",
+  "description": "Vite plugin for Tampermonkey / userscript builds",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "vite",
+    "vite-plugin",
+    "tampermonkey",
+    "userscript"
+  ],
+  "author": "koyori",
+  "license": "MIT",
+  "peerDependencies": {
+    "vite": "^8.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "typescript": "^5.7.0",
+    "vite": "^8.0.0"
+  }
+}