# winchalk

> An npm module that combines Winston and chalk for a yummy and colorful console logger.

Latest version **1.0.1** (published 2023-11-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install winchalk
pnpm add winchalk
yarn add winchalk
bun add winchalk
```

## 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.1 |
| Published | 2023-11-03 |
| First published | 2023-11-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 41 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Avengineering |
| Maintainers | avengineering |
| Keywords | winston, chalk, logger, colorize |

## Links

- npm: https://www.npmjs.com/package/winchalk
- Repository: https://github.com/AvengineeringCreates/Winchalk
- Homepage: https://github.com/AvengineeringCreates/Winchalk#readme
- Issues: https://github.com/AvengineeringCreates/Winchalk/issues
- npm.io page: https://npm.io/package/winchalk

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [winston](https://npm.io/package/winston.md) ^3.11.0

## 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.1 (latest) — 2023-11-03
- 1.0.0 — 2023-11-03

## README

# Winchalk
An npm module that combines Winston and chalk for a yummy and colorful console logger.

Winchalk is just a Winston logger colorized with chalk. It is small and simple.

I made this module for myself, and though it's easy to customize your own Winston logger I thought I would let it out into the world since I use it all the time!

## Documentation

Winchalk exports a Winston logger. For Winston documentation, read here:
https://github.com/winstonjs/winston#readme

The log levels are as follows:
```
const Winchalk = require('winchalk');

Winchalk.critical("Critical is log level 0. I output in black on a red background.");
Winchalk.error("Error is log level 1. I output in red.");
Winchalk.warn("Warn is log level 2. I output in yellow.");
Winchalk.connection("Connection is log level 3. I output in green.");
Winchalk.info("Info is log level 4. I output in white.");
Winchalk.msgin("Msgin is log level 5. I output in cyan.");
Winchalk.msgout("Msgout is log level 6. I also output in cyan.");
Winchalk.start("Start is log level 7. I output in bright green.");
Winchalk.debug("Debug is log level 8. I output in gray.");
Winchalk.silly("Silly is log level 9. I output in magenta.");
```
This results in the following output to console:\
![A sample output of the Winchalk console colorizer given the example input.](sample.png)

By default, Winchalk log level is set to 'silly', meaning it logs everything. For more information on log levels, see the [Winston documentation](https://github.com/winstonjs/winston#readme).

## Tests
You can see what the outputs look like in your own console by running the test.\
`$ npm run test`

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