https://github.com/anooprav7/cli-msg

Colorful Terminal log messages (multiple message types)
https://github.com/anooprav7/cli-msg

cli color command-line console javascript terminal-emulators themed-cli

Last synced: 2 months ago
JSON representation

Colorful Terminal log messages (multiple message types)

• Host: GitHub
• URL: https://github.com/anooprav7/cli-msg
• Owner: anooprav7
• License: mit
• Created: 2019-04-13T09:13:14.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T19:41:00.000Z (over 2 years ago)
• Last Synced: 2025-03-18T14:54:47.999Z (3 months ago)
• Topics: cli, color, command-line, console, javascript, terminal-emulators, themed-cli
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/cli-msg
• Size: 1.23 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cli-msg · [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/anooprav7/cli-msg/blob/master/LICENSE) [![npm version](https://img.shields.io/npm/v/cli-msg.svg?style=flat)](https://www.npmjs.com/package/cli-msg) [![CircleCI Status](https://circleci.com/gh/anooprav7/cli-msg.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/anooprav7/cli-msg) [![issues](https://img.shields.io/github/issues/anooprav7/cli-msg)](https://www.github.com/anooprav7/cli-msg/issues)

> Colored CLI messages for better log messages

![Home Image](https://cdn.jsdelivr.net/gh/anooprav7/cli-msg@master/docs/images/home_new.png)

## Install

```

yarn add cli-msg

npm install cli-msg --save

```

## Naming conventions used

#### Badge

![Badge Image](https://cdn.jsdelivr.net/gh/anooprav7/cli-msg@master/docs/images/b.png)

-   Badge text refers to the text with primary color applied to the background.

#### Message

![Message Image](https://cdn.jsdelivr.net/gh/anooprav7/cli-msg@master/docs/images/m.png)

-   Message text refers to the colored text with the transparent background.

## Usage

### Message type usage

```js

const { success } = require('cli-msg');

// only 1 argument

success('Lorem ipsum dolor sit amet');

```

![One Argument](https://cdn.jsdelivr.net/gh/anooprav7/cli-msg@master/docs/images/one_argument.png)

```js

// 2 or more arguments

// 1st argument is shown in badge text and remaining args shown as one message

success('Lorem', 'ipsum', ' dolor', ' sit', ' amet');

```

![Many Arguments](https://cdn.jsdelivr.net/gh/anooprav7/cli-msg@master/docs/images/many_arguments.png)

```js

// Specific message styles

// b - badge style type

// Only badge style text, no message text

success.b('Lorem ipsum dolor sit amet');

```

![b Function](https://cdn.jsdelivr.net/gh/anooprav7/cli-msg@master/docs/images/b.png)

```js

// m - message style type

// Only message style text, no badge text

// All arguments are joined together for the message

success.m('Lorem ipsum dolor', ' sit amet');

```

![m Function](https://cdn.jsdelivr.net/gh/anooprav7/cli-msg@master/docs/images/m.png)

```js

// wb - with default badge - Eg. info will have 'INFO' as the badge text

// message with badge text 'SUCCESS'

success.wb('Lorem ipsum dolor sit amet');

```

![wb Function](https://cdn.jsdelivr.net/gh/anooprav7/cli-msg@master/docs/images/wb.png)

#### Same applies to success, warn, log, error, info message types.

### indent

This function is used to position the cursor according to your choice using

1. nl - newline (/n)

2. tab - tab (/t)

3. space - space (' ')

The inner functions are cascaded.

##### Sample usage

```js

const { indent } = require('cli-msg');

warn.b('Lorem ipsum dolor sit amet');

indent

	.nl(2) // New Line

	.tab(3) // Tab Space

	.space(5); // Space

error.b('Lorem ipsum dolor sit amet');

```

![Indent Function](https://cdn.jsdelivr.net/gh/anooprav7/cli-msg@master/docs/images/indent.png)

## [License](LICENSE)

MIT