@aps.king/gorilla v0.1.3

Intro

Gorilla is a blazing fast, TypeScript build tool for creating better GreaseMonkey scripts. It handles the complex build chain, so you don't have to.

Input

helper.ts

export const hello = (name:string) => {
    console.log(`Hello ${name}!`);
}

main.ts

import { hello } from './helper';

hello('world');

package.json

...
"scripts": {
    "build": "gorilla --input ./main.ts --output ./script.user.js"
  },
...

Output

script.user.js

// ==UserScript==
// @name    New Userscript
// @namespace    http://tampermonkey.net/
// @version    0.1
// @description    Gorilla-built, rock-solid, Monkey script
// @updateURL    
// @downloadURL    
// @author    You
// @match    http://*/*
// Created with love using Gorilla
// ==/UserScript==

var hello = function (name) {
    console.log("Hello " + name + "!");
};

hello('world');

Options

Help (--help)

Display help menu.

eg.

gorilla --help

Input (--input, -i)

The input handler for your script.

eg.

gorilla --input ./my-input-file.ts ...

Output (--output, -o)

The input handler for your script.

Note: While not required, GreaseMonkey scripts should end with .user.js.

eg.

gorilla --output ./my-script.user.js ...

Config (--config, -c)

JSON input Gorilla config including GreaseMonkey metablock data.

eg.

gorilla --config ./my-config.json ...

Config

The config is based off of the officially supported MetaBlock items found here: https://wiki.greasespot.net/Metadata_Block

The following JSON keys are supported:

• author - (string) - Author of the script
• description - (string) - Description of the script
• exclude - (string[]) - URLs to exclude the script from
• grant - (string[]) - Permissions to grant to the script
• icon - (string) - Icon for the script
• include - (string[]) - URLs to include the script in
• match - (string[]) - URLs to match the script in
• name - (string) - Name of the script
• namespace - (string) - Namespace of the script
• noframes - (string) - Whether or not to run in frames
• require - (string[]) - Scripts to include within the script
• resource - (string[]) - Resources to include within the script
• version - (string) - Version number of the script

If no config is supplied, the following default config is used:

{
  "name": "New Userscript",
  "namespace": "http://tampermonkey.net/",
  "version": "0.1",
  "description": "Gorilla-built, rock-solid, Monkey script",
  "updateURL": "",
  "downloadURL": "",
  "author": "You",
  "include": [],
  "match": ["http://*/*"],
  "grant": [],
}