fix(progress): add debug option which sets out verbosity

remedyred · Aug 9, 2023 · fca2155 · fca2155
1 parent cdb6bba
commit fca2155
Show file tree

Hide file tree

Showing 8 changed files with 141 additions and 3 deletions.
diff --git a/packages/progress/docs/classes/MultiProgress.md b/packages/progress/docs/classes/MultiProgress.md
@@ -27,9 +27,14 @@ https://github.com/npkgz/cli-progress
 - [options](MultiProgress.md#options)
 - [out](MultiProgress.md#out)
 
+### Accessors
+
+- [isDebug](MultiProgress.md#isdebug)
+
 ### Methods
 
 - [create](MultiProgress.md#create)
+- [debug](MultiProgress.md#debug)
 - [eta](MultiProgress.md#eta)
 - [fail](MultiProgress.md#fail)
 - [finish](MultiProgress.md#finish)
@@ -107,6 +112,20 @@ ___
 
 [Progress](Progress.md).[out](Progress.md#out)
 
+## Accessors
+
+### isDebug
+
+• `get` **isDebug**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+Progress.isDebug
+
 ## Methods
 
 ### create
@@ -127,6 +146,26 @@ Create a child progress bar
 
 ___
 
+### debug
+
+▸ **debug**(`value?`): [`MultiProgress`](MultiProgress.md)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `value` | `boolean` | `true` |
+
+#### Returns
+
+[`MultiProgress`](MultiProgress.md)
+
+#### Inherited from
+
+[Progress](Progress.md).[debug](Progress.md#debug)
+
+___
+
 ### eta
 
 ▸ **eta**(): `string` \| `number`

diff --git a/packages/progress/docs/classes/MultiProgressChild.md b/packages/progress/docs/classes/MultiProgressChild.md
@@ -17,8 +17,13 @@ Multi-progress child bar
 - [options](MultiProgressChild.md#options)
 - [out](MultiProgressChild.md#out)
 
+### Accessors
+
+- [isDebug](MultiProgressChild.md#isdebug)
+
 ### Methods
 
+- [debug](MultiProgressChild.md#debug)
 - [eta](MultiProgressChild.md#eta)
 - [fail](MultiProgressChild.md#fail)
 - [finish](MultiProgressChild.md#finish)
@@ -67,8 +72,42 @@ ___
 
 [Progress](Progress.md).[out](Progress.md#out)
 
+## Accessors
+
+### isDebug
+
+• `get` **isDebug**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+Progress.isDebug
+
 ## Methods
 
+### debug
+
+▸ **debug**(`value?`): [`MultiProgressChild`](MultiProgressChild.md)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `value` | `boolean` | `true` |
+
+#### Returns
+
+[`MultiProgressChild`](MultiProgressChild.md)
+
+#### Inherited from
+
+[Progress](Progress.md).[debug](Progress.md#debug)
+
+___
+
 ### eta
 
 ▸ **eta**(): `string` \| `number`

diff --git a/packages/progress/docs/classes/Progress.md b/packages/progress/docs/classes/Progress.md
@@ -26,8 +26,13 @@ https://github.com/npkgz/cli-progress
 - [options](Progress.md#options)
 - [out](Progress.md#out)
 
+### Accessors
+
+- [isDebug](Progress.md#isdebug)
+
 ### Methods
 
+- [debug](Progress.md#debug)
 - [eta](Progress.md#eta)
 - [fail](Progress.md#fail)
 - [finish](Progress.md#finish)
@@ -69,8 +74,34 @@ ___
 
 • **out**: `Out`
 
+## Accessors
+
+### isDebug
+
+• `get` **isDebug**(): `boolean`
+
+#### Returns
+
+`boolean`
+
 ## Methods
 
+### debug
+
+▸ **debug**(`value?`): [`Progress`](Progress.md)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `value` | `boolean` | `true` |
+
+#### Returns
+
+[`Progress`](Progress.md)
+
+___
+
 ### eta
 
 ▸ **eta**(): `string` \| `number`

diff --git a/packages/progress/docs/interfaces/MultiProgressChildConfig.md b/packages/progress/docs/interfaces/MultiProgressChildConfig.md
@@ -13,6 +13,7 @@
 - [autoStart](MultiProgressChildConfig.md#autostart)
 - [config](MultiProgressChildConfig.md#config)
 - [current](MultiProgressChildConfig.md#current)
+- [debug](MultiProgressChildConfig.md#debug)
 - [id](MultiProgressChildConfig.md#id)
 - [message](MultiProgressChildConfig.md#message)
 - [name](MultiProgressChildConfig.md#name)
@@ -53,6 +54,16 @@ ___
 
 ___
 
+### debug
+
+• `Optional` **debug**: `boolean`
+
+#### Inherited from
+
+[ProgressConfig](ProgressConfig.md).[debug](ProgressConfig.md#debug)
+
+___
+
 ### id
 
 • **id**: `string`

diff --git a/packages/progress/docs/interfaces/ProgressConfig.md b/packages/progress/docs/interfaces/ProgressConfig.md
@@ -13,6 +13,7 @@
 - [autoStart](ProgressConfig.md#autostart)
 - [config](ProgressConfig.md#config)
 - [current](ProgressConfig.md#current)
+- [debug](ProgressConfig.md#debug)
 - [message](ProgressConfig.md#message)
 - [name](ProgressConfig.md#name)
 - [out](ProgressConfig.md#out)
@@ -39,6 +40,12 @@ ___
 
 ___
 
+### debug
+
+• `Optional` **debug**: `boolean`
+
+___
+
 ### message
 
 • **message**: `string`

diff --git a/packages/progress/src/MultiProgress.class.ts b/packages/progress/src/MultiProgress.class.ts
@@ -77,7 +77,7 @@ export class MultiProgress extends Progress {
 	}
 
 	protected setup(): this {
-		if (!this.out.isVerbose() && this.id) {
+		if (!this.isDebug && this.id) {
 			this.multibar = new cliProgress.MultiBar(makeProgressConfig(this.options), cliProgress.Presets.shades_classic)
 		}
 		return this

diff --git a/packages/progress/src/MultiProgressChild.class.ts b/packages/progress/src/MultiProgressChild.class.ts
@@ -40,7 +40,7 @@ export class MultiProgressChild extends Progress {
 	 * @internal
 	 */
 	protected setup() {
-		if (!this.out.isVerbose()) {
+		if (!this.isDebug) {
 			this.bar = this.options.parent.multibar.create()
 		}
 		return this

diff --git a/packages/progress/src/Progress.class.ts b/packages/progress/src/Progress.class.ts
@@ -11,6 +11,7 @@ export interface ProgressConfig {
 	total: number
 	current: number
 	out?: Out
+	debug?: boolean
 	config: Partial<CLIProgressOptions>
 }
 
@@ -47,6 +48,12 @@ export class Progress {
 		}
 	}
 
+	debug(value = true) {
+		this.options.debug = value
+		this.out.setVerbosity(value ? 4 : 1)
+		return this
+	}
+
 	/**
 	 * Get the ETA
 	 */
@@ -186,8 +193,12 @@ export class Progress {
 		return this
 	}
 
+	get isDebug() {
+		return this.options.debug || this.out.isVerbose()
+	}
+
 	protected setup(): this {
-		if (!this.out.isVerbose()) {
+		if (!this.isDebug) {
 			this.bar = new cliProgress.SingleBar(makeProgressConfig(this.options), cliProgress.Presets.shades_classic)
 		}
 		return this