heap-task-runner v1.0.0

Heap

A simple, no-nonsense task runner for Node.js projects.

Installation

To install the Heap CLI, use NPM:

npm install heap-task-runner -g

Usage

Once you install Heap through NPM, the CLI can be used globally now:

heap --help

Configuration

Heap will only work properly if its configuration file is present in the directory, named .heaprc.json. This is a simple JSON structure:

{
    "scripts": {
        "main": [{
            "task": "log",
            "message": "Hello, world!"
        }]
    }
}

Each script is specified under scripts, with the key being the script name (--script option) and the value being an array of tasks. Note that if no script is specified, Heap will default to the main script.