# npm-run-message

> Allows you to print messages via npm run scripts.

Latest version **1.0.0** (published 2018-05-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install npm-run-message
pnpm add npm-run-message
yarn add npm-run-message
bun add npm-run-message
```

Provides the command `npm-run-message`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-05-16 |
| First published | 2018-05-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 35 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Justin Cuaresma |
| Maintainers | atleus |
| Keywords | npm, run, script, ci, cli, command-line, husky, commit, chalk, log, message |

## Links

- npm: https://www.npmjs.com/package/npm-run-message
- npm.io page: https://npm.io/package/npm-run-message

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [commander](https://npm.io/package/commander.md) ^2.15.1

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2018-05-16

## README

# npm-run-message

> Create a log message when running npm run scripts. Useful as verbose separators in npm command chains to give users more context as to what's happening

## Install

```
$ npm install npm-run-message --save-dev
```

## Usage

```
$ npm-run-message

  Usage
    $ npm-run-message <options>

  Options
    --message, -m "[message]"  Message to display
    --color, -c [color]  Color of message (only supports chalk colors)
    --padding, -p  Adds padding to top and bottom of message

  Examples
    $ npm-run-message -m "Hello World" -c yellow -p

    package.json
      "scripts": {
        "hello": "npm-run-message -m "Hello World" -c yellow -p && jest"
      },
```

See [supported colors](https://github.com/chalk/chalk#colors).

## Related

* [chalk](https://github.com/chalk/chalk) - API for this module

---
_Source: https://npm.io/package/npm-run-message · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._