@epicat/toon-reporter 0.0.1 → 0.0.2

package/dist/index.d.mts

@@ -0,0 +1,145 @@
+import { Awaitable, SerializedError } from "@vitest/utils";
+import { File, TaskEventPack, TaskResultPack, TestAnnotation, TestArtifact } from "@vitest/runner";
+import { ReportedHookContext, TestCase, TestModule, TestProject, TestSpecification, TestSuite, Vitest } from "vitest/node";
+
+//#region src/reporter.d.ts
+type TestRunEndReason = 'passed' | 'interrupted' | 'failed';
+interface UserConsoleLog {
+  content: string;
+  origin?: string;
+  browser?: boolean;
+  type: 'stdout' | 'stderr';
+  taskId?: string;
+  time: number;
+  size: number;
+}
+interface Reporter {
+  onInit?: (vitest: Vitest) => void;
+  /**
+   * Called when the project initiated the browser instance.
+   * project.browser will always be defined.
+   * @experimental
+   */
+  onBrowserInit?: (project: TestProject) => Awaitable<void>;
+  /** @internal   */
+  onTaskUpdate?: (packs: TaskResultPack[], events: TaskEventPack[]) => Awaitable<void>;
+  onTestRemoved?: (trigger?: string) => Awaitable<void>;
+  onWatcherStart?: (files?: File[], errors?: unknown[]) => Awaitable<void>;
+  onWatcherRerun?: (files: string[], trigger?: string) => Awaitable<void>;
+  onServerRestart?: (reason?: string) => Awaitable<void>;
+  onUserConsoleLog?: (log: UserConsoleLog) => Awaitable<void>;
+  onProcessTimeout?: () => Awaitable<void>;
+  /**
+   * Called when the new test run starts.
+   */
+  onTestRunStart?: (specifications: ReadonlyArray<TestSpecification>) => Awaitable<void>;
+  /**
+   * Called when the test run is finished.
+   */
+  onTestRunEnd?: (testModules: ReadonlyArray<TestModule>, unhandledErrors: ReadonlyArray<SerializedError>, reason: TestRunEndReason) => Awaitable<void>;
+  /**
+   * Called when the module is enqueued for testing. The file itself is not loaded yet.
+   */
+  onTestModuleQueued?: (testModule: TestModule) => Awaitable<void>;
+  /**
+   * Called when the test file is loaded and the module is ready to run tests.
+   */
+  onTestModuleCollected?: (testModule: TestModule) => Awaitable<void>;
+  /**
+   * Called when starting to run tests of the test file
+   */
+  onTestModuleStart?: (testModule: TestModule) => Awaitable<void>;
+  /**
+   * Called when all tests of the test file have finished running.
+   */
+  onTestModuleEnd?: (testModule: TestModule) => Awaitable<void>;
+  /**
+   * Called when test case is ready to run.
+   * Called before the `beforeEach` hooks for the test are run.
+   */
+  onTestCaseReady?: (testCase: TestCase) => Awaitable<void>;
+  /**
+   * Called after the test and its hooks are finished running.
+   * The `result()` cannot be `pending`.
+   */
+  onTestCaseResult?: (testCase: TestCase) => Awaitable<void>;
+  /**
+   * Called when annotation is added via the `task.annotate` API.
+   */
+  onTestCaseAnnotate?: (testCase: TestCase, annotation: TestAnnotation) => Awaitable<void>;
+  /**
+   * Called when artifacts are recorded on tests via the `recordArtifact` utility.
+   */
+  onTestCaseArtifactRecord?: (testCase: TestCase, artifact: TestArtifact) => Awaitable<void>;
+  /**
+   * Called when test suite is ready to run.
+   * Called before the `beforeAll` hooks for the test are run.
+   */
+  onTestSuiteReady?: (testSuite: TestSuite) => Awaitable<void>;
+  /**
+   * Called after the test suite and its hooks are finished running.
+   * The `state` cannot be `pending`.
+   */
+  onTestSuiteResult?: (testSuite: TestSuite) => Awaitable<void>;
+  /**
+   * Called before the hook starts to run.
+   */
+  onHookStart?: (hook: ReportedHookContext) => Awaitable<void>;
+  /**
+   * Called after the hook finished running.
+   */
+  onHookEnd?: (hook: ReportedHookContext) => Awaitable<void>;
+  onCoverage?: (coverage: unknown) => Awaitable<void>;
+}
+//#endregion
+//#region src/toon-reporter.d.ts
+interface ToonFailure {
+  at: string;
+  absPath: string;
+  line?: number;
+  column?: number;
+  expected?: string;
+  got?: string;
+  error?: string;
+  each?: boolean;
+}
+interface ToonSkipped {
+  at: string;
+  absPath: string;
+  line?: number;
+  column?: number;
+  name: string;
+}
+interface ToonReport {
+  passing: number;
+  failing?: ToonFailure[];
+  skipped?: ToonSkipped[];
+  todo?: ToonSkipped[];
+}
+interface ToonReporterOptions {
+  outputFile?: string;
+  color?: boolean;
+  /** @internal Used for testing to capture output */
+  _captureOutput?: (output: string) => void;
+}
+declare class ToonReporter implements Reporter {
+  start: number;
+  ctx: Vitest;
+  options: ToonReporterOptions;
+  constructor(options?: ToonReporterOptions);
+  onInit(ctx: Vitest): void;
+  private parseLocation;
+  private parseExpectedGot;
+  onTestRunEnd(testModules: ReadonlyArray<any>, _unhandledErrors: ReadonlyArray<SerializedError>, _reason: TestRunEndReason): Promise<void>;
+  /**
+   * Quote a string value per TOON spec:
+   * - Quote if contains delimiter (comma), newline, carriage return, tab, backslash, or quote
+   * - Quote if matches reserved keywords (true, false, null)
+   * - Quote if looks like a number but should be a string
+   */
+  private toonQuote;
+  private formatOutput;
+  writeReport(report: string): Promise<void>;
+}
+//#endregion
+export { type Reporter, type TestRunEndReason, type ToonFailure, type ToonReport, ToonReporter, ToonReporter as default, type ToonReporterOptions, type ToonSkipped, type UserConsoleLog };

package/dist/index.mjs

@@ -0,0 +1,345 @@
+import { existsSync, promises } from "node:fs";
+
+//#region node_modules/.pnpm/@vitest+utils@4.0.15/node_modules/@vitest/utils/dist/helpers.js
+function toArray(array) {
+	if (array === null || array === void 0) array = [];
+	if (Array.isArray(array)) return array;
+	return [array];
+}
+
+//#endregion
+//#region node_modules/.pnpm/pathe@2.0.3/node_modules/pathe/dist/shared/pathe.M-eThtNZ.mjs
+const _DRIVE_LETTER_START_RE = /^[A-Za-z]:\//;
+function normalizeWindowsPath(input = "") {
+	if (!input) return input;
+	return input.replace(/\\/g, "/").replace(_DRIVE_LETTER_START_RE, (r) => r.toUpperCase());
+}
+const _IS_ABSOLUTE_RE = /^[/\\](?![/\\])|^[/\\]{2}(?!\.)|^[A-Za-z]:[/\\]/;
+const _DRIVE_LETTER_RE = /^[A-Za-z]:$/;
+const _ROOT_FOLDER_RE = /^\/([A-Za-z]:)?$/;
+function cwd() {
+	if (typeof process !== "undefined" && typeof process.cwd === "function") return process.cwd().replace(/\\/g, "/");
+	return "/";
+}
+const resolve = function(...arguments_) {
+	arguments_ = arguments_.map((argument) => normalizeWindowsPath(argument));
+	let resolvedPath = "";
+	let resolvedAbsolute = false;
+	for (let index = arguments_.length - 1; index >= -1 && !resolvedAbsolute; index--) {
+		const path = index >= 0 ? arguments_[index] : cwd();
+		if (!path || path.length === 0) continue;
+		resolvedPath = `${path}/${resolvedPath}`;
+		resolvedAbsolute = isAbsolute(path);
+	}
+	resolvedPath = normalizeString(resolvedPath, !resolvedAbsolute);
+	if (resolvedAbsolute && !isAbsolute(resolvedPath)) return `/${resolvedPath}`;
+	return resolvedPath.length > 0 ? resolvedPath : ".";
+};
+function normalizeString(path, allowAboveRoot) {
+	let res = "";
+	let lastSegmentLength = 0;
+	let lastSlash = -1;
+	let dots = 0;
+	let char = null;
+	for (let index = 0; index <= path.length; ++index) {
+		if (index < path.length) char = path[index];
+		else if (char === "/") break;
+		else char = "/";
+		if (char === "/") {
+			if (lastSlash === index - 1 || dots === 1);
+			else if (dots === 2) {
+				if (res.length < 2 || lastSegmentLength !== 2 || res[res.length - 1] !== "." || res[res.length - 2] !== ".") {
+					if (res.length > 2) {
+						const lastSlashIndex = res.lastIndexOf("/");
+						if (lastSlashIndex === -1) {
+							res = "";
+							lastSegmentLength = 0;
+						} else {
+							res = res.slice(0, lastSlashIndex);
+							lastSegmentLength = res.length - 1 - res.lastIndexOf("/");
+						}
+						lastSlash = index;
+						dots = 0;
+						continue;
+					} else if (res.length > 0) {
+						res = "";
+						lastSegmentLength = 0;
+						lastSlash = index;
+						dots = 0;
+						continue;
+					}
+				}
+				if (allowAboveRoot) {
+					res += res.length > 0 ? "/.." : "..";
+					lastSegmentLength = 2;
+				}
+			} else {
+				if (res.length > 0) res += `/${path.slice(lastSlash + 1, index)}`;
+				else res = path.slice(lastSlash + 1, index);
+				lastSegmentLength = index - lastSlash - 1;
+			}
+			lastSlash = index;
+			dots = 0;
+		} else if (char === "." && dots !== -1) ++dots;
+		else dots = -1;
+	}
+	return res;
+}
+const isAbsolute = function(p) {
+	return _IS_ABSOLUTE_RE.test(p);
+};
+const relative = function(from, to) {
+	const _from = resolve(from).replace(_ROOT_FOLDER_RE, "$1").split("/");
+	const _to = resolve(to).replace(_ROOT_FOLDER_RE, "$1").split("/");
+	if (_to[0][1] === ":" && _from[0][1] === ":" && _from[0] !== _to[0]) return _to.join("/");
+	const _fromCopy = [..._from];
+	for (const segment of _fromCopy) {
+		if (_to[0] !== segment) break;
+		_from.shift();
+		_to.shift();
+	}
+	return [..._from.map(() => ".."), ..._to].join("/");
+};
+const dirname = function(p) {
+	const segments = normalizeWindowsPath(p).replace(/\/$/, "").split("/").slice(0, -1);
+	if (segments.length === 1 && _DRIVE_LETTER_RE.test(segments[0])) segments[0] += "/";
+	return segments.join("/") || (isAbsolute(p) ? "/" : ".");
+};
+
+//#endregion
+//#region node_modules/.pnpm/@vitest+runner@4.0.15/node_modules/@vitest/runner/dist/chunk-tasks.js
+function isTestCase(s) {
+	return s.type === "test";
+}
+function getTests(suite) {
+	const tests = [];
+	const arraySuites = toArray(suite);
+	for (const s of arraySuites) if (isTestCase(s)) tests.push(s);
+	else for (const task of s.tasks) if (isTestCase(task)) tests.push(task);
+	else {
+		const taskTests = getTests(task);
+		for (const test of taskTests) tests.push(test);
+	}
+	return tests;
+}
+
+//#endregion
+//#region src/config-helpers.ts
+function getOutputFile(config, reporter) {
+	if (!config?.outputFile) return;
+	if (typeof config.outputFile === "string") return config.outputFile;
+	return config.outputFile[reporter];
+}
+
+//#endregion
+//#region src/toon-reporter.ts
+const colors = {
+	green: "\x1B[32m",
+	red: "\x1B[31m",
+	yellow: "\x1B[33m",
+	cyan: "\x1B[36m",
+	gray: "\x1B[90m",
+	reset: "\x1B[0m"
+};
+function link(url, text) {
+	return `\x1b]8;;${url}\x1b\\${text}\x1b]8;;\x1b\\`;
+}
+function fileLink(filePath, line, column) {
+	let url = `file://${filePath}`;
+	if (line) {
+		url += `:${line}`;
+		if (column) url += `:${column}`;
+	}
+	return url;
+}
+var ToonReporter = class {
+	constructor(options = {}) {
+		this.start = 0;
+		this.options = {
+			color: false,
+			...options
+		};
+	}
+	onInit(ctx) {
+		this.ctx = ctx;
+		this.start = Date.now();
+	}
+	parseLocation(error, rootDir) {
+		const lines = (error?.stack || "").split("\n");
+		for (const line of lines) {
+			const match = line.match(/at\s+(?:.*?\s+\()?([^)\s]+):(\d+):(\d+)\)?/);
+			if (match) {
+				const [, filePath, lineNum, column] = match;
+				if (filePath.includes("node_modules") || filePath.startsWith("file:")) continue;
+				const absPath = filePath.startsWith(rootDir) ? filePath : resolve(rootDir, filePath);
+				return {
+					absPath,
+					relPath: relative(rootDir, absPath),
+					line: parseInt(lineNum, 10),
+					column: parseInt(column, 10)
+				};
+			}
+		}
+		return null;
+	}
+	parseExpectedGot(error) {
+		const matchToBe = (error?.message || "").match(/expected\s+(.+?)\s+to\s+(?:be|equal|deeply equal)\s+(.+?)(?:\s*\/\/|$)/i);
+		if (matchToBe) return {
+			expected: matchToBe[2].trim(),
+			got: matchToBe[1].trim()
+		};
+		if (error?.expected !== void 0 && error?.actual !== void 0) return {
+			expected: String(error.expected),
+			got: String(error.actual)
+		};
+		return {};
+	}
+	async onTestRunEnd(testModules, _unhandledErrors, _reason) {
+		const tests = getTests(testModules.map((testModule) => testModule.task));
+		const rootDir = this.ctx.config.root;
+		const failedTests = tests.filter((t) => t.result?.state === "fail");
+		const passedCount = tests.filter((t) => t.result?.state === "pass").length;
+		const skippedTests = tests.filter((t) => t.mode === "skip");
+		const todoTests = tests.filter((t) => t.mode === "todo");
+		const failures = failedTests.map((t) => {
+			const error = t.result?.errors?.[0];
+			const parsed = this.parseLocation(error, rootDir);
+			const { expected, got } = this.parseExpectedGot(error);
+			const absPath = parsed?.absPath || t.file.filepath;
+			const relPath = parsed?.relPath || relative(rootDir, t.file.filepath);
+			const line = parsed?.line || t.location?.line;
+			const column = parsed?.column || t.location?.column;
+			const failure = {
+				at: line ? `${relPath}:${line}:${column || 0}` : relPath,
+				absPath,
+				line,
+				column,
+				each: t.each
+			};
+			if (expected !== void 0 && got !== void 0) {
+				failure.expected = expected;
+				failure.got = got;
+			} else if (error) {
+				let message = error.message || String(error);
+				if (message.startsWith("Test timed out")) message = message.split("\n")[0];
+				const errorName = error.name;
+				if (errorName && errorName !== "Error" && !message.startsWith(errorName)) message = `${errorName}: ${message}`;
+				failure.error = message;
+			}
+			return failure;
+		});
+		const skipped = skippedTests.map((t) => {
+			const relPath = relative(rootDir, t.file.filepath);
+			const line = t.location?.line;
+			const column = t.location?.column;
+			return {
+				at: line ? `${relPath}:${line}:${column || 0}` : relPath,
+				absPath: t.file.filepath,
+				line,
+				column,
+				name: t.name
+			};
+		});
+		const todo = todoTests.map((t) => {
+			const relPath = relative(rootDir, t.file.filepath);
+			const line = t.location?.line;
+			const column = t.location?.column;
+			return {
+				at: line ? `${relPath}:${line}:${column || 0}` : relPath,
+				absPath: t.file.filepath,
+				line,
+				column,
+				name: t.name
+			};
+		});
+		const output = this.formatOutput(passedCount, failures, skipped, todo);
+		await this.writeReport(output);
+	}
+	/**
+	* Quote a string value per TOON spec:
+	* - Quote if contains delimiter (comma), newline, carriage return, tab, backslash, or quote
+	* - Quote if matches reserved keywords (true, false, null)
+	* - Quote if looks like a number but should be a string
+	*/
+	toonQuote(value, delimiter = ",") {
+		if (!(value.includes(delimiter) || value.includes("\n") || value.includes("\r") || value.includes("	") || value.includes("\\") || value.includes("\"") || value === "true" || value === "false" || value === "null" || /^-?\d+(\.\d+)?$/.test(value))) return value;
+		return `"${value.replace(/\\/g, "\\\\").replace(/"/g, "\\\"").replace(/\n/g, "\\n").replace(/\r/g, "\\r").replace(/\t/g, "\\t")}"`;
+	}
+	formatOutput(passing, failures, skipped, todo) {
+		const useColor = this.options.color && !this.options.outputFile && !this.options._captureOutput && !process.env.NO_COLOR && !process.env.CI;
+		const { green, red, yellow, cyan, gray, reset } = useColor ? colors : {
+			green: "",
+			red: "",
+			yellow: "",
+			cyan: "",
+			gray: "",
+			reset: ""
+		};
+		const formatLocation = (at, absPath, line, column, color = yellow) => {
+			if (useColor) return `${color}${link(fileLink(absPath, line, column), at)}${reset}`;
+			return at;
+		};
+		const lines = [];
+		lines.push(`${green}passing: ${passing}${reset}`);
+		if (failures.length > 0) {
+			lines.push(`${red}failing[${failures.length}]:${reset}`);
+			const grouped = /* @__PURE__ */ new Map();
+			const regular = [];
+			for (const failure of failures) if (failure.each) {
+				const key = failure.at;
+				if (!grouped.has(key)) grouped.set(key, []);
+				grouped.get(key).push(failure);
+			} else regular.push(failure);
+			for (const failure of regular) {
+				lines.push(`- at: ${formatLocation(failure.at, failure.absPath, failure.line, failure.column)}`);
+				if (failure.expected !== void 0 && failure.got !== void 0) {
+					lines.push(`  expected: ${this.toonQuote(failure.expected)}`);
+					lines.push(`  got: ${this.toonQuote(failure.got)}`);
+				} else if (failure.error) lines.push(`  error: ${this.toonQuote(failure.error)}`);
+			}
+			for (const [, groupedFailures] of grouped) {
+				const first = groupedFailures[0];
+				lines.push(`- at: ${formatLocation(first.at, first.absPath, first.line, first.column)}`);
+				if (groupedFailures.every((f) => f.expected !== void 0 && f.got !== void 0)) {
+					lines.push(`  parameters[${groupedFailures.length}]{expected,got}:`);
+					for (const failure of groupedFailures) lines.push(`    ${this.toonQuote(failure.expected)},${this.toonQuote(failure.got)}`);
+				} else {
+					lines.push(`  parameters[${groupedFailures.length}]{error}:`);
+					for (const failure of groupedFailures) if (failure.error) lines.push(`    ${this.toonQuote(failure.error)}`);
+				}
+			}
+		}
+		if (todo.length > 0) {
+			lines.push(`${cyan}todo[${todo.length}]{at,name}:${reset}`);
+			for (const t of todo) {
+				const at = formatLocation(t.at, t.absPath, t.line, t.column);
+				lines.push(`${cyan}  ${at},${this.toonQuote(t.name)}${reset}`);
+			}
+		}
+		if (skipped.length > 0) {
+			lines.push(`${gray}skipped[${skipped.length}]{at,name}:${reset}`);
+			for (const s of skipped) {
+				const at = formatLocation(s.at, s.absPath, s.line, s.column, gray);
+				lines.push(`${gray}  ${at},${this.toonQuote(s.name)}${reset}`);
+			}
+		}
+		return lines.join("\n");
+	}
+	async writeReport(report) {
+		if (this.options._captureOutput) {
+			this.options._captureOutput(report);
+			return;
+		}
+		const outputFile = this.options.outputFile ?? getOutputFile(this.ctx.config, "toon");
+		if (outputFile) {
+			const reportFile = resolve(this.ctx.config.root, outputFile);
+			const outputDirectory = dirname(reportFile);
+			if (!existsSync(outputDirectory)) await promises.mkdir(outputDirectory, { recursive: true });
+			await promises.writeFile(reportFile, report, "utf-8");
+			this.ctx.logger.log(`TOON report written to ${reportFile}`);
+		} else this.ctx.logger.log(report);
+	}
+};
+
+//#endregion
+export { ToonReporter, ToonReporter as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epicat/toon-reporter",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "A minimal Vitest reporter optimized for LLM consumption",
   "repository": {
     "type": "git",
@@ -18,12 +18,6 @@
     ".": "./dist/index.mjs",
     "./package.json": "./package.json"
   },
-  "scripts": {
-    "build": "tsdown",
-    "dev": "tsdown --watch",
-    "test": "vitest run",
-    "test:watch": "vitest"
-  },
   "devDependencies": {
     "@changesets/cli": "^2.29.8",
     "@types/istanbul-lib-coverage": "^2.0.6",
@@ -40,8 +34,13 @@
     "vite": "^7.2.6",
     "vitest": "4.0.15"
   },
-  "packageManager": "pnpm@10.22.0+sha512.bf049efe995b28f527fd2b41ae0474ce29186f7edcb3bf545087bd61fbbebb2bf75362d1307fda09c2d288e1e499787ac12d4fcb617a974718a6051f2eee741c",
   "dependencies": {
     "@toon-format/toon": "^2.0.1"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "test": "vitest run",
+    "test:watch": "vitest"
   }
-}
+}