logan-logger 1.1.0 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Logan Logger
|
|
2
2
|
|
|
3
3
|
[](https://github.com/llbbl/logan-logger-ts/actions/workflows/ci.yml)
|
|
4
|
-
[](https://www.npmjs.com/package/logan-logger)
|
|
5
5
|
[](https://jsr.io/@logan/logger)
|
|
6
6
|
|
|
7
7
|
A universal TypeScript logging library that works consistently across all JavaScript runtimes: Node.js, Deno, Bun, browsers, and WebAssembly environments.
|
|
@@ -20,17 +20,23 @@ A universal TypeScript logging library that works consistently across all JavaSc
|
|
|
20
20
|
## Quick Start
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
|
-
|
|
23
|
+
# NPM
|
|
24
|
+
npm install logan-logger
|
|
24
25
|
# or
|
|
25
|
-
pnpm add
|
|
26
|
+
pnpm add logan-logger
|
|
26
27
|
# or
|
|
27
|
-
yarn add
|
|
28
|
+
yarn add logan-logger
|
|
29
|
+
|
|
30
|
+
# JSR (Deno/Node.js)
|
|
31
|
+
deno add @logan/logger
|
|
32
|
+
# or
|
|
33
|
+
npx jsr add @logan/logger
|
|
28
34
|
```
|
|
29
35
|
|
|
30
36
|
### Basic Usage
|
|
31
37
|
|
|
32
38
|
```typescript
|
|
33
|
-
import { createLogger, LogLevel } from '
|
|
39
|
+
import { createLogger, LogLevel } from 'logan-logger';
|
|
34
40
|
|
|
35
41
|
// Create logger with automatic environment configuration
|
|
36
42
|
const logger = createLogger({
|
|
@@ -62,7 +68,7 @@ logger.debug(() => `Expensive computation: ${computeHeavyValue()}`);
|
|
|
62
68
|
|
|
63
69
|
#### Environment-Based Configuration
|
|
64
70
|
```typescript
|
|
65
|
-
import { createLoggerForEnvironment } from '
|
|
71
|
+
import { createLoggerForEnvironment } from 'logan-logger';
|
|
66
72
|
|
|
67
73
|
// Automatically configures based on NODE_ENV
|
|
68
74
|
const logger = createLoggerForEnvironment();
|
|
@@ -77,7 +83,7 @@ Logan Logger provides runtime-specific entry points for optimal bundling and typ
|
|
|
77
83
|
|
|
78
84
|
**🟢 Node.js with Winston Support:**
|
|
79
85
|
```typescript
|
|
80
|
-
import { createLogger, NodeLogger, createMorganStream } from '
|
|
86
|
+
import { createLogger, NodeLogger, createMorganStream } from 'logan-logger/node';
|
|
81
87
|
|
|
82
88
|
const logger = new NodeLogger({
|
|
83
89
|
transports: [
|
|
@@ -91,7 +97,7 @@ app.use(morgan('combined', { stream: createMorganStream(logger) }));
|
|
|
91
97
|
|
|
92
98
|
**🌐 Browser-Optimized (Webpack/Vite-Safe):**
|
|
93
99
|
```typescript
|
|
94
|
-
import { createLogger, BrowserLogger, PerformanceLogger } from '
|
|
100
|
+
import { createLogger, BrowserLogger, PerformanceLogger } from 'logan-logger/browser';
|
|
95
101
|
|
|
96
102
|
const logger = new PerformanceLogger();
|
|
97
103
|
|
|
@@ -102,7 +108,7 @@ logger.measure('api-duration', 'api-start');
|
|
|
102
108
|
|
|
103
109
|
**🦕 Deno-Optimized:**
|
|
104
110
|
```typescript
|
|
105
|
-
import { createLogger, BrowserLogger } from '
|
|
111
|
+
import { createLogger, BrowserLogger } from 'logan-logger/deno';
|
|
106
112
|
|
|
107
113
|
const logger = createLogger({ colorize: true });
|
|
108
114
|
logger.info('Deno application started');
|
|
@@ -110,7 +116,7 @@ logger.info('Deno application started');
|
|
|
110
116
|
|
|
111
117
|
**🥟 Bun-Optimized:**
|
|
112
118
|
```typescript
|
|
113
|
-
import { createLogger, NodeLogger } from '
|
|
119
|
+
import { createLogger, NodeLogger } from 'logan-logger/bun';
|
|
114
120
|
|
|
115
121
|
const logger = createLogger({ level: LogLevel.DEBUG });
|
|
116
122
|
logger.info('Bun application started');
|
|
@@ -118,7 +124,7 @@ logger.info('Bun application started');
|
|
|
118
124
|
|
|
119
125
|
**🔧 Auto-Detection (Generic):**
|
|
120
126
|
```typescript
|
|
121
|
-
import { createLogger } from '
|
|
127
|
+
import { createLogger } from 'logan-logger';
|
|
122
128
|
|
|
123
129
|
// Automatically selects appropriate logger based on runtime
|
|
124
130
|
const logger = createLogger();
|
|
@@ -126,7 +132,7 @@ const logger = createLogger();
|
|
|
126
132
|
|
|
127
133
|
#### Safe Data Handling
|
|
128
134
|
```typescript
|
|
129
|
-
import { filterSensitiveData } from '
|
|
135
|
+
import { filterSensitiveData } from 'logan-logger';
|
|
130
136
|
|
|
131
137
|
const userData = {
|
|
132
138
|
name: 'John Doe',
|
|
@@ -144,12 +150,12 @@ logger.info('User processed', safeData);
|
|
|
144
150
|
|
|
145
151
|
| Runtime | Import Path | Status | Implementation | Features |
|
|
146
152
|
|---------|-------------|--------|----------------|----------|
|
|
147
|
-
| Node.js 20+ |
|
|
148
|
-
| Bun |
|
|
149
|
-
| Browser |
|
|
150
|
-
| Deno | `@logan/logger/deno` | ✅ Basic | BrowserLogger adapter | Console logging (native implementation planned) |
|
|
151
|
-
| WebWorker |
|
|
152
|
-
| Auto-detect |
|
|
153
|
+
| Node.js 20+ | `logan-logger/node` | ✅ Full | Winston + Console | File logging, transports, Morgan integration |
|
|
154
|
+
| Bun | `logan-logger/bun` | ✅ Full | NodeLogger adapter | Same as Node.js |
|
|
155
|
+
| Browser | `logan-logger/browser` | ✅ Full | Console API | CSS styling, performance marks, grouping |
|
|
156
|
+
| Deno | `@logan/logger/deno` (JSR) | ✅ Basic | BrowserLogger adapter | Console logging (native implementation planned) |
|
|
157
|
+
| WebWorker | `logan-logger/browser` | ✅ Basic | Console adapter | Basic console logging |
|
|
158
|
+
| Auto-detect | `logan-logger` | ✅ Basic | Runtime detection | Automatic adapter selection |
|
|
153
159
|
|
|
154
160
|
## Configuration
|
|
155
161
|
|