Skip to content
This repository was archived by the owner on Nov 26, 2024. It is now read-only.

kevinoid/userscript-template

Repository files navigation

Userscript Project Template

Build Status: Linux Build Status: Windows Coverage

A userscript (viz. Greasemonkey/Tampermonkey/Violentmonkey script) project template with codecov, coveralls, ESLint, github_changelog_generator, istanbul, JSDoc, and mocha.

It is the template that I am using for my own userscript projects, which represents my current preferences. I am not advocating for these choices nor this template specifically, although I am happy to discuss or explain any choices made herein. It is being published both for my own convenience and in case it may be useful to others with similar tastes.

It is based on my Node Project Template.

Features

Installation

This userscript can be installed by following the instructions to install in Greasemonkey, install in Tampermonkey, or install in any other userscript manager using:

https://raw.githubusercontent.com/kevinoid/userscript-template/master/script-name.user.js

Contributing

Contributions are welcome and very much appreciated! Please add tests where possible and ensure npm test passes.

If the desired change is large, complex, backwards-incompatible, can have significantly differing implementations, or may not be in scope for this project, opening an issue before writing the code can avoid frustration and save a lot of time and effort.

License

This project is available under the terms of the MIT License.

About

A userscript (viz. Greasemonkey/Tampermonkey/Violentmonkey script) project template with codecov, coveralls, ESLint, github_changelog_generator, istanbul, JSDoc, and mocha.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors