Cross platform CLI Alerts with colors & colored symbols for success, info, warning, error.

Works on macOS, Linux, and Windows.

cli-alerts

Install

npm install cli-alerts

Usage

const alert = require('cli-alerts')

// Provide the type, msg, and name options.
alert({ type: `success`, msg: `Everything finished!` })
// Prints: ✔ SUCCESS Everything finished!

alert({ type: `success`, msg: `Everything finished!`, name: `DONE` })
// Prints: ✔ DONE Everything finished!

alert({ type: `warning`, msg: `You didn't add something!` })
// Prints: ⚠ WARNING You didn't add something!

alert({ type: `info`, msg: `Awais is awesome!` })
// Prints: ℹ INFO Awais is awesome!

alert({ type: `error`, msg: `Something went wrong!` })
// Prints: ✖ ERROR Something went wrong!

API

alert(options)

❯ options

Type: object Default: {}

You can specify the options below.

❯ type

Type: string Default: error

❯ msg

Type: string Default: You forgot to define all options. (Error message)

❯ name

Type: string Default: '' (Empty string)

KEY: 📦 NEW, 👌 IMPROVE, 🐛 FIX, 📖 DOC, 🚀 RELEASE, and 🤖 TEST

I use Emoji-log, you should try it and simplify your git commits.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.