Skip to content

Commit 6b97712

Browse files
committed
feat(kero): prepare for public release
1 parent e346f34 commit 6b97712

3 files changed

Lines changed: 80 additions & 6 deletions

File tree

packages/logger/LICENSE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
MIT License
2+
3+
Copyright (c) 2025 prosdev
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+

packages/logger/README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
11
# @lytics/kero
22

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
419

520
## Installation
621

@@ -226,7 +241,27 @@ This package has zero runtime dependencies. It uses only Node.js built-ins:
226241
- `process.stdout` / `process.stderr` for output
227242
- `process.env` for color detection
228243

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+
229264
## License
230265

231-
MIT
266+
MIT © [Lytics](https://github.com/lytics)
232267

packages/logger/package.json

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"name": "@lytics/kero",
3-
"version": "0.1.0",
4-
"description": "Zero-dependency TypeScript logger",
5-
"private": true,
3+
"version": "1.0.0",
4+
"description": "Zero-dependency TypeScript logger with structured logging, multiple transports, and beautiful output",
5+
"private": false,
66
"main": "./dist/index.js",
77
"types": "./dist/index.d.ts",
88
"exports": {
@@ -14,6 +14,8 @@
1414
},
1515
"files": [
1616
"dist",
17+
"README.md",
18+
"LICENSE",
1719
"!dist/**/*.test.js",
1820
"!dist/**/*.test.d.ts",
1921
"!dist/**/*.test.d.ts.map",
@@ -31,11 +33,26 @@
3133
"keywords": [
3234
"logger",
3335
"logging",
36+
"structured-logging",
3437
"typescript",
35-
"zero-dependency"
38+
"nodejs",
39+
"zero-dependency",
40+
"pino",
41+
"winston",
42+
"json-logging",
43+
"pretty-logging"
3644
],
3745
"author": "Lytics",
3846
"license": "MIT",
47+
"repository": {
48+
"type": "git",
49+
"url": "https://github.com/lytics/dev-agent.git",
50+
"directory": "packages/logger"
51+
},
52+
"homepage": "https://github.com/lytics/dev-agent/tree/main/packages/logger#readme",
53+
"bugs": {
54+
"url": "https://github.com/lytics/dev-agent/issues"
55+
},
3956
"engines": {
4057
"node": ">=22"
4158
},

0 commit comments

Comments
 (0)