mocha-sprint-file-reporter 1.0.127

package/README.md

@@ -0,0 +1,13 @@
+# Mocha Sprint File Reporter
+
+A sprint file reporter for Mocha tests that give more accurate informations about test latency.
+
+## Installation
+
+```bash
+npm install --save-dev mocha-sprint-file-reporter
+```
+
+# Preview
+
+![screenshot](./screen.png)

package/dist/reporter.d.ts

@@ -0,0 +1,7 @@
+import * as Mocha from "mocha";
+export default SprintFile;
+declare function SprintFile(this: any, runner: Mocha.Runner, options: Mocha.MochaOptions): void;
+declare namespace SprintFile {
+    var description: string;
+}
+//# sourceMappingURL=reporter.d.ts.map

package/dist/reporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AA+B/B,eAAe,UAAU,CAAC;AAE1B,iBAAS,UAAU,CACjB,IAAI,EAAE,GAAG,EACT,MAAM,EAAE,KAAK,CAAC,MAAM,EACpB,OAAO,EAAE,KAAK,CAAC,YAAY,QAsJ5B;kBAzJQ,UAAU"}

package/dist/reporter.js

@@ -0,0 +1,278 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const write_format_1 = require("write-format");
+const Mocha = __importStar(require("mocha"));
+const util_1 = require("util");
+const { Base } = Mocha.reporters;
+const path = require("path");
+const milliseconds = require("ms");
+const constants = Mocha.Runner.constants;
+const cyanLimit = 10; // percentage of timeout
+const yellowLimit = 33; // percentage of timeout
+const orangeLimit = 66; // percentage of timeout
+const EVENT_RUN_BEGIN = constants.EVENT_RUN_BEGIN;
+const EVENT_RUN_END = constants.EVENT_RUN_END;
+const EVENT_SUITE_BEGIN = constants.EVENT_SUITE_BEGIN;
+const EVENT_SUITE_END = constants.EVENT_SUITE_END;
+const EVENT_TEST_FAIL = constants.EVENT_TEST_FAIL;
+const EVENT_TEST_PASS = constants.EVENT_TEST_PASS;
+const EVENT_TEST_PENDING = constants.EVENT_TEST_PENDING;
+const EVENT_TEST_END = constants.EVENT_TEST_END;
+const space = " ";
+const tab = space.repeat(2);
+const bold = (s) => (0, write_format_1.Cformat)(s, { effects: ["bold"] });
+const arrow = bold("↪");
+const cusPalette = {
+    smallFaint: { fg: "white", effects: ["italic", "faint"] },
+};
+const getExponent = (num) => [...String(num)].map((d) => "⁰¹²³⁴⁵⁶⁷⁸⁹"[+d]).join("") + "⁾";
+exports = module.exports = SprintFile;
+exports.default = SprintFile;
+function SprintFile(runner, options) {
+    Base.call(this, runner, options);
+    const self = this;
+    const width = (Base.window.width * 0.75) | 0;
+    let indents = 0;
+    let N = 0;
+    self.TSlowCyan = [0, [0, 0]];
+    self.TSlowYellow = [0, [0, 0]];
+    self.TSlowOrange = [0, [0, 0]];
+    let SlowCyan = 0;
+    let SlowYellow = 0;
+    let SlowOrange = 0;
+    self.TErr = 0;
+    let Err = 0;
+    self.SucceedRange = [0, 0];
+    self.TestsTimeRange = [0, [0, 0]];
+    self.CurrTestsTimeRange = [0, [0, 0]];
+    runner.on(EVENT_RUN_BEGIN, function () {
+        (0, write_format_1.write)("\n");
+    });
+    runner.on(EVENT_SUITE_BEGIN, function (suite) {
+        ++indents;
+        if (indents === 2) {
+            (0, write_format_1.write)((0, util_1.format)(arrow + space + "%s", suite.title), {
+                fg: "white",
+                effects: ["bold"],
+            });
+            (0, write_format_1.write)((0, util_1.format)(" (%s)", path.basename(suite.file)), cusPalette.smallFaint);
+            (0, write_format_1.write)("\n" + tab);
+        }
+    });
+    runner.on(EVENT_SUITE_END, function () {
+        --indents;
+        if (indents === 1) {
+            N += 6;
+            (0, write_format_1.write)(tab);
+            if (Err !== self.TErr) {
+                (0, write_format_1.write)("FAILED", { fg: "red", effects: ["bold"] });
+            }
+            else if (SlowOrange !== self.TSlowOrange[0]) {
+                (0, write_format_1.write)("VRSLOW", { fg: { rgb: [255, 150, 50] } });
+            }
+            else if (SlowYellow !== self.TSlowYellow[0]) {
+                (0, write_format_1.write)("SLOWED", { fg: "yellow", effects: ["bold"] });
+            }
+            else if (SlowCyan !== self.TSlowCyan[0]) {
+                (0, write_format_1.write)("ABSLOW", { fg: "cyan", effects: ["bold"] });
+            }
+            else {
+                (0, write_format_1.write)("PASSED", { fg: "green", effects: ["bold"] });
+            }
+            (0, write_format_1.write)(space);
+            (0, write_format_1.write)((0, util_1.format)("%s" + space, milliseconds(self.CurrTestsTimeRange[0])), {
+                fg: "brightWhite",
+            });
+            self.writeRangeEpilogue(self.CurrTestsTimeRange[1], cusPalette.smallFaint);
+            (0, write_format_1.write)("\n");
+            self.TestsTimeRange = self.updateRange(self.CurrTestsTimeRange[1][0], self.CurrTestsTimeRange, self.CurrTestsTimeRange[0]);
+            self.TestsTimeRange = self.updateRange(self.CurrTestsTimeRange[1][1], self.CurrTestsTimeRange, 0);
+            self.CurrTestsTimeRange = [0, [0, 0]];
+            SlowCyan = self.TSlowCyan[0];
+            SlowYellow = self.TSlowYellow[0];
+            SlowOrange = self.TSlowOrange[0];
+            Err = self.TErr;
+            N = 0;
+        }
+    });
+    runner.on(EVENT_TEST_PENDING, function (test) {
+        if (++N % width === 0) {
+            (0, write_format_1.write)("\n" + tab);
+        }
+        (0, write_format_1.write)(Base.symbols.comma, {
+            fg: { rgb: [128, 0, 128] },
+            bg: { rgb: [147, 112, 219] },
+            effects: ["bold"],
+        });
+    });
+    runner.on(EVENT_TEST_PASS, function (test) {
+        if (++N % width === 0) {
+            (0, write_format_1.write)("\n" + tab);
+        }
+        if (test.duration > (test._timeout * orangeLimit) / 100) {
+            self.TSlowOrange = self.updateRange(test.duration, self.TSlowOrange);
+            (0, write_format_1.write)("*", {
+                fg: { rgb: [255, 120, 0] },
+                bg: { rgb: [255, 150, 50] },
+                effects: ["bold"],
+            });
+        }
+        else if (test.duration > (test._timeout * yellowLimit) / 100) {
+            self.TSlowYellow = self.updateRange(test.duration, self.TSlowYellow);
+            (0, write_format_1.write)(Base.symbols.dot, {
+                fg: "yellow",
+                bg: "brightYellow",
+                effects: ["bold"],
+            });
+        }
+        else if (test.duration > (test._timeout * cyanLimit) / 100) {
+            self.TSlowCyan = self.updateRange(test.duration, self.TSlowCyan);
+            (0, write_format_1.write)("~", { fg: "cyan", bg: "brightCyan", effects: ["bold"] });
+        }
+        else {
+            const [ignore, range] = self.updateRange(test.duration, [
+                0,
+                self.SucceedRange,
+            ]);
+            self.SucceedRange = range;
+            (0, write_format_1.write)(Base.symbols.ok, {
+                fg: "green",
+                bg: "brightGreen",
+                effects: ["bold"],
+            });
+        }
+    });
+    runner.on(EVENT_TEST_END, function (test) {
+        if (test.duration === undefined)
+            return;
+        self.CurrTestsTimeRange = self.updateRange(test.duration, self.CurrTestsTimeRange, test.duration);
+    });
+    runner.on(EVENT_TEST_FAIL, function (test) {
+        const T = bold(Base.symbols.bang) + getExponent(++self.TErr);
+        N += T.length;
+        if (N % width === 0) {
+            (0, write_format_1.write)("\n" + tab);
+        }
+        (0, write_format_1.write)(T, { fg: "red", bg: "brightRed" });
+    });
+    runner.once(EVENT_RUN_END, function () {
+        self.sprintEpilogue();
+    });
+}
+(0, util_1.inherits)(SprintFile, Base);
+SprintFile.description = "hierarchical & check matrix representation";
+SprintFile.prototype.sprintEpilogue = function () {
+    var stats = this.stats;
+    const plural = stats.tests > 1 ? "s" : "";
+    (0, write_format_1.write)("\n " + arrow + space);
+    (0, write_format_1.write)(bold(stats.tests) + space + "Test" + plural + " runs in" + space, {
+        fg: "brightWhite",
+    });
+    (0, write_format_1.write)((0, util_1.format)("%s", milliseconds(stats.duration)), {
+        fg: "brightWhite",
+        effects: ["bold"],
+    });
+    (0, write_format_1.write)(space);
+    this.writeRangeEpilogue(this.TestsTimeRange[1], cusPalette.smallFaint);
+    (0, write_format_1.write)("\n " + arrow + space, { effects: ["bold"] });
+    (0, write_format_1.write)((0, util_1.format)("%s %s" + space, (0, write_format_1.Cformat)(stats.passes || 0, { effects: ["bold"] }), "succeeded"), { fg: "green" });
+    this.writeRangeEpilogue(this.SucceedRange, cusPalette.smallFaint);
+    if (this.TSlowCyan[0] > 0) {
+        (0, write_format_1.write)("\n " + arrow + space, { effects: ["bold"] });
+        const plural = this.TSlowCyan[0] > 1 ? "were" : "was";
+        const numFormated = (0, write_format_1.Cformat)(this.TSlowCyan[0], { effects: ["bold"] });
+        (0, write_format_1.write)(`${numFormated} ${plural} a bit slow`, {
+            fg: "cyan",
+        });
+        (0, write_format_1.write)(space);
+        this.writeRangeEpilogue(this.TSlowCyan[1]);
+    }
+    if (this.TSlowYellow[0] > 0) {
+        (0, write_format_1.write)("\n " + arrow + space);
+        const plural = this.TSlowYellow[0] > 1 ? "were" : "was";
+        const numFormated = (0, write_format_1.Cformat)(this.TSlowYellow[0], { effects: ["bold"] });
+        (0, write_format_1.write)(`${numFormated} ${plural} slow`, {
+            fg: "yellow",
+        });
+        (0, write_format_1.write)(space);
+        this.writeRangeEpilogue(this.TSlowYellow[1]);
+    }
+    if (this.TSlowOrange[0] > 0) {
+        (0, write_format_1.write)("\n " + arrow + space);
+        const plural = this.TSlowOrange[0] > 1 ? "were" : "was";
+        const numFormated = (0, write_format_1.Cformat)(this.TSlowOrange[0], { effects: ["bold"] });
+        (0, write_format_1.write)(`${numFormated} ${plural} very slow`, {
+            fg: { rgb: [255, 150, 50] },
+        });
+        (0, write_format_1.write)(space);
+        this.writeRangeEpilogue(this.TSlowOrange[1]);
+    }
+    if (stats.pending) {
+        (0, write_format_1.write)("\n " + arrow + space);
+        const plural = stats.pending > 1 ? "s" : "";
+        (0, write_format_1.write)(`${(0, write_format_1.Cformat)(stats.pending, { effects: ["bold"] })} pending${plural}`, {
+            fg: { rgb: [128, 0, 128] },
+        });
+    }
+    if (stats.failures) {
+        (0, write_format_1.write)("\n " + arrow + space);
+        const plural = stats.failures > 1 ? "s" : "";
+        (0, write_format_1.write)(`${(0, write_format_1.Cformat)(stats.failures, { effects: ["bold"] })} failing${plural}`, { fg: "red" });
+        (0, write_format_1.write)("\n");
+        Base.list(this.failures);
+        (0, write_format_1.write)("\n");
+    }
+    (0, write_format_1.write)("\n");
+    (0, write_format_1.write)("\n");
+};
+SprintFile.prototype.updateRange = function (duration, range, step = 1) {
+    range[0] += step;
+    if (range[1][0] === 0 || duration < range[1][0]) {
+        range[1][0] = duration;
+    }
+    if (range[1][1] === 0 || duration > range[1][1]) {
+        range[1][1] = duration;
+    }
+    return range;
+};
+SprintFile.prototype.writeRangeEpilogue = function (range, options = cusPalette.smallFaint) {
+    if (range[0] == 1 || range[0] == range[1]) {
+        (0, write_format_1.write)((0, util_1.format)("(%s)", milliseconds(range[0])), options);
+    }
+    else {
+        (0, write_format_1.write)((0, util_1.format)("(%s~%s)", milliseconds(range[0]), milliseconds(range[1])), options);
+    }
+};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "mocha-sprint-file-reporter",
+  "version": "1.0.127",
+  "description": "A sprint file reporter for Mocha tests.",
+  "main": "dist/reporter.js",
+  "scripts": {
+    "build": "tsc",
+    "test": "mocha test/*.spec.ts",
+    "test:cov": "nyc mocha test/*.spec.ts",
+    "prepublishOnly": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pantharius/mocha-sprint-file-reporter.git"
+  },
+  "author": "Alexis Breuvart",
+  "license": "MIT",
+  "dependencies": {
+    "@istanbuljs/nyc-config-typescript": "^1.0.2",
+    "@types/chai": "^4.3.0",
+    "@types/mocha": "^9.0.0",
+    "@types/node": "^22.9.1",
+    "@types/sinon": "^17.0.3",
+    "chai": "4.0.2",
+    "child_process": "^1.0.2",
+    "mocha": "^10.8.2",
+    "nyc": "^17.1.0",
+    "path": "^0.12.7",
+    "sinon": "^19.0.2",
+    "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.6.2",
+    "write-format": "^1.0.122"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ]
+}