faf-taf-git 2.4.0 → 2.4.2

package/src/cli.ts

@@ -1,297 +0,0 @@
-#!/usr/bin/env node
-/**
- * faf-taf-git - The Git-Native Receipt Printer
- *
- * v2.x CLI: reads test output from file (pre-capture pattern)
- * Platform-agnostic - works in ANY CI/CD environment or locally
- */
-
-import { execSync } from 'child_process';
-import * as fs from 'fs';
-import * as path from 'path';
-import { parseTestOutput, UNPARSEABLE_OUTPUT } from './parsers';
-import { updateTafFile } from './taf-core';
-import { generateBadge } from './badge';
-
-export interface CLIOptions {
-  file?: string;
-  autoCommit?: boolean;
-  commitMessage?: string;
-  cwd?: string;
-  verbose?: boolean;
-  logger?: (message: string) => void;
-}
-
-export interface CLIResult {
-  success: boolean;
-  testResults?: {
-    total: number;
-    passed: number;
-    failed: number;
-    result: string;
-  };
-  tafUpdated: boolean;
-  error?: string;
-}
-
-/**
- * Main CLI function - reads test output from file
- */
-export async function runTafGit(options: CLIOptions = {}): Promise<CLIResult> {
-  const {
-    file,
-    autoCommit = false,
-    commitMessage = 'chore: update .taf with test results',
-    cwd = process.cwd(),
-    verbose = false,
-    logger = console.log,
-  } = options;
-
-  try {
-    if (!file) {
-      return {
-        success: false,
-        tafUpdated: false,
-        error: 'No test output file specified. Use --file <path>.\nExample: npm test 2>&1 | tee test-output.txt && npx faf-taf-git --file test-output.txt',
-      };
-    }
-
-    // Resolve file path
-    const filePath = path.isAbsolute(file) ? file : path.join(cwd, file);
-
-    if (!fs.existsSync(filePath)) {
-      return {
-        success: false,
-        tafUpdated: false,
-        error: `Test output file not found: ${filePath}`,
-      };
-    }
-
-    const output = fs.readFileSync(filePath, 'utf-8');
-    if (verbose) logger(`Read ${output.length} bytes from ${filePath}`);
-
-    // Parse test output
-    const testResults = parseTestOutput(output);
-
-    if (!testResults) {
-      if (verbose) {
-        logger(`Parser returned null`);
-        logger(`Output sample (first 500 chars): ${output.slice(0, 500)}`);
-      }
-      return {
-        success: false,
-        tafUpdated: false,
-        error: UNPARSEABLE_OUTPUT,
-      };
-    }
-
-    if (verbose) {
-      logger(`Parsed results: ${testResults.passed}/${testResults.total} tests passing`);
-    }
-
-    // Check if .taf file exists
-    const tafPath = path.join(cwd, '.taf');
-    if (!fs.existsSync(tafPath)) {
-      return {
-        success: false,
-        testResults: {
-          total: testResults.total,
-          passed: testResults.passed,
-          failed: testResults.failed,
-          result: testResults.result,
-        },
-        tafUpdated: false,
-        error: 'No .taf file found. Run `faf taf init` to create one.',
-      };
-    }
-
-    // Update .taf file
-    const updated = await updateTafFile(tafPath, testResults);
-
-    if (updated) {
-      if (verbose) logger('.taf file updated successfully');
-
-      // Commit changes if enabled
-      if (autoCommit) {
-        commitTafUpdate(cwd, commitMessage, verbose, logger);
-        if (verbose) logger('Changes committed to git');
-      }
-
-      return {
-        success: true,
-        testResults: {
-          total: testResults.total,
-          passed: testResults.passed,
-          failed: testResults.failed,
-          result: testResults.result,
-        },
-        tafUpdated: true,
-      };
-    } else {
-      return {
-        success: false,
-        testResults: {
-          total: testResults.total,
-          passed: testResults.passed,
-          failed: testResults.failed,
-          result: testResults.result,
-        },
-        tafUpdated: false,
-        error: '.taf file was not updated',
-      };
-    }
-  } catch (error) {
-    return {
-      success: false,
-      tafUpdated: false,
-      error: error instanceof Error ? error.message : 'Unknown error occurred',
-    };
-  }
-}
-
-/**
- * Commit .taf file changes to git
- */
-function commitTafUpdate(cwd: string, message: string, verbose: boolean, logger: (msg: string) => void = console.log): void {
-  try {
-    const opts = { cwd, stdio: 'pipe' as const };
-
-    execSync('git add .taf', opts);
-
-    const diff = execSync('git diff --cached --name-only', opts).toString().trim();
-    if (diff.length === 0) {
-      if (verbose) logger('No changes to commit');
-      return;
-    }
-
-    execSync(`git commit -m "${message}"`, opts);
-
-    try {
-      execSync('git push', opts);
-    } catch {
-      if (verbose) logger('Could not push changes (this is ok in some CI environments)');
-    }
-  } catch (error) {
-    if (verbose) logger(`Error committing changes: ${error}`);
-    throw error;
-  }
-}
-
-/**
- * Handle the 'badge' subcommand
- */
-function handleBadgeCommand(args: string[]): void {
-  if (args.includes('--help') || args.includes('-h')) {
-    console.log(`\nfaf-taf-git badge - Generate SVG badge from .taf history\n\nUSAGE:\n  npx faf-taf-git badge [OPTIONS]\n\nOPTIONS:\n  --output <path>     Write SVG to file (default: stdout)\n  --label <text>      Badge label (default: TAF)\n  --taf <path>        Path to .taf file (default: .taf)\n  --help, -h          Show this help\n`);
-    process.exit(0);
-  }
-
-  // Parse --output
-  let outputPath: string | undefined;
-  const outputIndex = args.indexOf('--output');
-  if (outputIndex !== -1 && args[outputIndex + 1]) {
-    outputPath = args[outputIndex + 1];
-  }
-
-  // Parse --label
-  let label: string | undefined;
-  const labelIndex = args.indexOf('--label');
-  if (labelIndex !== -1 && args[labelIndex + 1]) {
-    label = args[labelIndex + 1];
-  }
-
-  // Parse --taf
-  let tafPath: string | undefined;
-  const tafIndex = args.indexOf('--taf');
-  if (tafIndex !== -1 && args[tafIndex + 1]) {
-    tafPath = args[tafIndex + 1];
-  }
-
-  const result = generateBadge({ tafPath, label });
-
-  if (!result.success || !result.svg) {
-    console.error(`Error: ${result.error || 'Failed to generate badge'}`);
-    process.exit(1);
-  }
-
-  if (outputPath) {
-    fs.writeFileSync(outputPath, result.svg, 'utf-8');
-    console.log(`Badge written to ${outputPath}`);
-  } else {
-    process.stdout.write(result.svg);
-  }
-}
-
-/**
- * CLI entry point
- */
-async function main() {
-  const args = process.argv.slice(2);
-
-  // Subcommand: badge
-  if (args[0] === 'badge') {
-    handleBadgeCommand(args.slice(1));
-    return;
-  }
-
-  // Show help
-  if (args.includes('--help') || args.includes('-h')) {
-    console.log(`\nfaf-taf-git - The Git-Native Receipt Printer\n\nUSAGE:\n  npm test 2>&1 | tee test-output.txt\n  npx faf-taf-git --file test-output.txt [OPTIONS]\n\n  # WJTTC / pc-ai bar\n  node tests/wjttc/run-wjttc.mjs 2>&1 | tee wjttc-out.txt\n  npx faf-taf-git --file wjttc-out.txt\n\nCOMMANDS:\n  badge               Generate a shields.io-style SVG badge from .taf\n\nOPTIONS:\n  --file <path>       Path to test output file (required)\n  --commit            Auto-commit .taf changes to git\n  --message <msg>     Custom commit message\n  --cwd <dir>         Working directory (default: current)\n  --verbose, -v       Verbose output\n  --help, -h          Show this help\n\nPARSERS:\n  JUnit XML (pytest, cargo, Go, Java, .NET ...), Bun, WJTTC (pc-ai bar), Jest, Vitest\n\nEXAMPLES:\n  npm test 2>&1 | tee test-output.txt\n  npx faf-taf-git --file test-output.txt\n\n  npx faf-taf-git --file test-output.txt --commit\n\n  npx faf-taf-git badge --output badge.svg\n\nPLATFORM SUPPORT:\n  Works in ANY CI/CD that runs Node.js:\n  GitHub Actions, GitLab CI, Jenkins, CircleCI,\n  Bitbucket Pipelines, Azure Pipelines, local dev\n\nLEARN MORE:\n  https://github.com/Wolfe-Jam/faf-taf-git\n`);
-    process.exit(0);
-  }
-
-  const options: CLIOptions = {
-    verbose: args.includes('--verbose') || args.includes('-v'),
-  };
-
-  // Parse --file
-  const fileIndex = args.indexOf('--file');
-  if (fileIndex !== -1 && args[fileIndex + 1]) {
-    options.file = args[fileIndex + 1];
-  }
-
-  // Parse auto-commit flag
-  if (args.includes('--commit')) {
-    options.autoCommit = true;
-  }
-
-  // Parse commit message
-  const messageIndex = args.indexOf('--message');
-  if (messageIndex !== -1 && args[messageIndex + 1]) {
-    options.commitMessage = args[messageIndex + 1];
-  }
-
-  // Parse working directory
-  const cwdIndex = args.indexOf('--cwd');
-  if (cwdIndex !== -1 && args[cwdIndex + 1]) {
-    options.cwd = args[cwdIndex + 1];
-  }
-
-  // Run the tool
-  const result = await runTafGit(options);
-
-  if (result.success) {
-    if (result.testResults) {
-      console.log(`Tests: ${result.testResults.passed}/${result.testResults.total} passing`);
-      console.log(`Result: ${result.testResults.result}`);
-    }
-    if (result.tafUpdated) {
-      console.log('.taf file updated');
-    }
-    process.exit(0);
-  } else {
-    console.error(`Error: ${result.error}`);
-    if (result.testResults) {
-      console.log(`Tests: ${result.testResults.passed}/${result.testResults.total} passing`);
-    }
-    process.exit(1);
-  }
-}
-
-// Run CLI if called directly
-if (require.main === module) {
-  main().catch((error) => {
-    console.error('Fatal error:', error);
-    process.exit(1);
-  });
-}

package/src/index.ts

@@ -1,201 +0,0 @@
-/**
- * faf-taf-git v2.0.0 - GitHub Actions wrapper
- *
- * Pre-Capture Pattern: Reads test output from file (written by previous step)
- * Handles GitHub Actions-specific inputs/outputs
- */
-
-import * as core from '@actions/core';
-import * as exec from '@actions/exec';
-import * as fs from 'fs';
-import * as path from 'path';
-import { parseTestOutput, UNPARSEABLE_OUTPUT } from './parsers';
-import { updateTafFile } from './taf-core';
-
-/**
- * Switch to a dedicated target branch for TAF receipts.
- * Creates the branch as an orphan on first run, seeded with existing .taf.
- */
-async function switchToTargetBranch(cwd: string, targetBranch: string, tafSeed: string | null): Promise<void> {
-  const execOptions = { cwd };
-
-  // Configure git (needed before any git operations)
-  await exec.exec('git', ['config', '--global', 'user.name', 'faf-taf-git[bot]'], execOptions);
-  await exec.exec('git', ['config', '--global', 'user.email', 'faf-taf-git[bot]@users.noreply.github.com'], execOptions);
-
-  // Check if target branch exists on remote
-  const { exitCode } = await exec.getExecOutput(
-    'git', ['ls-remote', '--exit-code', 'origin', targetBranch],
-    { ...execOptions, ignoreReturnCode: true }
-  );
-
-  if (exitCode === 0) {
-    // Branch exists — fetch and checkout
-    // Stash any working tree changes (e.g. dist/ from build step) to allow clean checkout
-    await exec.exec('git', ['stash', '--include-untracked'], execOptions);
-    await exec.exec('git', ['fetch', 'origin', targetBranch], execOptions);
-    await exec.exec('git', ['checkout', targetBranch], execOptions);
-    core.info(`Switched to existing branch: ${targetBranch}`);
-  } else {
-    // Branch doesn't exist — create orphan
-    await exec.exec('git', ['checkout', '--orphan', targetBranch], execOptions);
-    await exec.getExecOutput('git', ['rm', '-rf', '.'], { ...execOptions, ignoreReturnCode: true });
-
-    const tafPath = path.join(cwd, '.taf');
-
-    if (tafSeed) {
-      // Seed with existing .taf from source branch
-      fs.writeFileSync(tafPath, tafSeed, 'utf-8');
-      core.info(`Seeded ${targetBranch} with existing .taf data`);
-    } else {
-      // No seed — create minimal valid YAML so updateTafFile can populate test_history.
-      // Without this, `git add .taf` fails with exit 128 (pathspec did not match)
-      // when consumer repo has no .taf on source branch.
-      const projectName = path.basename(cwd);
-      const minimal =
-        `format_version: 1.0.0\n` +
-        `project: ${projectName}\n` +
-        `created: ${new Date().toISOString()}\n` +
-        `test_history: []\n`;
-      fs.writeFileSync(tafPath, minimal, 'utf-8');
-      core.info(`Created empty .taf for new ${targetBranch} branch (no seed)`);
-    }
-
-    await exec.exec('git', ['add', '.taf'], execOptions);
-    await exec.exec('git', ['commit', '-m', `chore(taf): initialize ${targetBranch} branch [skip ci]`], execOptions);
-    core.info(`Created new branch: ${targetBranch}`);
-  }
-}
-
-/**
- * Commit .taf file changes to git and push
- */
-async function commitTafUpdate(cwd: string, message: string, targetBranch?: string): Promise<void> {
-  const execOptions = { cwd };
-
-  // Configure git
-  await exec.exec('git', ['config', '--global', 'user.name', 'faf-taf-git[bot]'], execOptions);
-  await exec.exec('git', ['config', '--global', 'user.email', 'faf-taf-git[bot]@users.noreply.github.com'], execOptions);
-
-  // Stage .taf file
-  await exec.exec('git', ['add', '.taf'], execOptions);
-
-  // Check if there are changes to commit
-  const { exitCode } = await exec.getExecOutput('git', ['diff', '--cached', '--name-only'], execOptions);
-
-  if (exitCode === 0) {
-    await exec.exec('git', ['commit', '-m', message], execOptions);
-
-    // Push to target branch or current branch
-    const pushArgs = targetBranch ? ['push', 'origin', targetBranch] : ['push'];
-    try {
-      await exec.exec('git', pushArgs, execOptions);
-    } catch (error) {
-      core.warning('Could not push changes (this is ok in some CI environments)');
-    }
-  }
-}
-
-async function run(): Promise<void> {
-  try {
-    // Get GitHub Action inputs
-    const testOutputFile = core.getInput('test-output-file', { required: true });
-    const autoCommit = core.getInput('auto-commit') !== 'false';
-    const commitMessage = core.getInput('commit-message') || 'chore(taf): update .taf receipt [skip ci]';
-    const targetBranch = core.getInput('target-branch') || '';
-    const cwd = process.cwd();
-
-    core.info(`Reading test output from: ${testOutputFile}`);
-
-    // Read test output file (written by previous CI step)
-    const testOutputPath = path.isAbsolute(testOutputFile)
-      ? testOutputFile
-      : path.join(cwd, testOutputFile);
-
-    if (!fs.existsSync(testOutputPath)) {
-      core.setFailed(`Test output file not found: ${testOutputPath}`);
-      return;
-    }
-
-    const testOutput = fs.readFileSync(testOutputPath, 'utf-8');
-    core.info(`Read ${testOutput.length} bytes from test output file`);
-
-    // Debug: Show sample of what we're parsing
-    const lines = testOutput.split('\n');
-    const testSummaryLine = lines.find(line => line.includes('Tests:'));
-    if (testSummaryLine) {
-      core.info(`Found summary line: ${testSummaryLine.substring(0, 200)}`);
-    } else {
-      core.warning('No "Tests:" summary line found in output');
-      // Show last 20 lines to help debug
-      core.info('Last 20 lines of output:');
-      lines.slice(-20).forEach((line, i) => {
-        core.info(`  ${i}: ${line.substring(0, 150)}`);
-      });
-    }
-
-    // Parse test results
-    const testResults = parseTestOutput(testOutput);
-
-    if (!testResults) {
-      core.setFailed(UNPARSEABLE_OUTPUT);
-      return;
-    }
-
-    core.info(`Parsed results: ${testResults.passed}/${testResults.total} tests passing`);
-
-    // Set GitHub Action outputs
-    core.setOutput('result', testResults.result);
-    core.setOutput('passed', testResults.passed.toString());
-    core.setOutput('failed', testResults.failed.toString());
-    core.setOutput('total', testResults.total.toString());
-    core.setOutput('skipped', (testResults.skipped ?? 0).toString());
-
-    // If target-branch is set, save .taf seed and switch branches
-    let tafSeed: string | null = null;
-    const tafPath = path.join(cwd, '.taf');
-
-    if (targetBranch) {
-      // Save existing .taf from source branch as seed for first-run
-      if (fs.existsSync(tafPath)) {
-        tafSeed = fs.readFileSync(tafPath, 'utf-8');
-      }
-      core.info(`Switching to target branch: ${targetBranch}`);
-      await switchToTargetBranch(cwd, targetBranch, tafSeed);
-    }
-
-    // Check if .taf file exists (on current or target branch)
-    if (!fs.existsSync(tafPath)) {
-      core.setFailed('No .taf file found. Run `faf taf init` to create one.');
-      return;
-    }
-
-    // Update .taf file
-    const updated = await updateTafFile(tafPath, testResults);
-
-    if (!updated) {
-      core.setOutput('taf-updated', 'false');
-      core.setFailed('.taf file was not updated');
-      return;
-    }
-
-    core.setOutput('taf-updated', 'true');
-    core.info('✅ .taf file updated successfully');
-
-    // Commit changes if enabled
-    if (autoCommit) {
-      await commitTafUpdate(cwd, commitMessage, targetBranch || undefined);
-      core.info(`✅ Changes committed${targetBranch ? ` to ${targetBranch}` : ''}`);
-    }
-
-  } catch (error) {
-    if (error instanceof Error) {
-      core.setFailed(error.message);
-    } else {
-      core.setFailed('Unknown error occurred');
-    }
-  }
-}
-
-// Run the GitHub Action
-run();

package/src/parsers/bun.ts

@@ -1,103 +0,0 @@
-/**
- * Bun test output parser
- *
- * Extracts test counts from `bun test` CLI output.
- */
-
-import { TestResults } from './jest';
-
-/**
- * Parse Bun test output to extract test results.
- *
- * Bun output format (summary block at the end of a run):
- *
- * ```
- *    232 pass
- *    1 skip
- *    1 todo
- *    0 fail
- *    848 expect() calls
- *   Ran 234 tests across 9 files. [21.53s]
- * ```
- *
- * Notes:
- * - Anchored on `Ran <N> tests across <M> files.` — the canonical truthful
- *   total (includes skip + todo + pass + fail). Without this line, the parser
- *   returns null and the dispatcher falls through to jest/vitest.
- * - Per-category counts (`pass`, `fail`, `skip`, `todo`) come from their own
- *   lines elsewhere in the same output. Singular forms — bun does not use
- *   `passed`/`failed`/`skipped` (intentional differentiator from jest/vitest).
- * - `skipped` aggregates `skip` + `todo` (matches the convention vitest.ts
- *   already uses for parity in the shared TestResults shape).
- */
-export function parseBunOutput(output: string): TestResults | null {
-  // Strip ANSI color codes + normalize line endings (parity with siblings).
-  // eslint-disable-next-line no-control-regex
-  let cleanOutput = output.replace(/\x1b\[[0-9;]*m/g, '');
-  cleanOutput = cleanOutput.replace(/\r\n/g, '\n').replace(/\r/g, '\n');
-
-  // Canonical anchor: bun-unique "Ran N tests across M files." summary line.
-  // Without this, this isn't bun output — let the dispatcher try the others.
-  const ranMatch = cleanOutput.match(/^Ran\s+(\d+)\s+tests?\s+across\s+\d+\s+files?/m);
-  if (!ranMatch) return null;
-
-  const total = parseInt(ranMatch[1], 10);
-  if (total === 0) return null;
-
-  let passed = 0;
-  let failed = 0;
-  let skipped = 0;
-
-  // Per-line counts. Each line is `<leading-ws><N> <singular-word>` on its own.
-  // Anchored with ^...$ + multiline to avoid catching the "expect() calls" line
-  // or any noise inside test descriptions.
-  const passedMatch = cleanOutput.match(/^\s*(\d+)\s+pass\s*$/m);
-  if (passedMatch) passed = parseInt(passedMatch[1], 10);
-
-  const failedMatch = cleanOutput.match(/^\s*(\d+)\s+fail\s*$/m);
-  if (failedMatch) failed = parseInt(failedMatch[1], 10);
-
-  const skipMatch = cleanOutput.match(/^\s*(\d+)\s+skip\s*$/m);
-  if (skipMatch) skipped += parseInt(skipMatch[1], 10);
-
-  const todoMatch = cleanOutput.match(/^\s*(\d+)\s+todo\s*$/m);
-  if (todoMatch) skipped += parseInt(todoMatch[1], 10);
-
-  const result: 'PASSED' | 'FAILED' = failed > 0 ? 'FAILED' : 'PASSED';
-
-  return {
-    total,
-    passed,
-    failed,
-    skipped: skipped > 0 ? skipped : undefined,
-    result,
-  };
-}
-
-/**
- * Example Bun outputs for testing:
- *
- * All passing:
- * ```
- *  173 pass
- *  0 fail
- *  Ran 173 tests across 8 files. [4.2s]
- * ```
- *
- * Mixed (the grok-faf-mcp 1.4.9 shape):
- * ```
- *  232 pass
- *  1 skip
- *  1 todo
- *  0 fail
- *  848 expect() calls
- *  Ran 234 tests across 9 files. [21.53s]
- * ```
- *
- * Failing:
- * ```
- *  170 pass
- *  3 fail
- *  Ran 173 tests across 8 files. [5.1s]
- * ```
- */

package/src/parsers/index.ts

@@ -1,50 +0,0 @@
-/**
- * Unified test output parser
- *
- * Tries each framework parser in order until one succeeds.
- */
-
-import { TestResults } from './jest';
-import { parseBunOutput } from './bun';
-import { parseJestOutput } from './jest';
-import { parseJunitOutput } from './junit';
-import { parseVitestOutput } from './vitest';
-import { parseWjttcOutput } from './wjttc';
-
-export { TestResults } from './jest';
-export { parseJunitOutput } from './junit';
-export { parseWjttcOutput } from './wjttc';
-
-/**
- * Every parser, in the order parseTestOutput tries them. Order matters:
- * 1. JUnit XML — a `<testsuite>` element; first, because a report's captured
- *    stdout can hold another runner's summary line.
- * 2. Bun — `Ran N tests across M files` is bun-unique.
- * 3. WJTTC — `pc-ai WJTTC` / suite `pc-ai-wjttc` (FAF bar; not Jest-shaped).
- * 4. Jest — `Tests: … total`.
- * 5. Vitest — `Tests  … (N)`.
- */
-const PARSERS: ReadonlyArray<readonly [name: string, parse: (output: string) => TestResults | null]> = [
-  ['JUnit XML', parseJunitOutput],
-  ['Bun', parseBunOutput],
-  ['WJTTC', parseWjttcOutput],
-  ['Jest', parseJestOutput],
-  ['Vitest', parseVitestOutput],
-];
-
-export const SUPPORTED_PARSERS: readonly string[] = PARSERS.map(([name]) => name);
-
-/** What the CLI and the Action report when no parser matches. */
-export const UNPARSEABLE_OUTPUT = `Could not parse test output. Supported: ${SUPPORTED_PARSERS.join(', ')}.`;
-
-/**
- * Parse test output from any supported framework: the first parser in
- * PARSERS that recognises the output wins.
- */
-export function parseTestOutput(output: string): TestResults | null {
-  for (const [, parse] of PARSERS) {
-    const results = parse(output);
-    if (results) return results;
-  }
-  return null;
-}