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

``sh
npm install vite-build-userscripts

or

yarn add vite-build-userscripts

or

pnpm add vite-build-userscripts
`

Usage

`ts
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

#### Parameters

| Option | Type | Required | Description |
|----------------|----------------------------------------|----------|-------------------------------------------------------------------------------------------------|
| plugins | Plugin[] | No | Array of Vite plugins to include in the build process. |
| scripts | Array