# trevenant

> Beautiful Opinionated Logging for Node.js ✍️

Latest version **1.0.0** (published 2022-12-26) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-12-26 |
| First published | 2022-12-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 6.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Krish Gupta |
| Maintainers | krshkun |
| Keywords | logging, logger, logs, log |

## Links

- npm: https://www.npmjs.com/package/trevenant
- Repository: https://github.com/krshkun/trevenant
- Homepage: https://github.com/krshkun/trevenant#readme
- Issues: https://github.com/krshkun/trevenant/issues
- npm.io page: https://npm.io/package/trevenant

## Dependencies (3)

- [dayjs](https://npm.io/package/dayjs.md) ^1.11.7
- [consola](https://npm.io/package/consola.md) ^2.15.3
- [pretty-error](https://npm.io/package/pretty-error.md) ^4.0.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.0 (latest) — 2022-12-26

## README

<!-- markdownlint-disable-next-line -->
<div align="center"><img height="100px" width="100px" src="https://github.com/krshkun/trevenant/raw/main/.github/assets/trevenant.png"><br><h1>Trevenant</h1><h5>Beautiful Opinionated Logging for Node.js ✍️</h5></div>

## 🤓 Benefits

- [x] **Beautiful** - Beautifully formatted logs with colors and symbols
- [x] **Error Handling** - Error handling with stack traces
- [x] **Readable** - Readable logs with proper indentation

## ❓ Why do I use a logger?

Default logging is not very readable. It's hard to distinguish between different log levels and it's hard to read the stack trace. Trevenant fixes this by providing a beautiful and readable logging experience.

`console.log` just dumps the data to the console. Trevenant provides a structured logging experience by providing a consistent format for all the logs.

## 🌟 Installation

There are various ways to install trevenant. Like package managers, content delivery networks, local copies...

### 📦 Package Managers

#### 💝 **NPM** ![Npm Downloads](https://img.shields.io/npm/dt/trevenant?style=flat-square)

```bash
npm install trevenant
```

#### 🐱**Yarn** ![Yarn Downloads](https://img.shields.io/npm/dt/trevenant?style=flat-square)

```bash
yarn add trevenant
```

## ✨ Usage

Trevenant is a simple logger. It provides a simple API to log messages.

```js
const { Trevenant } = require('trevenant')

const logger = new Trevenant()

logger.info('Hello World!')

// Other log levels

logger.debug('Hello World!')
logger.success('Hello World!')
logger.warn('Hello World!')
logger.error('Hello World!')
logger.fatal(new Error('Errrorrilla'))
```

## 📞 We're Ready To Support

* [ ] Discord server (Coming Soon)
* [x] [GitHub discussions](https://github.com/krshkun/trevenant/discussions)
* [x] [Bug handler](https://github.com/krshkun/trevenant/issues)

## ❤ Thanks to our supporters

[![GitHub Stargazers](https://reporoster.com/stars/krshkun/trevenant)](https://github.com/krshkun/trevenant/stargazers)

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