@japa/runner 4.3.1 → 5.0.0

package/build/main-CB1nhl6c.js

@@ -0,0 +1,336 @@
+import { d as BaseReporter, n as icons, t as colors } from "./helpers-BlHaYYTh.js";
+import { ErrorsPrinter } from "@japa/errors-printer";
+import { stripVTControlCharacters } from "node:util";
+import { relative } from "node:path";
+import string from "@poppinss/string";
+var DotReporter = class extends BaseReporter {
+	onTestEnd(payload) {
+		let output = "";
+		if (payload.isTodo) output = colors.cyan(icons.info);
+		else if (payload.hasError) output = colors.red(icons.cross);
+		else if (payload.isSkipped) output = colors.yellow(icons.bullet);
+		else if (payload.isFailing) output = colors.magenta(icons.squareSmallFilled);
+		else output = colors.green(icons.tick);
+		process.stdout.write(`${output}`);
+	}
+	async end() {
+		console.log("");
+		await this.printSummary(this.runner.getSummary());
+	}
+};
+var SpecReporter = class extends BaseReporter {
+	#isFirstLoneTest = true;
+	#getTestIcon(payload) {
+		if (payload.isTodo) return colors.cyan(icons.info);
+		if (payload.hasError) return colors.red(icons.cross);
+		if (payload.isSkipped) return colors.yellow(icons.bullet);
+		if (payload.isFailing) return colors.magenta(icons.squareSmallFilled);
+		return colors.green(icons.tick);
+	}
+	#getTestMessage(payload) {
+		const message = payload.title.expanded;
+		if (payload.isTodo) return colors.blue(message);
+		if (payload.hasError) return colors.red(message);
+		if (payload.isSkipped) return colors.yellow(message);
+		if (payload.isFailing) return colors.magenta(message);
+		return colors.grey(message);
+	}
+	#getSubText(payload) {
+		if (payload.isSkipped && payload.skipReason) return colors.dim(`${icons.branch} ${colors.italic(payload.skipReason)}`);
+		if (!payload.isFailing) return;
+		if (payload.hasError) {
+			const message = payload.errors.find((error) => error.phase === "test")?.error.message ?? `Test marked with ".fails()" must finish with an error`;
+			return colors.dim(`${icons.branch} ${colors.italic(message)}`);
+		}
+		if (payload.failReason) return colors.dim(`${icons.branch} ${colors.italic(payload.failReason)}`);
+		const testErrorMessage = payload.errors.find((error) => error.phase === "test");
+		if (testErrorMessage && testErrorMessage.error) return colors.dim(`${icons.branch} ${colors.italic(testErrorMessage.error.message)}`);
+	}
+	#getRelativeFilename(fileName) {
+		return relative(process.cwd(), fileName);
+	}
+	#printTest(payload) {
+		const icon = this.#getTestIcon(payload);
+		const message = this.#getTestMessage(payload);
+		const prefix = payload.isPinned ? colors.yellow("[PINNED] ") : "";
+		const indentation = this.currentFileName || this.currentGroupName ? "  " : "";
+		const duration = colors.dim(`(${string.milliseconds.format(Number(payload.duration.toFixed(2)))})`);
+		const retries = payload.retryAttempt && payload.retryAttempt > 1 ? colors.dim(`(x${payload.retryAttempt}) `) : "";
+		let subText = this.#getSubText(payload);
+		subText = subText ? `\n${indentation}  ${subText}` : "";
+		console.log(`${indentation}${icon} ${prefix}${retries}${message} ${duration}${subText}`);
+	}
+	#printGroup(payload) {
+		const title = this.currentSuiteName !== "default" ? `${this.currentSuiteName} / ${payload.title}` : payload.title;
+		const suffix = this.currentFileName ? colors.dim(` (${this.#getRelativeFilename(this.currentFileName)})`) : "";
+		console.log(`\n${title}${suffix}`);
+	}
+	onTestStart() {
+		if (this.currentFileName && this.#isFirstLoneTest) console.log(`\n${colors.dim(this.#getRelativeFilename(this.currentFileName))}`);
+		this.#isFirstLoneTest = false;
+	}
+	onTestEnd(payload) {
+		this.#printTest(payload);
+	}
+	onGroupStart(payload) {
+		this.#isFirstLoneTest = false;
+		this.#printGroup(payload);
+	}
+	onGroupEnd() {
+		this.#isFirstLoneTest = true;
+	}
+	async end() {
+		const summary = this.runner.getSummary();
+		await this.printSummary(summary);
+	}
+};
+const list = [
+	Error,
+	EvalError,
+	RangeError,
+	ReferenceError,
+	SyntaxError,
+	TypeError,
+	URIError,
+	AggregateError,
+	globalThis.DOMException,
+	globalThis.AssertionError,
+	globalThis.SystemError
+].filter(Boolean).map((constructor) => [constructor.name, constructor]);
+const errorConstructors = new Map(list);
+Error;
+const errorProperties = [
+	{
+		property: "name",
+		enumerable: false
+	},
+	{
+		property: "message",
+		enumerable: false
+	},
+	{
+		property: "stack",
+		enumerable: false
+	},
+	{
+		property: "code",
+		enumerable: true
+	},
+	{
+		property: "cause",
+		enumerable: false
+	},
+	{
+		property: "errors",
+		enumerable: false
+	}
+];
+const toJsonWasCalled = /* @__PURE__ */ new WeakSet();
+const toJSON = (from) => {
+	toJsonWasCalled.add(from);
+	const json = from.toJSON();
+	toJsonWasCalled.delete(from);
+	return json;
+};
+const newError = (name) => {
+	const ErrorConstructor = errorConstructors.get(name) ?? Error;
+	return ErrorConstructor === AggregateError ? new ErrorConstructor([]) : new ErrorConstructor();
+};
+const destroyCircular = ({ from, seen, to, forceEnumerable, maxDepth, depth, useToJSON, serialize }) => {
+	if (!to) if (Array.isArray(from)) to = [];
+	else if (!serialize && isErrorLike(from)) to = newError(from.name);
+	else to = {};
+	seen.push(from);
+	if (depth >= maxDepth) return to;
+	if (useToJSON && typeof from.toJSON === "function" && !toJsonWasCalled.has(from)) return toJSON(from);
+	const continueDestroyCircular = (value) => destroyCircular({
+		from: value,
+		seen: [...seen],
+		forceEnumerable,
+		maxDepth,
+		depth,
+		useToJSON,
+		serialize
+	});
+	for (const [key, value] of Object.entries(from)) {
+		if (value && value instanceof Uint8Array && value.constructor.name === "Buffer") {
+			to[key] = "[object Buffer]";
+			continue;
+		}
+		if (value !== null && typeof value === "object" && typeof value.pipe === "function") {
+			to[key] = "[object Stream]";
+			continue;
+		}
+		if (typeof value === "function") continue;
+		if (!value || typeof value !== "object") {
+			try {
+				to[key] = value;
+			} catch {}
+			continue;
+		}
+		if (!seen.includes(from[key])) {
+			depth++;
+			to[key] = continueDestroyCircular(from[key]);
+			continue;
+		}
+		to[key] = "[Circular]";
+	}
+	if (serialize || to instanceof Error) {
+		for (const { property, enumerable } of errorProperties) if (from[property] !== void 0 && from[property] !== null) Object.defineProperty(to, property, {
+			value: isErrorLike(from[property]) || Array.isArray(from[property]) ? continueDestroyCircular(from[property]) : from[property],
+			enumerable: forceEnumerable ? true : enumerable,
+			configurable: true,
+			writable: true
+		});
+	}
+	return to;
+};
+function serializeError(value, options = {}) {
+	const { maxDepth = Number.POSITIVE_INFINITY, useToJSON = true } = options;
+	if (typeof value === "object" && value !== null) return destroyCircular({
+		from: value,
+		seen: [],
+		forceEnumerable: true,
+		maxDepth,
+		depth: 0,
+		useToJSON,
+		serialize: true
+	});
+	if (typeof value === "function") return `[Function: ${value.name || "anonymous"}]`;
+	return value;
+}
+function isErrorLike(value) {
+	return Boolean(value) && typeof value === "object" && typeof value.name === "string" && typeof value.message === "string" && typeof value.stack === "string";
+}
+var NdJSONReporter = class extends BaseReporter {
+	#getRelativeFilename(fileName) {
+		return relative(process.cwd(), fileName);
+	}
+	#serializeErrors(errors) {
+		return errors.map((error) => ({
+			phase: error.phase,
+			error: serializeError(error.error)
+		}));
+	}
+	onTestEnd(payload) {
+		console.log(JSON.stringify({
+			event: "test:end",
+			filePath: this.currentFileName,
+			relativePath: this.currentFileName ? this.#getRelativeFilename(this.currentFileName) : void 0,
+			title: payload.title,
+			duration: payload.duration,
+			failReason: payload.failReason,
+			isFailing: payload.isFailing,
+			skipReason: payload.skipReason,
+			isSkipped: payload.isSkipped,
+			isTodo: payload.isTodo,
+			isPinned: payload.isPinned,
+			retryAttempt: payload.retryAttempt,
+			retries: payload.retries,
+			errors: this.#serializeErrors(payload.errors)
+		}));
+	}
+	onGroupStart(payload) {
+		console.log(JSON.stringify({
+			event: "group:start",
+			title: payload.title
+		}));
+	}
+	onGroupEnd(payload) {
+		JSON.stringify({
+			event: "group:end",
+			title: payload.title,
+			errors: this.#serializeErrors(payload.errors)
+		});
+	}
+	onSuiteStart(payload) {
+		console.log(JSON.stringify({
+			event: "suite:start",
+			...payload
+		}));
+	}
+	onSuiteEnd(payload) {
+		console.log(JSON.stringify({
+			event: "suite:end",
+			name: payload.name,
+			hasError: payload.hasError,
+			errors: this.#serializeErrors(payload.errors)
+		}));
+	}
+	async end() {
+		const summary = this.runner.getSummary();
+		console.log(JSON.stringify({
+			aggregates: summary.aggregates,
+			duration: summary.duration,
+			failedTestsTitles: summary.failedTestsTitles,
+			hasError: summary.hasError
+		}));
+	}
+};
+var GithubReporter = class extends BaseReporter {
+	escapeMessage(value) {
+		return value.replace(/%/g, "%25").replace(/\r/g, "%0D").replace(/\n/g, "%0A");
+	}
+	escapeProperty(value) {
+		return value.replace(/%/g, "%25").replace(/\r/g, "%0D").replace(/\n/g, "%0A").replace(/:/g, "%3A").replace(/,/g, "%2C");
+	}
+	formatMessage({ command, properties, message }) {
+		let result = `::${command}`;
+		Object.entries(properties).forEach(([k, v], i) => {
+			result += i === 0 ? " " : ",";
+			result += `${k}=${this.escapeProperty(v)}`;
+		});
+		result += `::${this.escapeMessage(message)}`;
+		return result;
+	}
+	async getErrorAnnotation(printer, error) {
+		const parsedError = await printer.parseError(error.error);
+		if (!("frames" in parsedError)) return;
+		const mainFrame = parsedError.frames.find((frame) => frame.type === "app");
+		if (!mainFrame) return;
+		return this.formatMessage({
+			command: "error",
+			properties: {
+				file: string.toUnixSlash(relative(process.cwd(), mainFrame.fileName)),
+				title: error.title,
+				line: String(mainFrame.lineNumber),
+				column: String(mainFrame.columnNumber)
+			},
+			message: stripVTControlCharacters(parsedError.message)
+		});
+	}
+	async end() {
+		const summary = this.runner.getSummary();
+		const errorsList = this.aggregateErrors(summary);
+		const errorPrinter = new ErrorsPrinter(this.options);
+		for (let error of errorsList) {
+			const formatted = await this.getErrorAnnotation(errorPrinter, error);
+			if (formatted) console.log(`\n${formatted}`);
+		}
+	}
+};
+const spec = (options) => {
+	return {
+		name: "spec",
+		handler: (...args) => new SpecReporter(options).boot(...args)
+	};
+};
+const dot = (options) => {
+	return {
+		name: "dot",
+		handler: (...args) => new DotReporter(options).boot(...args)
+	};
+};
+const ndjson = (options) => {
+	return {
+		name: "ndjson",
+		handler: (...args) => new NdJSONReporter(options).boot(...args)
+	};
+};
+const github = (options) => {
+	return {
+		name: "github",
+		handler: (...args) => new GithubReporter(options).boot(...args)
+	};
+};
+export { spec as i, github as n, ndjson as r, dot as t };

package/build/modules/core/main.js

@@ -1,21 +1,2 @@
-import {
-  BaseReporter,
-  Emitter,
-  Group,
-  Refiner,
-  Runner,
-  Suite,
-  Test,
-  TestContext
-} from "../../chunk-PCBL2VZP.js";
-import "../../chunk-2KG3PWR4.js";
-export {
-  BaseReporter,
-  Emitter,
-  Group,
-  Refiner,
-  Runner,
-  Suite,
-  Test,
-  TestContext
-};
+import { a as Group, c as Suite, d as BaseReporter, i as Emitter, l as Test, o as Refiner, s as Runner, u as TestContext } from "../../helpers-BlHaYYTh.js";
+export { BaseReporter, Emitter, Group, Refiner, Runner, Suite, Test, TestContext };

package/build/modules/core/reporters/base.d.ts

@@ -1,4 +1,4 @@
-import { Emitter, Runner } from '../main.js';
+import { type Emitter, type Runner } from '../main.js';
 import type { TestEndNode, SuiteEndNode, GroupEndNode, TestStartNode, RunnerSummary, RunnerEndNode, GroupStartNode, SuiteStartNode, RunnerStartNode, BaseReporterOptions } from '../types.js';
 /**
  * Base reporter to build custom reporters on top of

package/build/src/create_test.d.ts

@@ -1,8 +1,8 @@
-import { Emitter, Group, Refiner, Suite, Test } from '../modules/core/main.js';
+import { type Emitter, Group, type Refiner, type Suite, Test } from '../modules/core/main.js';
 /**
  * Create a new instance of the Test
  */
-export declare function createTest(title: string, emitter: Emitter, refiner: Refiner, options: {
+export declare function createTest(title: string, emitter: Emitter, refiner: Refiner, debuggingError: Error, options: {
     group?: Group;
     suite?: Suite;
     file?: string;

package/build/src/debug.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("util").DebugLogger;
+declare const _default: import("node:util").DebugLogger;
 export default _default;

package/build/src/helpers.d.ts

@@ -1,4 +1,5 @@
-import { Colors } from '@poppinss/colors/types';
+import { type Colors } from '@poppinss/colors/types';
+import { type Runner, type Test } from '../modules/core/main.js';
 export declare const colors: Colors;
 /**
  * A collection of platform specific icons
@@ -14,3 +15,12 @@ export declare const icons: {
     branch: string;
     squareSmallFilled: string;
 };
+/**
+ * Returns a formatted string to print the information about
+ * a pinned test
+ */
+export declare function formatPinnedTest(test: Test): string;
+/**
+ * Prints a summary of all the pinned tests
+ */
+export declare function printPinnedTests(runner: Runner): void;

package/build/src/hooks.d.ts

@@ -1,4 +1,4 @@
-import { Runner } from '../modules/core/main.js';
+import { type Runner } from '../modules/core/main.js';
 import type { NormalizedConfig } from './types.js';
 /**
  * Exposes API for working with global hooks

package/build/src/plugins/disallow_pinned_tests.d.ts

@@ -0,0 +1,9 @@
+import type { PluginFn } from '../types.js';
+/**
+ * Disallows pinned tests by throwing an error before the runner
+ * starts executing the tests.
+ */
+export declare function disallowPinnedTests(options?: {
+    disallow?: boolean;
+    errorMessage?: string;
+}): PluginFn;

package/build/src/plugins/main.d.ts

@@ -0,0 +1 @@
+export { disallowPinnedTests } from './disallow_pinned_tests.js';

package/build/src/plugins/main.js

@@ -0,0 +1,23 @@
+import string from "@poppinss/string";
+function disallowPinnedTests(options) {
+	const disallow = options?.disallow ?? true;
+	const errorMessage = options?.errorMessage ?? "Pinning tests are disallowed by the \"disallowPinnedTests\" plugin. Use the \"--list-pinned\" flag to list pinned tests";
+	return async function disallowPinnedTestsPluginFn({ runner, emitter }) {
+		if (!disallow) return;
+		function disallowPinned(test) {
+			if (test.isPinned) {
+				test.options.meta.abort(string.interpolate(errorMessage, { test: test.title }));
+				process.exitCode = 1;
+			}
+		}
+		emitter.on("runner:start", () => {
+			runner.onSuite((suite) => {
+				suite.onGroup((group) => {
+					group.tap(disallowPinned);
+				});
+				suite.onTest(disallowPinned);
+			});
+		});
+	};
+}
+export { disallowPinnedTests };

package/build/src/reporters/main.js

@@ -1,14 +1,3 @@
-import {
-  dot,
-  github,
-  ndjson,
-  spec
-} from "../../chunk-U3BSXCEH.js";
-import "../../chunk-PCBL2VZP.js";
-import "../../chunk-2KG3PWR4.js";
-export {
-  dot,
-  github,
-  ndjson,
-  spec
-};
+import "../../helpers-BlHaYYTh.js";
+import { i as spec, n as github, r as ndjson, t as dot } from "../../main-CB1nhl6c.js";
+export { dot, github, ndjson, spec };

package/build/src/reporters/spec.d.ts

@@ -1,5 +1,5 @@
 import { BaseReporter } from '../../modules/core/main.js';
-import { GroupStartNode, TestEndNode } from '../../modules/core/types.js';
+import { type GroupStartNode, type TestEndNode } from '../../modules/core/types.js';
 /**
  * Pretty prints the tests on the console
  */

package/build/src/types.d.ts

@@ -35,6 +35,7 @@ export type CLIArgs = {
     failed?: boolean;
     help?: boolean;
     matchAll?: boolean;
+    listPinned?: boolean;
     bail?: boolean;
     bailLayer?: string;
 } & Record<string, string | string[] | boolean>;

package/build/src/types.js

@@ -1,14 +1,7 @@
-import {
-  __reExport
-} from "../chunk-2KG3PWR4.js";
-
-// src/types.ts
-var types_exports2 = {};
-
-// modules/core/types.ts
-var types_exports = {};
-__reExport(types_exports, types_star);
-import * as types_star from "@japa/core/types";
-
-// src/types.ts
-__reExport(types_exports2, types_exports);
+import "node:module";
+export * from "@japa/core/types";
+Object.defineProperty;
+Object.getOwnPropertyDescriptor;
+Object.getOwnPropertyNames;
+Object.prototype.hasOwnProperty;
+export {};

package/build/src/validator.d.ts

@@ -1,4 +1,4 @@
-import { NormalizedConfig } from './types.js';
+import { type NormalizedConfig } from './types.js';
 /**
  * Validator encapsulates the validations to perform before running
  * the tests

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@japa/runner",
   "description": "A simple yet powerful testing framework for Node.js",
-  "version": "4.3.1",
+  "version": "5.0.0",
   "engines": {
     "node": ">=18.16.0"
   },
@@ -16,6 +16,7 @@
     ".": "./build/index.js",
     "./types": "./build/src/types.js",
     "./reporters": "./build/src/reporters/main.js",
+    "./plugins": "./build/src/plugins/main.js",
     "./factories": "./build/factories/main.js",
     "./core": "./build/modules/core/main.js"
   },
@@ -27,46 +28,42 @@
     "typecheck": "tsc --noEmit",
     "clean": "del-cli build",
     "precompile": "npm run lint && npm run clean",
-    "compile": "tsup-node && tsc --emitDeclarationOnly --declaration",
+    "compile": "tsdown && tsc --emitDeclarationOnly --declaration",
     "build": "npm run compile",
     "version": "npm run build",
     "prepublishOnly": "npm run build",
     "release": "release-it",
-    "quick:test": "glob -c \"node --import=ts-node-maintained/register/esm --enable-source-maps --test-reporter=spec --test\" \"tests/*.spec.ts\""
+    "quick:test": "node --import=@poppinss/ts-exec --enable-source-maps --test-reporter=spec --test tests/*.spec.ts"
   },
   "devDependencies": {
-    "@adonisjs/eslint-config": "^2.1.0",
+    "@adonisjs/eslint-config": "^3.0.0-next.5",
     "@adonisjs/prettier-config": "^1.4.5",
-    "@adonisjs/tsconfig": "^1.4.1",
-    "@release-it/conventional-changelog": "^10.0.1",
-    "@swc/core": "1.13.1",
-    "@types/chai": "^5.2.2",
-    "@types/ms": "^2.1.0",
-    "@types/node": "^24.0.15",
+    "@adonisjs/tsconfig": "^2.0.0-next.3",
+    "@poppinss/ts-exec": "^1.4.1",
+    "@release-it/conventional-changelog": "^10.0.3",
+    "@types/chai": "^5.2.3",
+    "@types/node": "^25.0.1",
     "c8": "^10.1.3",
-    "chai": "^5.2.1",
-    "cross-env": "^7.0.3",
-    "del-cli": "^6.0.0",
-    "eslint": "^9.31.0",
-    "glob": "^11.0.3",
-    "prettier": "^3.6.2",
-    "release-it": "^19.0.4",
-    "ts-node-maintained": "^10.9.5",
-    "tsup": "^8.5.0",
-    "typescript": "^5.8.3"
+    "chai": "^6.2.1",
+    "cross-env": "^10.1.0",
+    "del-cli": "^7.0.0",
+    "eslint": "^9.39.2",
+    "prettier": "^3.7.4",
+    "release-it": "^19.1.0",
+    "serialize-error": "^12.0.0",
+    "tsdown": "^0.17.3",
+    "typescript": "^5.9.3"
   },
   "dependencies": {
-    "@japa/core": "^10.3.0",
-    "@japa/errors-printer": "^4.1.2",
-    "@poppinss/colors": "^4.1.5",
-    "@poppinss/hooks": "^7.2.6",
-    "fast-glob": "^3.3.3",
+    "@japa/core": "^10.4.0",
+    "@japa/errors-printer": "^4.1.4",
+    "@poppinss/colors": "^4.1.6",
+    "@poppinss/hooks": "^7.3.0",
+    "@poppinss/string": "^1.7.1",
+    "error-stack-parser-es": "^1.0.5",
     "find-cache-directory": "^6.0.0",
     "getopts": "^2.3.0",
-    "ms": "^2.1.3",
-    "serialize-error": "^12.0.0",
-    "slash": "^5.1.0",
-    "supports-color": "^10.0.0"
+    "supports-color": "^10.2.2"
   },
   "homepage": "https://github.com/japa/runner#readme",
   "repository": {
@@ -87,10 +84,11 @@
     "access": "public",
     "provenance": true
   },
-  "tsup": {
+  "tsdown": {
     "entry": [
       "./index.ts",
       "./src/types.ts",
+      "./src/plugins/main.ts",
       "./src/reporters/main.ts",
       "./factories/main.ts",
       "./modules/core/main.ts"
@@ -98,8 +96,11 @@
     "outDir": "./build",
     "clean": true,
     "format": "esm",
+    "minify": "dce-only",
+    "fixedExtension": false,
     "dts": false,
-    "sourcemap": false,
+    "treeshake": false,
+    "sourcemaps": false,
     "target": "esnext"
   },
   "release-it": {

package/build/chunk-2KG3PWR4.js

@@ -1,17 +0,0 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
-
-export {
-  __reExport
-};