node-act v1.5.0

act

Simple Task Management

Quickly write, organize, and run node.js build scripts/tasks with act.

Install

$ npm install -g node-act

Setup

1. Add a directory named act-tasks to the root of your project.
2. For each task add a new script, task-name.js, to the act-tasks directory. The name of the file is the name of the task. The name must start with a lower-case letter, and the file should export a Task.

Use

$ cd <your-project-root>

# BASIC USE
$ act <task> [...-method]

# PASS VALUES
$ act <task=> <value>
$ act <task> <-method=> <value>
$ act <task=> <defaultMethodsValue> <-method=> <methodValue> <-method>

# RUN MULTIPLE TASKS
$ act <task> <task> <task>
$ act <task> <-method> <task> <task=> <value>

# SHOW HELP INFO
$ act
$ act ?
$ act -h
$ act --help

# SHOW VERSION
$ act -v
$ act --version

Tasks

All task scripts must export an object or function with the below properties.

Task with NO Methods

Task with Methods

Method

Config

To change the act config just add config.json to your act-tasks directory with your desired settings.

Shortcuts

You may create task aliases by adding an alias property to your config.json. The alias property's value should be an object with name => command pairs.

Example

{
  "alias": {
    "name": "task -method task= value -method"
  },
  "throw": false,
  "exit": true,
  "done": true
}

Other Details

contributing: see contributing guideline bugs/improvements: open an issue questions: imagineadamsmith@gmail.com

Happy Developing