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

Comparing version 0.3.3 to 0.4.0

lib-commonjs/TaskReporter.d.ts

@@ -19,2 +19,6 @@ import { TaskReporterTask, type TaskReporterTaskResult } from './TaskReporterTask.js';
     /**
+     * Help message to display when cloudpack starts up.
+     */
+    helpMessage?: string;
+    /**
      * Plain text mode. This will disable all colors and formatting which depends
@@ -117,3 +121,3 @@ * on ansi codes, including stickies.
     private _overideConsoleLogging;
-    private _reportProductName;
+    private _reportProductInfo;
     private _reportConsoleLog;
@@ -120,0 +124,0 @@ private _reportTaskComplete;

lib/TaskReporter.d.ts

@@ -19,2 +19,6 @@ import { TaskReporterTask, type TaskReporterTaskResult } from './TaskReporterTask.js';
     /**
+     * Help message to display when cloudpack starts up.
+     */
+    helpMessage?: string;
+    /**
      * Plain text mode. This will disable all colors and formatting which depends
@@ -117,3 +121,3 @@ * on ansi codes, including stickies.
     private _overideConsoleLogging;
-    private _reportProductName;
+    private _reportProductInfo;
     private _reportConsoleLog;
@@ -120,0 +124,0 @@ private _reportTaskComplete;

lib/TaskReporter.js

@@ -76,3 +76,3 @@ import { Writer } from './Writer.js';
         if (previousOptions.productName !== options.productName) {
-            this._reportProductName();
+            this._reportProductInfo();
         }
@@ -175,4 +175,4 @@ }
     }
-    _reportProductName() {
-        const { productName, version, description } = this._options;
+    _reportProductInfo() {
+        const { productName, version, description, helpMessage } = this._options;
         if (productName) {
@@ -182,4 +182,7 @@ this._writer.write([`\n${productName}`, version && `(v${bold(white(version))})`, description && cyan(description)]
                 .join(' '));
-            this._writer.write('');
         }
+        if (helpMessage) {
+            this._writer.write(helpMessage);
+        }
+        this._writer.write('');
     }
@@ -186,0 +189,0 @@ _reportConsoleLog(status, message) {

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.34.7"
+      "packageVersion": "7.34.8"
     }
   ]
 }

package.json

 {
   "name": "@ms-cloudpack/task-reporter",
-  "version": "0.3.3",
+  "version": "0.4.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

Improved metrics

Total package byte prevSize

223399

increased by0.45%

Lines of code

2253

increased by0.63%

No dependency changes