@ms-cloudpack/task-reporter - npm Package Compare versions

Comparing version 0.8.2 to 0.9.0

lib-commonjs/configs.d.ts

@@ -1,18 +0,18 @@
-import type { TaskReporterOptions } from './TaskReporter.js';
+import type { TaskReporterLogLevelOptions } from './TaskReporter.js';
 /**
  * Returns a configuration with all reporter visuals disabled.
  */
-export declare const noLoggingConfig: TaskReporterOptions;
+export declare const noLoggingConfig: Required<TaskReporterLogLevelOptions>;
 /**
  * Returns a configuration with the basic visuals enabled, excluding debug
  */
-export declare const defaultLoggingConfig: TaskReporterOptions;
+export declare const defaultLoggingConfig: Required<TaskReporterLogLevelOptions>;
 /**
  * Returns a configuration with most reporter visuals enabled, other than extended/debug logging details.
  */
-export declare const verboseLoggingConfig: TaskReporterOptions;
+export declare const verboseLoggingConfig: Required<TaskReporterLogLevelOptions>;
 /**
  * Returns a configuration with all reporter visuals enabled.
  */
-export declare const debugLoggingConfig: TaskReporterOptions;
+export declare const debugLoggingConfig: Required<TaskReporterLogLevelOptions>;
 //# sourceMappingURL=configs.d.ts.map

lib-commonjs/TaskReporter.d.ts

@@ -5,3 +5,3 @@ import { TaskReporterTask, type TaskReporterTaskResult } from './TaskReporterTask.js';
  */
-export interface TaskReporterOptions {
+export interface TaskReporterOptions extends TaskReporterLogLevelOptions {
     /**
@@ -28,2 +28,8 @@ * Product name to display.
     plainTextMode?: boolean;
+}
+/**
+ * Options for which types of logging to show.
+ * This is a separate interface so it's easy to verify that each default config includes all options.
+ */
+export interface TaskReporterLogLevelOptions {
     /**
@@ -54,2 +60,6 @@ * Show console.log messages.
     /**
+     * Show product info header.
+     */
+    showProductInfo?: boolean;
+    /**
      * Show summary of tasks once the `complete` method has been called.
@@ -59,6 +69,2 @@ */
     /**
-     * Show progress for tasks that are running, below the sticky summary.
-     */
-    showProgress?: boolean;
-    /**
      * Show tasks that are started above the sticky summary, as they start.
@@ -89,4 +95,3 @@ */
 /**
- * A reporter for tasks. This is used to report the status of tasks to the
- * console.
+ * A reporter for tasks. This is used to report the status of tasks to the console.
  */
@@ -109,3 +114,3 @@ export declare class TaskReporter {
     /**
-     * Set options.
+     * Set options. If the product name changes, this will also print the product info.
      */
@@ -112,0 +117,0 @@ setOptions(options: TaskReporterOptions): void;

lib/configs.d.ts

@@ -1,18 +0,18 @@
-import type { TaskReporterOptions } from './TaskReporter.js';
+import type { TaskReporterLogLevelOptions } from './TaskReporter.js';
 /**
  * Returns a configuration with all reporter visuals disabled.
  */
-export declare const noLoggingConfig: TaskReporterOptions;
+export declare const noLoggingConfig: Required<TaskReporterLogLevelOptions>;
 /**
  * Returns a configuration with the basic visuals enabled, excluding debug
  */
-export declare const defaultLoggingConfig: TaskReporterOptions;
+export declare const defaultLoggingConfig: Required<TaskReporterLogLevelOptions>;
 /**
  * Returns a configuration with most reporter visuals enabled, other than extended/debug logging details.
  */
-export declare const verboseLoggingConfig: TaskReporterOptions;
+export declare const verboseLoggingConfig: Required<TaskReporterLogLevelOptions>;
 /**
  * Returns a configuration with all reporter visuals enabled.
  */
-export declare const debugLoggingConfig: TaskReporterOptions;
+export declare const debugLoggingConfig: Required<TaskReporterLogLevelOptions>;
 //# sourceMappingURL=configs.d.ts.map

lib/configs.js

 /**
  * Returns a configuration with all reporter visuals disabled.
  */
+// Use Required in the object type to verify that any new properties are added.
 export const noLoggingConfig = {
@@ -13,3 +14,3 @@ showCompleted: false,
     showPending: false,
-    showProgress: false,
+    showProductInfo: false,
     showStarted: false,
@@ -24,2 +25,3 @@ showSummary: false,
 export const defaultLoggingConfig = {
+    ...noLoggingConfig,
     showConsoleError: true,
@@ -30,11 +32,4 @@ showConsoleLog: true,
     showPending: true,
-    showProgress: true,
+    showProductInfo: true,
     showSummary: true,
-    // Disabled for default
-    showCompleted: false,
-    showConsoleDebug: false,
-    showConsoleInfo: false,
-    showStarted: false,
-    showTaskDetails: false,
-    showTaskExtended: false,
 };
@@ -45,16 +40,8 @@ /**
 export const verboseLoggingConfig = {
+    ...defaultLoggingConfig,
     showCompleted: true,
     showConsoleError: true,
     showConsoleInfo: true,
-    showConsoleLog: true,
-    showConsoleWarn: true,
-    showErrors: true,
-    showPending: true,
-    showProgress: true,
     showStarted: true,
-    showSummary: true,
     showTaskDetails: true,
-    // Disabled for verbose
-    showConsoleDebug: false,
-    showTaskExtended: false,
 };
@@ -65,16 +52,6 @@ /**
 export const debugLoggingConfig = {
-    showCompleted: true,
+    ...verboseLoggingConfig,
     showConsoleDebug: true,
-    showConsoleError: true,
-    showConsoleInfo: true,
-    showConsoleLog: true,
-    showConsoleWarn: true,
-    showErrors: true,
-    showPending: true,
-    showProgress: true,
-    showStarted: true,
-    showSummary: true,
-    showTaskDetails: true,
     showTaskExtended: true,
 };
 //# sourceMappingURL=configs.js.map

lib/TaskReporter.d.ts

@@ -5,3 +5,3 @@ import { TaskReporterTask, type TaskReporterTaskResult } from './TaskReporterTask.js';
  */
-export interface TaskReporterOptions {
+export interface TaskReporterOptions extends TaskReporterLogLevelOptions {
     /**
@@ -28,2 +28,8 @@ * Product name to display.
     plainTextMode?: boolean;
+}
+/**
+ * Options for which types of logging to show.
+ * This is a separate interface so it's easy to verify that each default config includes all options.
+ */
+export interface TaskReporterLogLevelOptions {
     /**
@@ -54,2 +60,6 @@ * Show console.log messages.
     /**
+     * Show product info header.
+     */
+    showProductInfo?: boolean;
+    /**
      * Show summary of tasks once the `complete` method has been called.
@@ -59,6 +69,2 @@ */
     /**
-     * Show progress for tasks that are running, below the sticky summary.
-     */
-    showProgress?: boolean;
-    /**
      * Show tasks that are started above the sticky summary, as they start.
@@ -89,4 +95,3 @@ */
 /**
- * A reporter for tasks. This is used to report the status of tasks to the
- * console.
+ * A reporter for tasks. This is used to report the status of tasks to the console.
  */
@@ -109,3 +114,3 @@ export declare class TaskReporter {
     /**
-     * Set options.
+     * Set options. If the product name changes, this will also print the product info.
      */
@@ -112,0 +117,0 @@ setOptions(options: TaskReporterOptions): void;

lib/TaskReporter.js

@@ -45,4 +45,3 @@ import { Writer } from './Writer.js';
 /**
- * A reporter for tasks. This is used to report the status of tasks to the
- * console.
+ * A reporter for tasks. This is used to report the status of tasks to the console.
  */
@@ -71,3 +70,3 @@ export class TaskReporter {
     /**
-     * Set options.
+     * Set options. If the product name changes, this will also print the product info.
      */
@@ -192,2 +191,5 @@ setOptions(options) {
     _reportProductInfo() {
+        if (!this._options.showProductInfo) {
+            return;
+        }
         const { productName, version, description, helpMessage } = this._options;
@@ -194,0 +196,0 @@ if (productName) {

lib/tsdoc-metadata.json

@@ -8,5 +8,5 @@ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.36.4"
+      "packageVersion": "7.37.1"
     }
   ]
 }

package.json

 {
   "name": "@ms-cloudpack/task-reporter",
-  "version": "0.8.2",
+  "version": "0.9.0",
   "description": "Helpers for logging tasks to the console.",
@@ -5,0 +5,0 @@ "license": "MIT",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

243022

decreased by-0.36%

Lines of code

2302

decreased by-1.37%

No dependency changes