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

Comparing version 0.8.0 to 0.8.1

lib-commonjs/index.d.ts

@@ -7,4 +7,6 @@ export { black, blue, bold, clearLine, cyan, darkGrey, gradient, green, grey, lightBlack, lightBlue, lightCyan, lightGreen, lightGrey, lightMagenta, lightRed, lightWhite, lightYellow, magenta, moveDownLines, moveUpLines, red, white, yellow, } from './ansiHelpers.js';
 export { TaskReporter, type TaskReporterOptions } from './TaskReporter.js';
-export { TaskReporterTask, type TaskReporterTaskResult, type TaskReporterTaskStatus } from './TaskReporterTask.js';
+export { TaskReporterTask, type TaskReporterTaskResult } from './TaskReporterTask.js';
+export type { TaskReporterTaskStatus } from './types/TaskReporterTaskStatus.js';
 export { formatTime } from './formatTime.js';
+export { statusCharacter } from './statusCharacter.js';
 //# sourceMappingURL=index.d.ts.map

lib-commonjs/SpinningSticky.d.ts

@@ -1,2 +0,2 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" />
 import { Sticky } from './Sticky.js';
@@ -3,0 +3,0 @@ export declare class SpinningSticky extends Sticky {

lib-commonjs/Sticky.d.ts

@@ -1,2 +0,2 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" />
 import { EventEmitter } from 'events';
@@ -3,0 +3,0 @@ export declare class Sticky extends EventEmitter {

lib-commonjs/TaskReporter.d.ts

@@ -113,2 +113,7 @@ import { TaskReporterTask, type TaskReporterTaskResult } from './TaskReporterTask.js';
     /**
+     * Log a message without status prefix. This can be used for announcing
+     * a particular help message or status message.
+     */
+    log(...messages: string[]): void;
+    /**
      * Creates a task and executes it. The execute function should return a promise that
@@ -115,0 +120,0 @@ * resolves when the task is complete. If the promise resolves without a return value,

lib-commonjs/TaskReporterTask.d.ts

@@ -1,4 +0,4 @@
-/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" />
 import { EventEmitter } from 'events';
-export type TaskReporterTaskStatus = 'idle' | 'pending' | 'running' | 'pass' | 'complete' | 'fail' | 'abort' | 'skip' | 'log' | 'info' | 'warn' | 'error' | 'debug';
+import type { TaskReporterTaskStatus } from './types/TaskReporterTaskStatus.js';
 export interface TaskReporterTaskResult {
@@ -5,0 +5,0 @@ status?: TaskReporterTaskStatus;

lib/index.d.ts

@@ -7,4 +7,6 @@ export { black, blue, bold, clearLine, cyan, darkGrey, gradient, green, grey, lightBlack, lightBlue, lightCyan, lightGreen, lightGrey, lightMagenta, lightRed, lightWhite, lightYellow, magenta, moveDownLines, moveUpLines, red, white, yellow, } from './ansiHelpers.js';
 export { TaskReporter, type TaskReporterOptions } from './TaskReporter.js';
-export { TaskReporterTask, type TaskReporterTaskResult, type TaskReporterTaskStatus } from './TaskReporterTask.js';
+export { TaskReporterTask, type TaskReporterTaskResult } from './TaskReporterTask.js';
+export type { TaskReporterTaskStatus } from './types/TaskReporterTaskStatus.js';
 export { formatTime } from './formatTime.js';
+export { statusCharacter } from './statusCharacter.js';
 //# sourceMappingURL=index.d.ts.map

lib/index.js

@@ -9,2 +9,3 @@ export { black, blue, bold, clearLine, cyan, darkGrey, gradient, green, grey, lightBlack, lightBlue, lightCyan, lightGreen, lightGrey, lightMagenta, lightRed, lightWhite, lightYellow, magenta, moveDownLines, moveUpLines, red, white, yellow, } from './ansiHelpers.js';
 export { formatTime } from './formatTime.js';
+export { statusCharacter } from './statusCharacter.js';
 //# sourceMappingURL=index.js.map

lib/TaskReporter.d.ts

@@ -113,2 +113,7 @@ import { TaskReporterTask, type TaskReporterTaskResult } from './TaskReporterTask.js';
     /**
+     * Log a message without status prefix. This can be used for announcing
+     * a particular help message or status message.
+     */
+    log(...messages: string[]): void;
+    /**
      * Creates a task and executes it. The execute function should return a promise that
@@ -115,0 +120,0 @@ * resolves when the task is complete. If the promise resolves without a return value,

lib/TaskReporter.js

 import { Writer } from './Writer.js';
 import { darkGrey, green, lightRed, red, yellow, white, bold, blue, cyan, magenta, setAnsiDisabled, gradient, } from './ansiHelpers.js';
 import { TaskReporterTask } from './TaskReporterTask.js';
+import {} from './types/TaskReporterTaskStatus.js';
 import { makeValuesUniformLength } from './makeValuesUniformLength.js';
@@ -8,12 +9,5 @@ import { formatTime } from './formatTime.js';
 import { SpinningSticky } from './SpinningSticky.js';
+import { statusCharacter } from './statusCharacter.js';
 /** Controls how many tasks should be displayed in the pending sticky list. */
 const maxRunningTasksShown = 5;
-const statusCharacter = {
-    running: yellow('!'),
-    pass: green('✓'),
-    complete: green('✓'),
-    fail: red('✗'),
-    abort: yellow('?'),
-    default: '-',
-};
 const statusMessage = makeValuesUniformLength({
@@ -128,2 +122,9 @@ running: 'started',
     /**
+     * Log a message without status prefix. This can be used for announcing
+     * a particular help message or status message.
+     */
+    log(...messages) {
+        this._writer.write(messages.join('\n'));
+    }
+    /**
      * Creates a task and executes it. The execute function should return a promise that
@@ -130,0 +131,0 @@ * resolves when the task is complete. If the promise resolves without a return value,

lib/TaskReporterTask.d.ts

 /// <reference types="node" resolution-mode="require"/>
 import { EventEmitter } from 'events';
-export type TaskReporterTaskStatus = 'idle' | 'pending' | 'running' | 'pass' | 'complete' | 'fail' | 'abort' | 'skip' | 'log' | 'info' | 'warn' | 'error' | 'debug';
+import type { TaskReporterTaskStatus } from './types/TaskReporterTaskStatus.js';
 export interface TaskReporterTaskResult {
@@ -5,0 +5,0 @@ status?: TaskReporterTaskStatus;

package.json

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

243869

increased by3.43%

Number of package files

155

increased by18.32%

Lines of code

2334

increased by2.68%

No dependency changes