vitest-tiny-reporter 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Kevin Brey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,48 @@
+# vitest-tiny-reporter
+
+[![npm](https://img.shields.io/npm/v/vitest-tiny-reporter?style=flat-square)](https://www.npmjs.com/package/vitest-tiny-reporter?activeTab=versions)
+[![npm bundle size](https://img.shields.io/bundlephobia/minzip/vitest-tiny-reporter?style=flat-square)](https://bundlephobia.com/package/vitest-tiny-reporter)
+[![NPM](https://img.shields.io/npm/l/vitest-tiny-reporter?style=flat-square)](https://raw.githubusercontent.com/manbearwiz/vitest-tiny-reporter/master/LICENSE)
+[![npm](https://img.shields.io/npm/dt/vitest-tiny-reporter?style=flat-square)](https://www.npmjs.com/package/vitest-tiny-reporter)
+[![GitHub issues](https://img.shields.io/github/issues/manbearwiz/vitest-tiny-reporter?style=flat-square)](https://github.com/manbearwiz/vitest-tiny-reporter/issues)
+[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release&style=flat-square)](https://github.com/semantic-release/semantic-release)
+
+`vitest-tiny-reporter` is a minimal reporter for [Vitest](https://github.com/vitest-dev/vitest) that provides the most essential information about the test run. This is very useful with tools like lefthook that run several checks in parallel, where you want to see the test results without scrolling through a lot of output.
+
+## Installation
+
+```sh
+npm install --save vitest-tiny-reporter
+```
+
+## Usage
+
+You can specify the reporter in your `vitest.config.ts`:
+
+```ts
+import type { UserConfig } from 'vitest/config';
+import TinyReporter from 'vite-tiny-reporter';
+
+export default {
+  test: {
+    reporters: [new TinyReporter()],
+  },
+} satisfies UserConfig;
+```
+
+Or you can use the reporter from the command line:
+
+```sh
+vitest --reporter vitest-tiny-reporter
+```
+
+## Output
+
+The output will look like this:
+
+```sh
+$ vitest
+ ✖ FAIL  1 test failed
+ Test Files  1 failed (1)
+      Tests  1 failed | 10 passed (11)
+```

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import type { Task, Vitest } from 'vitest';
+import type { Reporter } from 'vitest/reporters';
+export declare class TinyReporter implements Reporter {
+    ctx: Vitest;
+    protected verbose: boolean;
+    onInit(ctx: Vitest): void;
+    onFinished(files?: import("vitest").File[], errors?: unknown[]): void;
+    padTitle: (str: string) => string;
+    getStateString(tasks: Task[], name?: string): string;
+}

package/dist/index.js

@@ -0,0 +1,56 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TinyReporter = void 0;
+const utils_1 = require("@vitest/runner/utils");
+const tinyrainbow_1 = __importDefault(require("tinyrainbow"));
+class TinyReporter {
+    constructor() {
+        // biome-ignore lint/style/noNonNullAssertion: Non-null assertion is allowed here because the onInit method is called before any other method
+        this.ctx = undefined;
+        this.verbose = false;
+        this.padTitle = (str) => tinyrainbow_1.default.dim(`${str.padStart(11)} `);
+    }
+    onInit(ctx) {
+        this.ctx = ctx;
+    }
+    onFinished(files = this.ctx.state.getFiles(), errors = this.ctx.state.getUnhandledErrors()) {
+        const { logger } = this.ctx;
+        const tests = (0, utils_1.getTests)(files);
+        const failedTests = tests.filter((i) => { var _a; return ((_a = i.result) === null || _a === void 0 ? void 0 : _a.state) === 'fail'; }).length;
+        const passed = !(failedTests + errors.length);
+        const status = passed ? '\u2714 PASS' : '\u2716 FAIL';
+        const statusColor = passed ? tinyrainbow_1.default.green : tinyrainbow_1.default.red;
+        logger.log(`${statusColor(tinyrainbow_1.default.bold(tinyrainbow_1.default.inverse(` ${status} `)))} ${statusColor(passed
+            ? 'All tests passed'
+            : `${failedTests} test${failedTests > 1 ? 's' : ''} failed`)}`);
+        logger.log(this.padTitle('Test Files'), this.getStateString(files));
+        logger.log(this.padTitle('Tests'), this.getStateString(tests));
+        if (errors.length) {
+            logger.log(this.padTitle('Errors'), tinyrainbow_1.default.bold(tinyrainbow_1.default.red(`${errors.length} error${errors.length > 1 ? 's' : ''}`)));
+        }
+        if (!passed) {
+            process.exitCode = 1;
+        }
+    }
+    getStateString(tasks, name = 'tests') {
+        if (!tasks.length) {
+            return tinyrainbow_1.default.dim(`no ${name}`);
+        }
+        const passed = tasks.filter((i) => { var _a; return ((_a = i.result) === null || _a === void 0 ? void 0 : _a.state) === 'pass'; }).length;
+        const failed = tasks.filter((i) => { var _a; return ((_a = i.result) === null || _a === void 0 ? void 0 : _a.state) === 'fail'; }).length;
+        const skipped = tasks.filter((i) => i.mode === 'skip').length;
+        const todo = tasks.filter((i) => i.mode === 'todo').length;
+        return ([
+            failed && tinyrainbow_1.default.bold(tinyrainbow_1.default.red(`${failed} failed`)),
+            passed && tinyrainbow_1.default.bold(tinyrainbow_1.default.green(`${passed} passed`)),
+            skipped && tinyrainbow_1.default.yellow(`${skipped} skipped`),
+            todo && tinyrainbow_1.default.gray(`${todo} todo`),
+        ]
+            .filter(Boolean)
+            .join(tinyrainbow_1.default.dim(' | ')) + tinyrainbow_1.default.gray(` (${tasks.length})`));
+    }
+}
+exports.TinyReporter = TinyReporter;

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "vitest-tiny-reporter",
+  "version": "1.0.0",
+  "description": "Tiny reporter for vitest",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "keywords": [
+    "vitest",
+    "reporter",
+    "lefthook"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "coverage": "vitest run --coverage",
+    "test:watch": "vitest --watch --coverage --ui",
+    "prepublish": "npm run build",
+    "semantic-release": "semantic-release",
+    "lint": "npx @biomejs/biome check",
+    "lint:fix": "npx @biomejs/biome check --write"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/manbearwiz/vitest-tiny-reporter.git"
+  },
+  "author": "Kevin Brey",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/manbearwiz/vitest-tiny-reporter/issues"
+  },
+  "homepage": "https://github.com/manbearwiz/vitest-tiny-reporter#readme",
+  "devDependencies": {
+    "@biomejs/biome": "1.8.3",
+    "@commitlint/cli": "^19.3.0",
+    "@commitlint/config-angular": "^19.3.0",
+    "@tsconfig/recommended": "^1.0.3",
+    "@tsconfig/strictest": "^2.0.2",
+    "@types/node": "^20.12.12",
+    "@vitest/coverage-v8": "^2.0.3",
+    "@vitest/ui": "^2.0.3",
+    "happy-dom": "^14.12.3",
+    "semantic-release": "^22.0.0",
+    "typescript": "^5.2.2"
+  },
+  "dependencies": {
+    "@vitest/runner": "^2.0.3",
+    "tinyrainbow": "^1.2.0",
+    "vitest": "^2.0.3"
+  },
+  "release": {
+    "branches": [
+      "main"
+    ]
+  }
+}