@epicat/toon-reporter 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tom Siwik
+
+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,156 @@
+# toon-reporter
+
+A minimal Vitest reporter optimized for LLM consumption. Outputs test results in a compact, token-efficient format.
+
+## Installation
+
+```bash
+npm install @epicat/toon-reporter
+```
+
+## Usage
+
+### CLI
+
+```bash
+npx vitest run --reporter=@epicat/toon-reporter
+```
+
+### Config
+
+```ts
+// vitest.config.ts
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    reporters: ['@epicat/toon-reporter'],
+  },
+})
+```
+
+## Output Format
+
+### All tests passing
+
+```
+passing: 42
+```
+
+### With failures
+
+```
+passing: 40
+failing[2]:
+- at: src/utils.test.ts:15:12
+  expected: "7"
+  got: "6"
+- at: src/api.test.ts:42:8
+  error: TypeError: Cannot read property 'id' of undefined
+```
+
+### With parameterized test failures
+
+Uses TOON tabular format for uniform parameter arrays:
+
+```
+passing: 6
+failing[2]:
+- at: math.test.ts:16:17
+  parameters[2]{expected,got}:
+    "1","2"
+    "4","2"
+```
+
+### With todo/skipped tests
+
+Uses TOON tabular format for uniform arrays:
+
+```
+passing: 38
+todo[1]{at,name}:
+  src/api.test.ts,implement error handling
+skipped[2]{at,name}:
+  src/utils.test.ts,handles edge case
+```
+
+## Colors
+
+- **Green**: `passing` count
+- **Red**: `failing` header
+- **Yellow**: file paths
+- **Gray**: `skipped` tests
+- **Cyan**: `todo` tests
+
+Colors are automatically disabled when:
+- `NO_COLOR` environment variable is set
+- `CI` environment variable is set
+- Output is written to a file
+
+## Options
+
+### `color`
+
+Enable/disable colored output (default: `false`).
+
+```ts
+// vitest.config.ts
+import { defineConfig } from 'vitest/config'
+import { ToonReporter } from '@epicat/toon-reporter'
+
+export default defineConfig({
+  test: {
+    reporters: [new ToonReporter({ color: true })],
+  },
+})
+```
+
+### `outputFile`
+
+Write report to a file instead of stdout.
+
+```ts
+reporters: [['toon-reporter', { outputFile: 'test-results.txt' }]]
+```
+
+## Skipped/Todo Line Numbers
+
+To get line:column information for skipped and todo tests, enable `includeTaskLocation` in your vitest config:
+
+```ts
+// vitest.config.ts
+export default defineConfig({
+  test: {
+    includeTaskLocation: true,
+    reporters: ['toon-reporter'],
+  },
+})
+```
+
+Or via CLI:
+
+```bash
+npx vitest run --reporter=toon-reporter --includeTaskLocation
+```
+
+Without this option, skipped/todo tests will only show the file path (not line:column). This is a Vitest limitation - test locations are only collected when this config is enabled before test collection.
+
+## Why?
+
+Traditional test reporters output verbose information optimized for human readability. When feeding test results to an LLM for automated fixing, this verbosity wastes tokens. This reporter outputs only what's needed:
+
+- Pass count
+- Failure locations with expected/got values
+- Skipped/todo test names for context
+
+## Token Efficiency
+
+Measured on a test suite with 25 tests (16 passing, 7 failing, 1 skipped, 1 todo):
+
+| Reporter | Tokens | vs Default | vs JSON |
+|----------|-------:|:----------:|:-------:|
+| default  |  4,884 |     -      |   -10%  |
+| json     |  5,418 |    +11%    |    -    |
+| **toon** |  **212** | **-96%** | **-96%** |
+
+TOON uses ~96% fewer tokens than standard reporters.

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@epicat/toon-reporter",
+  "version": "0.0.1",
+  "description": "A minimal Vitest reporter optimized for LLM consumption",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tomsiwik/toon-reporter.git"
+  },
+  "license": "MIT",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": "./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",
+    "@types/node": "^24.10.1",
+    "@vitest/runner": "4.0.15",
+    "@vitest/snapshot": "4.0.15",
+    "@vitest/utils": "4.0.15",
+    "execa": "^9.6.1",
+    "gpt-tokenizer": "^3.4.0",
+    "istanbul-lib-coverage": "^3.2.2",
+    "pathe": "^2.0.3",
+    "tsdown": "^0.16.4",
+    "typescript": "^5.9.3",
+    "vite": "^7.2.6",
+    "vitest": "4.0.15"
+  },
+  "packageManager": "pnpm@10.22.0+sha512.bf049efe995b28f527fd2b41ae0474ce29186f7edcb3bf545087bd61fbbebb2bf75362d1307fda09c2d288e1e499787ac12d4fcb617a974718a6051f2eee741c",
+  "dependencies": {
+    "@toon-format/toon": "^2.0.1"
+  }
+}