violentmonkey

Violentmonkey

Violentmonkey provides userscripts support for browsers. It works on browsers with WebExtensions support.

More details can be found here.

Automated Builds for Testers

A test build is generated automatically for changes between beta releases. It can be installed as an unpacked extension in Chrome and Chromium-based browsers or as a temporary extension in Firefox. It's likely to have bugs so do an export in Violentmonkey settings first. This zip is available only if you're logged-in on GitHub site. Open an entry in the CI workflows table and click the Violentmonkey-... link at the bottom to download it.

Environment Variables

The following environment variables will be injected at compilation time for some features to work:

• SYNC_GOOGLE_CLIENT_ID / SYNC_GOOGLE_CLIENT_SECRET - Google sync service
• SYNC_ONEDRIVE_CLIENT_ID / SYNC_ONEDRIVE_CLIENT_SECRET - OneDrive sync service

Workflows

Development

Make sure Node.js greater than v10.0 and Yarn v1.x is installed.

# Install dependencies
$ yarn

# Watch and compile
$ yarn dev

Then load the extension from 'dist/'.

Building

After a new (pre)release is created, we should build the project and upload to web stores.

# Build for normal releases
$ yarn build

# Build for self-hosted release that has an update_url
$ yarn build:selfHosted

Release

Just create a tag and push it.

When a tag is pushed to GitHub, a (pre)release will be created with assets built by GitHub Actions.

# Create a prerelease
$ yarn bump

# Create a patch release
$ yarn version --patch

Related Projects

• Violentmonkey for Opera Presto
• Violentmonkey for Maxthon