JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3
  • Score
    100M100P100Q40710F
  • License MIT

Task-runner is a node UI framework for task execution. Developer can only focus on the task logic.

Package Exports

  • terminal-task-runner

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (terminal-task-runner) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

terminal-task-runner

Terminal task execution system

Terminal-task-runner is a node UI framework for task execution. Developer can only focus on the task logic. Framework will generate the terminal menu for you.

terminal-task-runner is now used by sero-cli.

High-level overview

terminal-task-runner is runner system with a lovely terminal UI. Which also provide some cool features to ease the way of implementing tasks.

Installation

npm install terminal-task-runner --save

Usage

var TaskRunner = require('terminal-task-runner');

TaskRunner.createMenu({
    title: 'This is Header',
    subtitle: 'here is subTitle'
});

By doing above, you've created a very simple terminal menu as following:

How to write your own task

Welcome to play with the example as your skeleton.

API

TaskRunner.createMenu(options)

options

Type: Object

Options to pass to createMenu

options.title

Type: String Default: =====================

The title displayed on the top of the terminal ui.

options.subtitle

Type: String Default: --------------------

The subtitle displayed below the title.

options.width

Type: number Default: 100

menu width in columns.

options.x

Type: number Default: 3

top-left corner x offset.

options.y

Type: number Default: 2

top-left corner y offset.

options.taskDir

Type: String

The location of where the tasks placed.

LICENSE

MIT License