|
1 | 1 | # @lytics/kero |
2 | 2 |
|
3 | | -Zero-dependency TypeScript logger inspired by Pino. |
| 3 | +Zero-dependency TypeScript logger with structured logging, multiple transports, and beautiful output. |
| 4 | + |
| 5 | +Inspired by [Pino](https://getpino.io/), built for modern TypeScript applications. |
| 6 | + |
| 7 | +## Features |
| 8 | + |
| 9 | +- 🚀 **Zero runtime dependencies** - Only uses Node.js built-ins |
| 10 | +- 📊 **Structured logging** - First-class support for objects and metadata |
| 11 | +- 🎨 **Beautiful output** - Pretty console output for development, JSON for production |
| 12 | +- ⚡ **Fast & lightweight** - Minimal overhead, maximum performance |
| 13 | +- 🔧 **TypeScript-first** - Full type safety out of the box |
| 14 | +- 🎯 **Child loggers** - Inherit configuration and add contextual data |
| 15 | +- ⏱️ **Built-in timers** - Measure operation duration easily |
| 16 | +- 🌈 **Icons support** - Visual scanning with Unicode or emoji icons |
| 17 | +- 📦 **ESM & CJS** - Works with both module systems |
| 18 | +- 🎭 **Multiple presets** - Development, production, and test configurations |
4 | 19 |
|
5 | 20 | ## Installation |
6 | 21 |
|
@@ -226,7 +241,27 @@ This package has zero runtime dependencies. It uses only Node.js built-ins: |
226 | 241 | - `process.stdout` / `process.stderr` for output |
227 | 242 | - `process.env` for color detection |
228 | 243 |
|
| 244 | +## Why Kero? |
| 245 | + |
| 246 | +**Kero** (ケロケロ) is the Japanese onomatopoeia for a frog's croak - the sound frogs make. Just like how a frog's call cuts through the noise to be heard clearly, kero helps your logs stand out with beautiful, structured output that's easy to read and understand. |
| 247 | + |
| 248 | +### Comparison with Other Loggers |
| 249 | + |
| 250 | +| Feature | Kero | Pino | Winston | Bunyan | |
| 251 | +|---------|------|------|---------|--------| |
| 252 | +| Zero dependencies | ✅ | ❌ | ❌ | ❌ | |
| 253 | +| TypeScript-first | ✅ | ❌ | ❌ | ❌ | |
| 254 | +| Pretty console output | ✅ | ⚠️ (separate package) | ✅ | ⚠️ (via CLI) | |
| 255 | +| Structured logging | ✅ | ✅ | ✅ | ✅ | |
| 256 | +| Child loggers | ✅ | ✅ | ✅ | ✅ | |
| 257 | +| Built-in timers | ✅ | ❌ | ✅ | ❌ | |
| 258 | +| Package size | ~15KB | ~100KB | ~300KB | ~200KB | |
| 259 | + |
| 260 | +## Contributing |
| 261 | + |
| 262 | +Contributions are welcome! Please see [CONTRIBUTING.md](https://github.com/lytics/dev-agent/blob/main/CONTRIBUTING.md) for guidelines. |
| 263 | + |
229 | 264 | ## License |
230 | 265 |
|
231 | | -MIT |
| 266 | +MIT © [Lytics](https://github.com/lytics) |
232 | 267 |
|
0 commit comments