@qui-cli/log 3.0.1 → 4.0.0

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.
Files changed (4) hide show
  1. package/CHANGELOG.md +24 -11
  2. package/README.md +1 -1
  3. package/dist/Log.js +11 -3
  4. package/package.json +10 -11
package/CHANGELOG.md CHANGED
@@ -2,30 +2,43 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
4
4
 
5
- ## [3.0.1](https://github.com/battis/qui-cli/compare/log/3.0.0...log/3.0.1) (2025-08-04)
5
+ ## [4.0.0](https://github.com/battis/qui-cli/compare/log/3.1.0...log/4.0.0) (2025-11-07)
6
+
7
+ ### ⚠ BREAKING CHANGES
8
+
9
+ - **plugin@4.0.0** auto-document default arg values
10
+
11
+ ### Features
12
+
13
+ - **plugin@4.0.0** auto-document default arg values ([e01e157](https://github.com/battis/qui-cli/commit/e01e157f06a3a801628ca79366e3f0060be2322e))
6
14
 
15
+ ## [3.1.0](https://github.com/battis/qui-cli/compare/log/3.0.1...log/3.1.0) (2025-11-04)
16
+
17
+ ### Features
18
+
19
+ - standardize on modules labeling the options that they add to the usage man page ([eba86cd](https://github.com/battis/qui-cli/commit/eba86cd8a22a93aa6b6f19a3979272d87fe59274))
20
+
21
+ ## [3.0.1](https://github.com/battis/qui-cli/compare/log/3.0.0...log/3.0.1) (2025-08-04)
7
22
 
8
23
  ### Bug Fixes
9
24
 
10
- * update lagging peer dependency specs ([c6d2d4d](https://github.com/battis/qui-cli/commit/c6d2d4d141fc9a9389648d6cb2cab4bfc05f9e55))
25
+ - update lagging peer dependency specs ([c6d2d4d](https://github.com/battis/qui-cli/commit/c6d2d4d141fc9a9389648d6cb2cab4bfc05f9e55))
11
26
 
12
27
  ## [3.0.0](https://github.com/battis/qui-cli/compare/log/2.2.2...log/3.0.0) (2025-08-02)
13
28
 
14
-
15
29
  ### ⚠ BREAKING CHANGES
16
30
 
17
- * rename @battis/qui-cli.log --> @qui-cli/log
18
-
19
- * rename @battis/qui-cli.log --> @qui-cli/log ([ba2ef7b](https://github.com/battis/qui-cli/commit/ba2ef7b08e9289d326d18cd6a8a3be1f8f81b8ce))
31
+ - rename @battis/qui-cli.log --> @qui-cli/log
20
32
 
33
+ - rename @battis/qui-cli.log --> @qui-cli/log ([ba2ef7b](https://github.com/battis/qui-cli/commit/ba2ef7b08e9289d326d18cd6a8a3be1f8f81b8ce))
21
34
 
22
35
  ### Bug Fixes
23
36
 
24
- * update dependencies to renamed @qui-cli/colors ([ff80e86](https://github.com/battis/qui-cli/commit/ff80e8625ef98834afdf04e57bfedb1906834e2b))
25
- * update dependencies to renamed @qui-cli/core ([f834c5a](https://github.com/battis/qui-cli/commit/f834c5a475f908585f1e17865917a092516168a0))
26
- * update dependencies to renamed @qui-cli/env ([5ff9ee8](https://github.com/battis/qui-cli/commit/5ff9ee844222dc4c73fd8cbdbfeaaa16541a158b))
27
- * update dependencies to renamed @qui-cli/plugin ([117ea85](https://github.com/battis/qui-cli/commit/117ea85256ec69c807c5b56293546d9c350fd43f))
28
- * update dependencies to renamed @qui-cli/root ([488daa7](https://github.com/battis/qui-cli/commit/488daa7a82730125481945b5eb8db960972ac225))
37
+ - update dependencies to renamed @qui-cli/colors ([ff80e86](https://github.com/battis/qui-cli/commit/ff80e8625ef98834afdf04e57bfedb1906834e2b))
38
+ - update dependencies to renamed @qui-cli/core ([f834c5a](https://github.com/battis/qui-cli/commit/f834c5a475f908585f1e17865917a092516168a0))
39
+ - update dependencies to renamed @qui-cli/env ([5ff9ee8](https://github.com/battis/qui-cli/commit/5ff9ee844222dc4c73fd8cbdbfeaaa16541a158b))
40
+ - update dependencies to renamed @qui-cli/plugin ([117ea85](https://github.com/battis/qui-cli/commit/117ea85256ec69c807c5b56293546d9c350fd43f))
41
+ - update dependencies to renamed @qui-cli/root ([488daa7](https://github.com/battis/qui-cli/commit/488daa7a82730125481945b5eb8db960972ac225))
29
42
 
30
43
  ## [2.2.2](https://github.com/battis/qui-cli/compare/log/2.2.1...log/2.2.2) (2025-06-23)
31
44
 
package/README.md CHANGED
@@ -14,7 +14,7 @@ npm install @qui-cli/log @qui-cli/core
14
14
  ## Usage
15
15
 
16
16
  ```ts
17
- import { Log } from '@qui-cli/env';
17
+ import { Log } from '@qui-cli/log';
18
18
  import { Core } from '@qui-cli/core';
19
19
 
20
20
  // process user-provided command-line arguments
package/dist/Log.js CHANGED
@@ -14,7 +14,7 @@ let stdoutLevel = 'info';
14
14
  let fileLevel = 'all';
15
15
  let levels = DefaultLevels;
16
16
  let root = undefined;
17
- let transports = {
17
+ const transports = {
18
18
  console: new winston.transports.Console({
19
19
  format: winston.format.printf(({ message }) => message),
20
20
  level: stdoutLevel
@@ -86,16 +86,22 @@ export function options() {
86
86
  .join(', ')
87
87
  .replace(/, ([^,]+)$/, ', or $1');
88
88
  return {
89
+ man: [
90
+ {
91
+ level: 3,
92
+ text: 'Logging options'
93
+ }
94
+ ],
89
95
  opt: {
90
96
  logFilePath: {
91
97
  description: `Path to log file (optional)`
92
98
  },
93
99
  stdoutLevel: {
94
- description: `Log level to console stdout: ${levelsList} (default: ${Colors.quotedValue(`"${stdoutLevel}"`)})`,
100
+ description: `Log level to console stdout: ${levelsList}`,
95
101
  default: stdoutLevel
96
102
  },
97
103
  fileLevel: {
98
- description: `Log level to log file (if ${Colors.value('--logFilePath')} provided): ${levelsList} (default: ${Colors.quotedValue(`"${fileLevel}"`)})`,
104
+ description: `Log level to log file (if ${Colors.optionArg('--logFilePath')} provided): ${levelsList}`,
99
105
  default: fileLevel
100
106
  }
101
107
  }
@@ -113,8 +119,10 @@ export function syntaxColor(obj) {
113
119
  .replace(/: ("([^"]|\\")*")/g, `: ${Colors.quotedValue('$1')}`);
114
120
  }
115
121
  function namedLogMethod(level) {
122
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
116
123
  return (message, ...meta) => {
117
124
  if (typeof message != 'string') {
125
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
118
126
  if (meta.some((elt) => elt.color === false)) {
119
127
  if (message === undefined) {
120
128
  message = 'undefined';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@qui-cli/log",
3
- "version": "3.0.1",
3
+ "version": "4.0.0",
4
4
  "description": "@qui-cli Plugin: Standardized winston wrapper",
5
5
  "homepage": "https://github.com/battis/qui-cli/tree/main/packages/log#readme",
6
6
  "repository": {
@@ -18,23 +18,22 @@
18
18
  "types": "./dist/index.d.ts",
19
19
  "dependencies": {
20
20
  "ora": "^8.2.0",
21
- "strip-ansi": "^7.1.0",
22
- "winston": "^3.17.0"
21
+ "strip-ansi": "^7.1.2",
22
+ "winston": "^3.18.3",
23
+ "@qui-cli/colors": "3.1.0"
23
24
  },
24
25
  "devDependencies": {
25
26
  "@tsconfig/node20": "^20.1.6",
26
- "@types/node": "^24.1.0",
27
- "commit-and-tag-version": "^12.5.2",
27
+ "@types/node": "^24.10.0",
28
+ "commit-and-tag-version": "^12.6.0",
28
29
  "del-cli": "^6.0.0",
29
30
  "npm-run-all": "^4.1.5",
30
- "typescript": "^5.9.2",
31
- "@qui-cli/colors": "3.0.1",
32
- "@qui-cli/root": "3.0.1",
33
- "@qui-cli/plugin": "3.0.0"
31
+ "typescript": "^5.9.3",
32
+ "@qui-cli/plugin": "4.0.0",
33
+ "@qui-cli/root": "3.0.1"
34
34
  },
35
35
  "peerDependencies": {
36
- "@qui-cli/colors": "3.x",
37
- "@qui-cli/plugin": "3.x",
36
+ "@qui-cli/plugin": "4.x",
38
37
  "@qui-cli/root": "3.x"
39
38
  },
40
39
  "target": "node",