xtrm-tools 2.0.0

package/project-skills/tdd-guard/reporters/storybook/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "tdd-guard-storybook",
+  "version": "0.1.0",
+  "description": "Storybook test-runner reporter for TDD Guard",
+  "author": "Tony Kornmeier",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nizos/tdd-guard.git",
+    "directory": "reporters/storybook"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "!dist/*.tsbuildinfo",
+    "!dist/*.test-data.*"
+  ],
+  "scripts": {
+    "build": "tsc --build",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "tdd-guard": "^1.1.0"
+  },
+  "peerDependencies": {
+    "@storybook/test-runner": ">=0.19.0"
+  },
+  "devDependencies": {
+    "@storybook/react-vite": "^8.4.7",
+    "@storybook/test": "^8.4.7",
+    "@storybook/test-runner": "^0.19.1",
+    "@types/node": "^24.1.0",
+    "@types/react": "^18.3.18",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "storybook": "^8.4.7",
+    "typescript": "^5.8.3",
+    "vite": "^6.0.11",
+    "vitest": "^3.2.4"
+  }
+}

package/project-skills/tdd-guard/reporters/storybook/src/StorybookReporter.test-data.ts

@@ -0,0 +1,22 @@
+import type { TestContext } from './types'
+
+const DEFAULT_STORY_ID = 'button--primary'
+const DEFAULT_STORY_TITLE = 'Button'
+const DEFAULT_STORY_NAME = 'Primary'
+
+export function createStoryContext(
+  overrides?: Partial<TestContext>
+): TestContext {
+  return {
+    id: DEFAULT_STORY_ID,
+    title: DEFAULT_STORY_TITLE,
+    name: DEFAULT_STORY_NAME,
+    ...overrides,
+  }
+}
+
+// Convenience aliases for createStoryContext
+export const passedStoryContext = createStoryContext
+export const failedStoryContext = createStoryContext
+export const skippedStoryContext = createStoryContext
+export const renderErrorContext = createStoryContext

package/project-skills/tdd-guard/reporters/storybook/src/StorybookReporter.test.ts

@@ -0,0 +1,190 @@
+import { describe, it, expect, beforeEach } from 'vitest'
+import { StorybookReporter } from './StorybookReporter'
+import { MemoryStorage, FileStorage, Config, DEFAULT_DATA_DIR } from 'tdd-guard'
+import {
+  createStoryContext,
+  passedStoryContext,
+  failedStoryContext,
+} from './StorybookReporter.test-data'
+import { join } from 'node:path'
+import type { StoryTest } from './types'
+
+describe('StorybookReporter', () => {
+  it('uses FileStorage by default', () => {
+    const reporter = new StorybookReporter()
+    expect(reporter['storage']).toBeInstanceOf(FileStorage)
+  })
+
+  it('accepts Storage instance in constructor', () => {
+    const storage = new MemoryStorage()
+    const reporter = new StorybookReporter(storage)
+    expect(reporter['storage']).toBe(storage)
+  })
+
+  it('accepts root path string in constructor', () => {
+    const rootPath = '/some/project/root'
+    const reporter = new StorybookReporter(rootPath)
+    expect(reporter['storage']).toBeInstanceOf(FileStorage)
+    const fileStorage = reporter['storage'] as FileStorage
+    const config = fileStorage['config'] as Config
+    const expectedDataDir = join(rootPath, ...DEFAULT_DATA_DIR.split('/'))
+    expect(config.dataDir).toBe(expectedDataDir)
+  })
+
+  describe('when collecting story results', () => {
+    let storage: MemoryStorage
+    let reporter: StorybookReporter
+
+    beforeEach(() => {
+      storage = new MemoryStorage()
+      reporter = new StorybookReporter(storage)
+    })
+
+    it('saves output as valid JSON', async () => {
+      const context = passedStoryContext()
+      await reporter.onStoryResult(context)
+      await reporter.onComplete()
+
+      const saved = await storage.getTest()
+      expect(saved).toBeTruthy()
+      const parsed = JSON.parse(saved!)
+      expect(parsed).toBeDefined()
+    })
+
+    it('includes test modules', async () => {
+      const context = passedStoryContext()
+      await reporter.onStoryResult(context)
+      await reporter.onComplete()
+
+      const saved = await storage.getTest()
+      const parsed = JSON.parse(saved!)
+      expect(parsed.testModules).toHaveLength(1)
+    })
+
+    it('includes test cases', async () => {
+      const context1 = passedStoryContext()
+      const context2 = passedStoryContext({
+        storyExport: { name: 'Secondary' },
+      })
+      await reporter.onStoryResult(context1)
+      await reporter.onStoryResult(context2)
+      await reporter.onComplete()
+
+      const saved = await storage.getTest()
+      const parsed = JSON.parse(saved!)
+      expect(parsed.testModules[0].tests).toHaveLength(2)
+    })
+
+    it('captures test states (passed/failed)', async () => {
+      const passedContext = passedStoryContext()
+      const failedContext = failedStoryContext()
+      await reporter.onStoryResult(passedContext, 'passed')
+      await reporter.onStoryResult(failedContext, 'failed', [
+        {
+          message: 'expected button to have aria-label',
+          stack:
+            'Error: expected button to have aria-label\n    at test.ts:7:19',
+        },
+      ])
+      await reporter.onComplete()
+
+      const saved = await storage.getTest()
+      const parsed = JSON.parse(saved!)
+      const tests = parsed.testModules[0].tests as StoryTest[]
+      expect(tests.find((t) => t.state === 'passed')).toBeDefined()
+      expect(tests.find((t) => t.state === 'failed')).toBeDefined()
+    })
+
+    it('includes error information for failed tests', async () => {
+      const context = failedStoryContext()
+      await reporter.onStoryResult(context, 'failed', [
+        {
+          message: 'expected button to have aria-label',
+          stack:
+            'Error: expected button to have aria-label\n    at test.ts:7:19',
+        },
+      ])
+      await reporter.onComplete()
+
+      const saved = await storage.getTest()
+      const parsed = JSON.parse(saved!)
+      const failedTest = parsed.testModules[0].tests[0]
+      expect(failedTest.state).toBe('failed')
+      expect(failedTest.errors).toBeDefined()
+      expect(failedTest.errors.length).toBeGreaterThan(0)
+    })
+  })
+
+  describe('test state mapping', () => {
+    let storage: MemoryStorage
+    let reporter: StorybookReporter
+
+    beforeEach(() => {
+      storage = new MemoryStorage()
+      reporter = new StorybookReporter(storage)
+    })
+
+    it.each([
+      ['passed', 'passed'],
+      ['failed', 'failed'],
+      ['skipped', 'skipped'],
+    ] as const)('maps %s to %s', async (status, expected) => {
+      const context = createStoryContext()
+      await reporter.onStoryResult(context, status)
+      await reporter.onComplete()
+
+      const saved = await storage.getTest()
+      const parsed = JSON.parse(saved!)
+      expect(parsed.testModules[0].tests[0].state).toBe(expected)
+    })
+  })
+
+  it('handles empty test runs', async () => {
+    const storage = new MemoryStorage()
+    const reporter = new StorybookReporter(storage)
+
+    await reporter.onComplete()
+
+    const saved = await storage.getTest()
+    const parsed = JSON.parse(saved!)
+    expect(parsed).toEqual({ testModules: [], unhandledErrors: [] })
+  })
+
+  describe('overall test run status', () => {
+    let storage: MemoryStorage
+    let reporter: StorybookReporter
+
+    beforeEach(() => {
+      storage = new MemoryStorage()
+      reporter = new StorybookReporter(storage)
+    })
+
+    it('reports "passed" when all tests pass', async () => {
+      const context = passedStoryContext()
+      await reporter.onStoryResult(context)
+      await reporter.onComplete()
+
+      const saved = await storage.getTest()
+      const parsed = JSON.parse(saved!)
+      expect(parsed.reason).toBe('passed')
+    })
+
+    it('reports "failed" when any test fails', async () => {
+      const passedContext = passedStoryContext()
+      const failedContext = failedStoryContext()
+      await reporter.onStoryResult(passedContext, 'passed')
+      await reporter.onStoryResult(failedContext, 'failed', [
+        {
+          message: 'expected button to have aria-label',
+          stack:
+            'Error: expected button to have aria-label\n    at test.ts:7:19',
+        },
+      ])
+      await reporter.onComplete()
+
+      const saved = await storage.getTest()
+      const parsed = JSON.parse(saved!)
+      expect(parsed.reason).toBe('failed')
+    })
+  })
+})

package/project-skills/tdd-guard/reporters/storybook/src/StorybookReporter.ts

@@ -0,0 +1,88 @@
+import { Storage, FileStorage, Config } from 'tdd-guard'
+import type {
+  TestContext,
+  TestRunOutput,
+  StoryTest,
+  StoryModule,
+  StoryError,
+} from './types'
+
+export class StorybookReporter {
+  private readonly storage: Storage
+  private readonly collectedTests: Map<string, StoryTest[]> = new Map()
+
+  constructor(storageOrRoot?: Storage | string) {
+    this.storage = this.initializeStorage(storageOrRoot)
+  }
+
+  private initializeStorage(storageOrRoot?: Storage | string): Storage {
+    if (!storageOrRoot) {
+      return new FileStorage()
+    }
+
+    if (typeof storageOrRoot === 'string') {
+      const config = new Config({ projectRoot: storageOrRoot })
+      return new FileStorage(config)
+    }
+
+    return storageOrRoot
+  }
+
+  async onStoryResult(
+    context: TestContext,
+    status: 'passed' | 'failed' | 'skipped' = 'passed',
+    errors?: unknown[]
+  ): Promise<void> {
+    const moduleId = context.id
+    const test: StoryTest = {
+      name: context.name,
+      fullName: `${context.title} > ${context.name}`,
+      state: status,
+    }
+
+    // Add errors if present
+    if (errors && errors.length > 0) {
+      test.errors = errors.map((err: unknown): StoryError => {
+        const errorObj = err as Record<string, unknown>
+        const message = errorObj.message
+        return {
+          message: typeof message === 'string' ? message : String(err),
+          stack: errorObj.stack as string | undefined,
+        }
+      })
+    }
+
+    if (!this.collectedTests.has(moduleId)) {
+      this.collectedTests.set(moduleId, [])
+    }
+    this.collectedTests.get(moduleId)!.push(test)
+  }
+
+  async onComplete(): Promise<void> {
+    const testModules: StoryModule[] = Array.from(
+      this.collectedTests.entries()
+    ).map(([moduleId, tests]) => ({
+      moduleId,
+      tests,
+    }))
+
+    const output: TestRunOutput = {
+      testModules,
+      unhandledErrors: [],
+      reason: this.determineReason(testModules),
+    }
+
+    await this.storage.saveTest(JSON.stringify(output, null, 2))
+  }
+
+  private determineReason(
+    testModules: StoryModule[]
+  ): 'passed' | 'failed' | undefined {
+    const allTests = testModules.flatMap((m) => m.tests)
+    if (allTests.length === 0) {
+      return undefined
+    }
+    const hasFailures = allTests.some((t) => t.state === 'failed')
+    return hasFailures ? 'failed' : 'passed'
+  }
+}

package/project-skills/tdd-guard/reporters/storybook/src/index.ts

@@ -0,0 +1,12 @@
+import { StorybookReporter } from './StorybookReporter'
+
+export { StorybookReporter }
+export default StorybookReporter
+export type {
+  StorybookReporterOptions,
+  StoryError,
+  StoryTest,
+  StoryModule,
+  TestRunOutput,
+  TestContext,
+} from './types'

package/project-skills/tdd-guard/reporters/storybook/src/types.ts

@@ -0,0 +1,37 @@
+import type { Storage } from 'tdd-guard'
+
+export interface StorybookReporterOptions {
+  storage?: Storage
+  projectRoot?: string
+}
+
+export interface StoryError {
+  message: string
+  stack?: string
+  expected?: unknown
+  actual?: unknown
+}
+
+export interface StoryTest {
+  name: string
+  fullName: string
+  state: 'passed' | 'failed' | 'skipped'
+  errors?: StoryError[]
+}
+
+export interface StoryModule {
+  moduleId: string
+  tests: StoryTest[]
+}
+
+export interface TestRunOutput {
+  testModules: StoryModule[]
+  unhandledErrors: unknown[]
+  reason?: 'passed' | 'failed' | 'interrupted'
+}
+
+export interface TestContext {
+  id: string
+  title: string
+  name: string // Story name comes directly from context, not nested in storyExport
+}

package/project-skills/tdd-guard/reporters/storybook/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "composite": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "tsBuildInfoFile": "./dist/tsconfig.tsbuildinfo"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["**/*.test.ts", "**/*.spec.ts"]
+}

package/project-skills/tdd-guard/reporters/test/artifacts/go/failing/go.mod

@@ -0,0 +1,3 @@
+module singleFailingTestModule
+
+go 1.24

package/project-skills/tdd-guard/reporters/test/artifacts/go/failing/single_failing_test.go

@@ -0,0 +1,13 @@
+package singleFailingTestModule
+
+import "testing"
+
+func TestCalculator(t *testing.T) {
+	t.Run("TestShouldAddNumbersCorrectly", func(t *testing.T) {
+		result := 2 + 3
+		expected := 6
+		if result != expected {
+			t.Errorf("Expected %d but got %d", expected, result)
+		}
+	})
+}

package/project-skills/tdd-guard/reporters/test/artifacts/go/import/go.mod

@@ -0,0 +1,3 @@
+module missingImportModule
+
+go 1.24

package/project-skills/tdd-guard/reporters/test/artifacts/go/import/single_import_error_test.go

@@ -0,0 +1,17 @@
+package missingImportModule
+
+import (
+	"github.com/non-existent/module"
+	"testing"
+)
+
+func TestCalculator(t *testing.T) {
+	t.Run("TestShouldAddNumbersCorrectly", func(t *testing.T) {
+		module.NonExistentFunction()
+		result := 2 + 3
+		expected := 5
+		if result != expected {
+			t.Errorf("Expected %d but got %d", expected, result)
+		}
+	})
+}

package/project-skills/tdd-guard/reporters/test/artifacts/go/passing/go.mod

@@ -0,0 +1,3 @@
+module singlePassingTestModule
+
+go 1.24

package/project-skills/tdd-guard/reporters/test/artifacts/go/passing/single_passing_test.go

@@ -0,0 +1,13 @@
+package singlePassingTestModule
+
+import "testing"
+
+func TestCalculator(t *testing.T) {
+	t.Run("TestShouldAddNumbersCorrectly", func(t *testing.T) {
+		result := 2 + 3
+		expected := 5
+		if result != expected {
+			t.Errorf("Expected %d but got %d", expected, result)
+		}
+	})
+}

package/project-skills/tdd-guard/reporters/test/artifacts/jest/single-failing.test.js

@@ -0,0 +1,5 @@
+describe('Calculator', () => {
+  test('should add numbers correctly', () => {
+    expect(2 + 3).toBe(6)
+  })
+})

package/project-skills/tdd-guard/reporters/test/artifacts/jest/single-import-error.test.js

@@ -0,0 +1,8 @@
+const { nonExistentFunction } = require('./non-existent-module')
+
+describe('Calculator', () => {
+  test('should add numbers correctly', () => {
+    nonExistentFunction()
+    expect(2 + 3).toBe(5)
+  })
+})

package/project-skills/tdd-guard/reporters/test/artifacts/jest/single-passing.test.js

@@ -0,0 +1,5 @@
+describe('Calculator', () => {
+  test('should add numbers correctly', () => {
+    expect(2 + 3).toBe(5)
+  })
+})

package/project-skills/tdd-guard/reporters/test/artifacts/phpunit/SingleFailingTest.php

@@ -0,0 +1,11 @@
+<?php
+
+use PHPUnit\Framework\TestCase;
+
+class SingleFailingTest extends TestCase
+{
+    public function testShouldAddNumbersCorrectly(): void
+    {
+        $this->assertEquals(6, 2 + 3);
+    }
+}

package/project-skills/tdd-guard/reporters/test/artifacts/phpunit/SingleImportErrorTest.php

@@ -0,0 +1,14 @@
+<?php
+
+use PHPUnit\Framework\TestCase;
+use NonExistent\Module\SomeClass;
+
+class SingleImportErrorTest extends TestCase
+{
+    public function testShouldAddNumbersCorrectly(): void
+    {
+        // This should cause a fatal error due to the non-existent class
+        $instance = new SomeClass();
+        $this->assertEquals(5, 2 + 3);
+    }
+}

package/project-skills/tdd-guard/reporters/test/artifacts/phpunit/SinglePassingTest.php

@@ -0,0 +1,11 @@
+<?php
+
+use PHPUnit\Framework\TestCase;
+
+class SinglePassingTest extends TestCase
+{
+    public function testShouldAddNumbersCorrectly(): void
+    {
+        $this->assertEquals(5, 2 + 3);
+    }
+}

package/project-skills/tdd-guard/reporters/test/artifacts/pytest/test_single_failing.py

@@ -0,0 +1,3 @@
+class TestCalculator:
+    def test_should_add_numbers_correctly(self):
+        assert 2 + 3 == 6

package/project-skills/tdd-guard/reporters/test/artifacts/pytest/test_single_import_error.py

@@ -0,0 +1,6 @@
+from non_existent_module import non_existent_function
+
+class TestCalculator:
+    def test_should_add_numbers_correctly(self):
+        non_existent_module()
+        assert 2 + 3 == 5

package/project-skills/tdd-guard/reporters/test/artifacts/pytest/test_single_passing.py

@@ -0,0 +1,3 @@
+class TestCalculator:
+    def test_should_add_numbers_correctly(self):
+        assert 2 + 3 == 5

package/project-skills/tdd-guard/reporters/test/artifacts/rust/failing/Cargo.lock

@@ -0,0 +1,7 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "single_failing"
+version = "0.1.0"

package/project-skills/tdd-guard/reporters/test/artifacts/rust/failing/Cargo.toml

@@ -0,0 +1,4 @@
+[package]
+name = "single_failing"
+version = "0.1.0"
+edition = "2021"

package/project-skills/tdd-guard/reporters/test/artifacts/rust/failing/src/lib.rs

@@ -0,0 +1,14 @@
+pub fn add(left: u64, right: u64) -> u64 {
+    left + right
+}
+
+#[cfg(test)]
+mod calculator_tests {
+    use super::*;
+
+    #[test]
+    fn should_add_numbers_correctly() {
+        let result = add(2, 3);
+        assert_eq!(result, 6); // This will fail: 2 + 3 != 6
+    }
+}

package/project-skills/tdd-guard/reporters/test/artifacts/rust/import/Cargo.lock

@@ -0,0 +1,7 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "single_import_error"
+version = "0.1.0"

package/project-skills/tdd-guard/reporters/test/artifacts/rust/import/Cargo.toml

@@ -0,0 +1,4 @@
+[package]
+name = "single_import_error"
+version = "0.1.0"
+edition = "2021"

package/project-skills/tdd-guard/reporters/test/artifacts/rust/import/src/lib.rs

@@ -0,0 +1,13 @@
+use non_existent_module::Calculator; // This will fail to compile
+
+#[cfg(test)]
+mod calculator_tests {
+    use super::*;
+
+    #[test]
+    fn should_add_numbers_correctly() {
+        let calc = Calculator::new();
+        let result = calc.add(2, 3);
+        assert_eq!(result, 5);
+    }
+}

package/project-skills/tdd-guard/reporters/test/artifacts/rust/passing/Cargo.lock

@@ -0,0 +1,7 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "single_passing"
+version = "0.1.0"

package/project-skills/tdd-guard/reporters/test/artifacts/rust/passing/Cargo.toml

@@ -0,0 +1,4 @@
+[package]
+name = "single_passing"
+version = "0.1.0"
+edition = "2021"

package/project-skills/tdd-guard/reporters/test/artifacts/rust/passing/src/lib.rs

@@ -0,0 +1,14 @@
+pub fn add(left: u64, right: u64) -> u64 {
+    left + right
+}
+
+#[cfg(test)]
+mod calculator_tests {
+    use super::*;
+
+    #[test]
+    fn should_add_numbers_correctly() {
+        let result = add(2, 3);
+        assert_eq!(result, 5);
+    }
+}

package/project-skills/tdd-guard/reporters/test/artifacts/storybook/Calculator.js

@@ -0,0 +1,4 @@
+// Simple calculator module for testing
+export const Calculator = {
+  add: (a, b) => a + b,
+}

package/project-skills/tdd-guard/reporters/test/artifacts/storybook/single-failing.stories.js

@@ -0,0 +1,15 @@
+import { expect } from '@storybook/test'
+import { Calculator } from './Calculator'
+
+export default {
+  title: 'Calculator',
+  render: () => null, // No UI component, just testing logic
+}
+
+export const Primary = {
+  name: 'should add numbers correctly',
+  play: async () => {
+    const result = Calculator.add(2, 3)
+    await expect(result).toBe(6) // Intentionally wrong - 2 + 3 = 5, not 6
+  },
+}