vite-build-userscripts

A minimal setup for building userscripts using Vite. This project provides a simple Vite-based workflow to author, develop and bundle userscripts (Tampermonkey / Greasemonkey / Violentmonkey) with modern tooling.

Features

• Type safe userscript headers
• Bundles implementation into a single *.user.js file
• Auto injects userscript headers as comments on top of the *.user.js file

Installation

npm install vite-build-userscripts
# or
yarn add vite-build-userscripts
# or
pnpm add vite-build-userscripts

Usage

import { buildUserscripts } from 'vite-build-userscripts'

await buildUserscripts({
  scripts: [
    {
      entry: 'src/path/to/my-script.ts',
      outDir: 'dist',
      outFileName: 'script.user.js'
      headers: {
        name: 'My Userscript',
        version: '1.0.0',
        description: 'A description of my userscript',
      }
    }
  ]
})

API Reference: buildUserscripts

buildUserscripts(options: BuildUserscriptsOptions): Promise<void>

Parameters

Script Properties

UserscriptHeaders Properties

The UserscriptHeaders type defines the metadata fields for the userscript. These fields are used to generate the userscript header comment. Below is a detailed list of all available fields: