Skip to main content

​
useReview Hook

Runs the same execution pipeline as <Review>, but returns state for custom rendering. 
import { useReview } from "smithers-orchestrator";

function ReviewPanel() {
  const { status, result, error } = useReview({
    target: { type: "diff", ref: "main" },
    criteria: ["No regressions", "Tests updated"],
  });

  return (
    <panel>
      <text>Status: {status}</text>
      {error && <text>Error: {error.message}</text>}
      {result && <text>Summary: {result.summary}</text>}
    </panel>
  );
}

​
API

function useReview(props: ReviewProps): UseReviewResult

interface UseReviewResult {
  status: "pending" | "running" | "complete" | "error"
  result: ReviewResult | null
  error: Error | null
}

​
Props

PropTypeDefaultDescription
targetReviewTarget—What to review (required). Has type ('commit' | 'diff' | 'pr' | 'files'), ref, and optional files
agent'claude''claude'Agent to use for review
modelstring—Model to use
criteriastring[]—Review criteria/checklist
blockingboolean—Stop orchestration if issues are found
postToGitHubboolean—Post review as GitHub PR comment
postToGitNotesboolean—Store review in git notes
onFinished(result: ReviewResult) => void—Callback when review is complete
onError(error: Error) => void—Callback on error

​
Notes

  • Requires SmithersProvider context.
  • Honors blocking, postToGitHub, postToGitNotes.

Review Component

JSX wrapper around the same execution

VCS API

Review logging + metadata