@blundergoat/goat-flow
Version:
AI coding agent harness and local dashboard for Claude Code, OpenAI Codex, Google Antigravity, and GitHub Copilot - setup audits, guardrails, structured skills, deny hooks, and persistent learning loops.
45 lines • 2.29 kB
TypeScript
/**
* Shared helpers for harness completeness checks (deterministic pass/fail).
*/
import type { HarnessCheckDetails, HarnessCheckResult } from "../types.js";
import type { ReadonlyFS } from "../../types.js";
/**
* Build a passing harness-check result with the same report shape every check uses.
*
* @param findings - Evidence strings that explain what the check confirmed.
* @param details - Optional structured details rendered by callers that need more than prose.
* @returns Harness result with no recommendations because the check passed.
*/
export declare function pass(findings: string[], details?: HarnessCheckDetails): HarnessCheckResult;
/**
* Build a failing harness-check result with recommendations.
*
* @param findings - Evidence strings that explain what failed.
* @param recommendations - Human-facing next actions for repairing the harness.
* @param howToFix - Optional command-level repair steps when the fix is mechanical.
* @param details - Optional structured details rendered by callers that need more than prose.
* @returns Harness result that keeps evidence, recommendations, and repair steps separate.
*/
export declare function fail(findings: string[], recommendations: string[], howToFix?: string[], details?: HarnessCheckDetails): HarnessCheckResult;
/**
* Extract repo-looking file paths from markdown backticks.
*
* This is an existence-signal helper, not an ownership or agent-context check;
* callers that need stronger semantics must layer those checks on top.
*
* @param content - Markdown content to scan.
* @returns Backtick tokens that look like repo-relative paths.
*/
export declare function extractBacktickPaths(content: string): string[];
/**
* Collect markdown files from a shallow documentation tree.
*
* Missing directories and non-directory children are swallowed because harness
* checks treat absent optional buckets as empty sets, not audit crashes.
*
* @param fs - Read-only filesystem view rooted at the audited project.
* @param dir - Directory to scan for markdown files and one level of children.
* @returns Repo-relative markdown file paths in the scanned tree.
*/
export declare function collectMarkdownFiles(fs: Pick<ReadonlyFS, "listDir">, dir: string): string[];
//# sourceMappingURL=helpers.d.ts.map