msg-attention
v1.0.0
Published
Display attention-grabbing messages in the terminal
Downloads
4
Maintainers
Readme
msg-attention
Display attention-grabbing messages in the terminal.
Table of Contents
Background
Forked from @dylang/grunt-attention, as I needed to use it outside of Grunt.
Install
npm install --save msg-attention
or
yarn add msg-attention
Usage
TODO
API
message
required
Text to display.
border
optional
Border style.
Included styles: thin
, double
, stacked
, comment
.
Single character repeated: Provide a single character and it will repeat it as the border such as !
or *
.
New style: Provide a 9-character string for all sides. See lib/borders.js
for examples.
borderColor
optional
Color for the border.
Choices are: black
, red
, green
, yellow
, blue
, magenta
, cyan
, white
, gray
,
bgBlack
, bgRed
, bgGreen
, bgYellow
, bgBlue
, bgMagenta
, bgCyan
, bgWhite
, bgGray
.
Currently you can't set both the foreground and the background, that will be resolved in a future release.
More examples
Tests
Run npm test
to lint and run the tests.
Contribute
See the contribute file!
PRs accepted.
Small note: If editing the Readme, please conform to the standard-readme specification.
Thanks to
@dylang for the idea, the original package and for releasing both of them under the MIT license.