https://github.com/runnerty/notifier-console

Runnerty module: Console notifier.
https://github.com/runnerty/notifier-console

console log notifier runnerty

Last synced: about 1 month ago
JSON representation

Runnerty module: Console notifier.

• Host: GitHub
• URL: https://github.com/runnerty/notifier-console
• Owner: runnerty
• License: mit
• Created: 2018-01-26T07:30:41.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2023-07-19T00:59:58.000Z (over 1 year ago)
• Last Synced: 2024-11-13T12:44:40.765Z (about 2 months ago)
• Topics: console, log, notifier, runnerty
• Language: JavaScript
• Size: 112 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

  

  
Smart Processes Management


[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Dependency Status][david-badge]][david-badge-url]



  



A simple console notifier for [Runnerty]

### Installation:

Through NPM

```bash

npm i @runnerty/notifier-console

```

You can also add modules to your project with [runnerty]

```bash

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:

```bash

runnerty add @runnerty/notifier-console

```

### Configuration sample:

Add in [config.json]:

```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](http://i.imgur.com/IKHy3vC.png)

```json

{

  "notifications": {

    "on_end": [

      {

        "id": "console_default",

        "message": "Things done right.",

        "mode": "info"

      }

    ]

}

```

## warn mode

![warning notification on console](http://i.imgur.com/TdMmGQz.png)

```json

{

  "id": "console_default",

  "message": "We are out of candy!",

  "mode": "warn"

}

```

## error mode

![error notification on console](http://i.imgur.com/s2D0DxD.png)

```json

{

  "id": "console_default",

  "message": "Oh no.",

  "mode": "error"

}

```

[Runnerty]: https://www.runnerty.io

[downloads-image]: https://img.shields.io/npm/dm/@runnerty/notifier-console.svg

[npm-url]: https://www.npmjs.com/package/@runnerty/notifier-console

[npm-image]: https://img.shields.io/npm/v/@runnerty/notifier-console.svg

[david-badge]: https://david-dm.org/runnerty/notifier-console.svg

[david-badge-url]: https://david-dm.org/runnerty/notifier-console

[config.json]: http://docs.runnerty.io/config/

[plan.json]: http://docs.runnerty.io/plan/