Skip to content

runnerty/notifier-console

Repository files navigation

Smart Processes Management

NPM version Downloads Dependency Status code style: prettier

A simple console notifier for Runnerty

Installation:

Through NPM

npm i @runnerty/notifier-console

You can also add modules to your project with runnerty

npx runnerty add @runnerty/notifier-console

This command installs the module in your project, adds example configuration in your config.json and creates an example plan of use.

If you have installed runnerty globally you can include the module with this command:

runnerty add @runnerty/notifier-console

Configuration sample:

Add in config.json:

{
  "notifiers": [
    {
      "id": "console_default",
      "type": "@runnerty-notifier-console"
    }
  ]
}

Usage

Define the type of console message that you need (or prefer) in your process' events

info mode

info notification on console

{
  "notifications": {
    "on_end": [
      {
        "id": "console_default",
        "message": "Things done right.",
        "mode": "info"
      }
    ]
}

warn mode

warning notification on console

{
  "id": "console_default",
  "message": "We are out of candy!",
  "mode": "warn"
}

error mode

error notification on console

{
  "id": "console_default",
  "message": "Oh no.",
  "mode": "error"
}