@optique/logtape 0.10.0-dev.288 → 0.10.0-dev.290
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 +7 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -64,12 +64,12 @@ const result = parse(parser, ["--log-level=debug"]);
|
|
|
64
64
|
~~~~
|
|
65
65
|
|
|
66
66
|
Features:
|
|
67
|
+
|
|
67
68
|
- Case-insensitive parsing (`"DEBUG"`, `"Debug"`, `"debug"` all work)
|
|
68
69
|
- Valid levels: `"trace"`, `"debug"`, `"info"`, `"warning"`, `"error"`,
|
|
69
70
|
`"fatal"`
|
|
70
71
|
- Provides suggestions for shell completion
|
|
71
72
|
|
|
72
|
-
|
|
73
73
|
### `verbosity()`
|
|
74
74
|
|
|
75
75
|
A parser for accumulating `-v` flags to determine log level.
|
|
@@ -96,11 +96,11 @@ parse(parser, ["-v", "-v", "-v"]);
|
|
|
96
96
|
~~~~
|
|
97
97
|
|
|
98
98
|
Options:
|
|
99
|
+
|
|
99
100
|
- `short`: Short option name (default: `"-v"`)
|
|
100
101
|
- `long`: Long option name (default: `"--verbose"`)
|
|
101
102
|
- `baseLevel`: Starting log level (default: `"warning"`)
|
|
102
103
|
|
|
103
|
-
|
|
104
104
|
### `debug()`
|
|
105
105
|
|
|
106
106
|
A simple boolean flag parser for enabling debug logging.
|
|
@@ -121,12 +121,12 @@ parse(parser, ["--debug"]);
|
|
|
121
121
|
~~~~
|
|
122
122
|
|
|
123
123
|
Options:
|
|
124
|
+
|
|
124
125
|
- `short`: Short option name (default: `"-d"`)
|
|
125
126
|
- `long`: Long option name (default: `"--debug"`)
|
|
126
127
|
- `debugLevel`: Level when flag is present (default: `"debug"`)
|
|
127
128
|
- `normalLevel`: Level when flag is absent (default: `"info"`)
|
|
128
129
|
|
|
129
|
-
|
|
130
130
|
### `logOutput()`
|
|
131
131
|
|
|
132
132
|
A parser for log output destination. Accepts `-` for console output or a file
|
|
@@ -152,7 +152,6 @@ const result2 = parse(parser, ["--log-output=/var/log/app.log"]);
|
|
|
152
152
|
const sink = await createSink(result1.value.output);
|
|
153
153
|
~~~~
|
|
154
154
|
|
|
155
|
-
|
|
156
155
|
### `loggingOptions()`
|
|
157
156
|
|
|
158
157
|
A preset that combines log level and log output options into a single group.
|
|
@@ -185,28 +184,31 @@ const parser3 = object({
|
|
|
185
184
|
Configuration options vary by level type:
|
|
186
185
|
|
|
187
186
|
**`level: "option"`**:
|
|
187
|
+
|
|
188
188
|
- `long`: Long option name (default: `"--log-level"`)
|
|
189
189
|
- `short`: Short option name (default: `"-l"`)
|
|
190
190
|
- `default`: Default log level (default: `"info"`)
|
|
191
191
|
|
|
192
192
|
**`level: "verbosity"`**:
|
|
193
|
+
|
|
193
194
|
- `short`: Short option name (default: `"-v"`)
|
|
194
195
|
- `long`: Long option name (default: `"--verbose"`)
|
|
195
196
|
- `baseLevel`: Base log level (default: `"warning"`)
|
|
196
197
|
|
|
197
198
|
**`level: "debug"`**:
|
|
199
|
+
|
|
198
200
|
- `short`: Short option name (default: `"-d"`)
|
|
199
201
|
- `long`: Long option name (default: `"--debug"`)
|
|
200
202
|
- `debugLevel`: Level when flag is present (default: `"debug"`)
|
|
201
203
|
- `normalLevel`: Level when flag is absent (default: `"info"`)
|
|
202
204
|
|
|
203
205
|
Common options:
|
|
206
|
+
|
|
204
207
|
- `output.enabled`: Whether to enable log output option (default: `true`)
|
|
205
208
|
- `output.long`: Long option name for output (default: `"--log-output"`)
|
|
206
209
|
- `groupLabel`: Label for option group in help text (default:
|
|
207
210
|
`"Logging options"`)
|
|
208
211
|
|
|
209
|
-
|
|
210
212
|
### `createLoggingConfig()`
|
|
211
213
|
|
|
212
214
|
Converts parsed logging options into a LogTape configuration object.
|
|
@@ -233,7 +235,6 @@ if (result.success) {
|
|
|
233
235
|
}
|
|
234
236
|
~~~~
|
|
235
237
|
|
|
236
|
-
|
|
237
238
|
### `createConsoleSink()`
|
|
238
239
|
|
|
239
240
|
Creates a console sink with configurable stream selection.
|
|
@@ -254,7 +255,6 @@ const sink3 = createConsoleSink({
|
|
|
254
255
|
});
|
|
255
256
|
~~~~
|
|
256
257
|
|
|
257
|
-
|
|
258
258
|
### `createSink()`
|
|
259
259
|
|
|
260
260
|
Creates a LogTape sink from a `LogOutput` value.
|