https://github.com/kkrishguptaa/trevenant
Beautiful Opinionated Logging for Node.js ✍️
https://github.com/kkrishguptaa/trevenant
Last synced: 2 months ago
JSON representation
Beautiful Opinionated Logging for Node.js ✍️
- Host: GitHub
- URL: https://github.com/kkrishguptaa/trevenant
- Owner: kkrishguptaa
- License: mit
- Created: 2022-12-26T12:00:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T18:25:26.000Z (2 months ago)
- Last Synced: 2025-03-11T19:32:32.251Z (2 months ago)
- Language: TypeScript
- Size: 1.54 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Trevenant
Beautiful Opinionated Logging for Node.js ✍️
## 🤓 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** 
```bash
npm install trevenant
```
#### 🐱**Yarn** 
```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
[](https://github.com/krshkun/trevenant/stargazers)