@lage-run/reporters 0.3.1 → 1.0.0

package/CHANGELOG.json

@@ -2,7 +2,37 @@
   "name": "@lage-run/reporters",
   "entries": [
     {
-      "date": "Fri, 27 Jan 2023 00:28:03 GMT",
+      "date": "Tue, 31 Jan 2023 18:24:29 GMT",
+      "tag": "@lage-run/reporters_v1.0.0",
+      "version": "1.0.0",
+      "comments": {
+        "major": [
+          {
+            "author": "kchau@microsoft.com",
+            "package": "@lage-run/reporters",
+            "commit": "ac2bf4264854e06e86236a54421374b2c2602f7b",
+            "comment": "removed the initialize reporter and create reporter APIs (please just instantiate them yourself!)"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Mon, 30 Jan 2023 17:26:59 GMT",
+      "tag": "@lage-run/reporters_v0.3.2",
+      "version": "0.3.2",
+      "comments": {
+        "patch": [
+          {
+            "author": "felescoto95@hotmail.com",
+            "package": "@lage-run/reporters",
+            "commit": "226876f3dcc8a16fdf323e714cc9a4cbed088303",
+            "comment": "Add task error summary to ADO reporter"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 27 Jan 2023 00:28:15 GMT",
       "tag": "@lage-run/reporters_v0.3.1",
       "version": "0.3.1",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,28 @@
 # Change Log - @lage-run/reporters
 
-This log was last generated on Fri, 27 Jan 2023 00:28:03 GMT and should not be manually modified.
+This log was last generated on Tue, 31 Jan 2023 18:24:29 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 1.0.0
+
+Tue, 31 Jan 2023 18:24:29 GMT
+
+### Major changes
+
+- removed the initialize reporter and create reporter APIs (please just instantiate them yourself!) (kchau@microsoft.com)
+
+## 0.3.2
+
+Mon, 30 Jan 2023 17:26:59 GMT
+
+### Patches
+
+- Add task error summary to ADO reporter (felescoto95@hotmail.com)
+
 ## 0.3.1
 
-Fri, 27 Jan 2023 00:28:03 GMT
+Fri, 27 Jan 2023 00:28:15 GMT
 
 ### Patches
 

package/lib/AdoReporter.js

@@ -151,11 +151,13 @@ class AdoReporter {
             this.logStream.write("Nothing has been run.\n");
         }
         if (failed && failed.length > 0) {
+            let packagesMessage = `##vso[task.logissue type=error]Your build failed on the following packages => `;
             for (const targetId of failed){
                 const target1 = targetRuns.get(targetId)?.target;
                 if (target1) {
                     const { packageName , task  } = target1;
                     const taskLogs = this.logEntries.get(targetId);
+                    packagesMessage += `[${packageName} ${task}], `;
                     this.logStream.write(`##[error] [${_chalk.default.magenta(packageName)} ${_chalk.default.cyan(task)}] ${_chalk.default.redBright("ERROR DETECTED")}\n`);
                     if (taskLogs) {
                         for (const entry of taskLogs){
@@ -165,6 +167,8 @@ class AdoReporter {
                     }
                 }
             }
+            packagesMessage += "find the error logs above with the prefix '##[error]!'\n";
+            this.logStream.write(packagesMessage);
         }
         this.logStream.write(format(_logger.LogLevel.info, "", `Took a total of ${(0, _formatHrtime.formatDuration)((0, _formatHrtime.hrToSeconds)(duration))} to complete`));
     }

package/lib/index.d.ts

@@ -2,7 +2,5 @@ export { AdoReporter } from "./AdoReporter.js";
 export { JsonReporter } from "./JsonReporter.js";
 export { LogReporter } from "./LogReporter.js";
 export { ChromeTraceEventsReporter } from "./ChromeTraceEventsReporter.js";
-export { initializeReporters } from "./initialize.js";
-export { createReporter } from "./createReporter.js";
+export { ProgressReporter } from "./ProgressReporter.js";
 export type { TargetStatusEntry, TargetMessageEntry } from "./types/TargetLogEntry.js";
-export type { ReporterInitOptions } from "./initialize.js";

package/lib/index.js

@@ -13,12 +13,10 @@ _export(exports, {
     JsonReporter: ()=>_jsonReporterJs.JsonReporter,
     LogReporter: ()=>_logReporterJs.LogReporter,
     ChromeTraceEventsReporter: ()=>_chromeTraceEventsReporterJs.ChromeTraceEventsReporter,
-    initializeReporters: ()=>_initializeJs.initializeReporters,
-    createReporter: ()=>_createReporterJs.createReporter
+    ProgressReporter: ()=>_progressReporterJs.ProgressReporter
 });
 const _adoReporterJs = require("./AdoReporter.js");
 const _jsonReporterJs = require("./JsonReporter.js");
 const _logReporterJs = require("./LogReporter.js");
 const _chromeTraceEventsReporterJs = require("./ChromeTraceEventsReporter.js");
-const _initializeJs = require("./initialize.js");
-const _createReporterJs = require("./createReporter.js");
+const _progressReporterJs = require("./ProgressReporter.js");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lage-run/reporters",
-  "version": "0.3.1",
+  "version": "1.0.0",
   "description": "Log reporters for Lage",
   "repository": {
     "url": "https://github.com/microsoft/lage"

package/lib/createReporter.d.ts

@@ -1,13 +0,0 @@
-import { LogLevel } from "@lage-run/logger";
-import { JsonReporter } from "./JsonReporter.js";
-import { AdoReporter } from "./AdoReporter.js";
-import { LogReporter } from "./LogReporter.js";
-import { ProgressReporter } from "./ProgressReporter.js";
-export declare function createReporter({ reporter, progress, grouped, concurrency, verbose, logLevel, }: {
-    reporter: string;
-    progress?: boolean;
-    grouped?: boolean;
-    concurrency?: number;
-    verbose?: boolean;
-    logLevel?: LogLevel;
-}): AdoReporter | JsonReporter | LogReporter | ProgressReporter;

package/lib/createReporter.js

@@ -1,39 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "createReporter", {
-    enumerable: true,
-    get: ()=>createReporter
-});
-const _logger = require("@lage-run/logger");
-const _jsonReporterJs = require("./JsonReporter.js");
-const _adoReporterJs = require("./AdoReporter.js");
-const _logReporterJs = require("./LogReporter.js");
-const _progressReporterJs = require("./ProgressReporter.js");
-function createReporter({ reporter ="npmLog" , progress =false , grouped =false , concurrency =0 , verbose =false , logLevel =_logger.LogLevel.info  }) {
-    switch(reporter){
-        case "json":
-            return new _jsonReporterJs.JsonReporter({
-                logLevel
-            });
-        case "azureDevops":
-        case "adoLog":
-            return new _adoReporterJs.AdoReporter({
-                grouped,
-                logLevel: verbose ? _logger.LogLevel.verbose : logLevel
-            });
-        case "old":
-            return new _logReporterJs.LogReporter({
-                grouped,
-                logLevel: verbose ? _logger.LogLevel.verbose : logLevel
-            });
-        default:
-            return progress ? new _progressReporterJs.ProgressReporter({
-                concurrency
-            }) : new _logReporterJs.LogReporter({
-                grouped,
-                logLevel: verbose ? _logger.LogLevel.verbose : logLevel
-            });
-    }
-}

package/lib/initialize.d.ts

@@ -1,11 +0,0 @@
-import { LogLevel } from "@lage-run/logger";
-import type { Logger } from "@lage-run/logger";
-export interface ReporterInitOptions {
-    reporter: string[] | string;
-    progress: boolean;
-    verbose: boolean;
-    grouped: boolean;
-    concurrency: number;
-    logLevel: keyof typeof LogLevel;
-}
-export declare function initializeReporters(logger: Logger, options: ReporterInitOptions): import("@lage-run/logger").Reporter<import("@lage-run/logger").LogStructuredData>[];

package/lib/initialize.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "initializeReporters", {
-    enumerable: true,
-    get: ()=>initializeReporters
-});
-const _logger = require("@lage-run/logger");
-const _createReporterJs = require("./createReporter.js");
-function initializeReporters(logger, options) {
-    const { reporter , verbose , grouped , logLevel , progress , concurrency  } = options;
-    const reporterOptions = Array.isArray(reporter) ? reporter : [
-        reporter
-    ];
-    for (const reporter1 of reporterOptions){
-        const reporterInstance = (0, _createReporterJs.createReporter)({
-            verbose,
-            progress,
-            grouped,
-            concurrency,
-            logLevel: _logger.LogLevel[logLevel],
-            reporter: reporter1
-        });
-        logger.addReporter(reporterInstance);
-    }
-    return logger.reporters;
-}