Skip to content
This repository was archived by the owner on Feb 15, 2022. It is now read-only.

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

README.md

plugin-tester

A localhost plugin tester by querying a local plugin and hosting the response on localhost:5000

Usage

Install the plugin-tester as a global dependency.

npm install -g 

Bootstrap a new plugin

plugin-tester init "awesome-plugin"

Run a plugin

cd awesome-plugin
npm install
plugin-tester run

Options

init <name>

Bootstraps a new plugin with the given name.

run <optional path>

Runs the plugin in a local server at localhost:5000|port

The path is optional, if not supplied then the current directory is used.

-p --port

The local server port, defaults to 5000.

-w --watch

Enables watching the plugin module for changes and automatically requerying the plugin.

-c <path> --config

The path to a JSON configuration which will be used to query the plugin with. If the config path is not supplied the plugin-tester will attempt to find a config.json in the plugin directory.

The JSON must be in the following format:

{
    "first_name": {
        "value": "James"
    },
    "last_name": {
        "value": "Bond"
    }
}