https://github.com/violentmonkey/generator-userscript

A yeoman generator to create a userscript project rapidly
https://github.com/violentmonkey/generator-userscript

Last synced: 6 days ago
JSON representation

A yeoman generator to create a userscript project rapidly

• Host: GitHub
• URL: https://github.com/violentmonkey/generator-userscript
• Owner: violentmonkey
• Created: 2020-03-08T10:14:46.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-09-09T02:18:59.000Z (2 months ago)
• Last Synced: 2024-09-09T03:35:32.711Z (2 months ago)
• Language: JavaScript
• Size: 117 KB
• Stars: 93
• Watchers: 4
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# @violentmonkey/generator-userscript

![NPM](https://img.shields.io/npm/v/@violentmonkey/generator-userscript.svg)

Yeoman generator to create a workspace for userscript easily.

## Prerequisites

- Node.js >= 18

## Features

- TypeScript

- [SolidJS](https://www.solidjs.com/)

- CSS modules (applied for `.module.css` files)

- [UnoCSS](https://unocss.dev/)

Read [this](https://violentmonkey.github.io/guide/using-modern-syntax/) for more details.

## Get Started

First of all, make a new directory for your userscript.

```sh

$ mkdir my-script

$ cd my-script

```

Then follow one of the options below to create the files.

### Option 1: npm

Please make sure your `npm` is up to date because in earlier versions (e.g. 8.12.x) there was a bug that prevented `npx` from installing the correct dependencies.

```bash

$ npm i npm -g

# Use the latest version from git

$ npx -p github:violentmonkey/generator-userscript -p yo yo @violentmonkey/userscript

```

### Option 2: pnpm

```bash

$ pnpm --package github:violentmonkey/generator-userscript --package yo dlx yo @violentmonkey/userscript

```