GitCli.Worktree.Review behaviour (fnord v0.9.38)

View Source

Facade for the shared interactive flow for reviewing, merging, and cleaning up a fnord-managed worktree. Used by both Cmd.Ask (post-completion) and Cmd.Worktrees merge.

Includes pre-merge and post-merge validation gates that run the project's configured validation rules against the worktree (before merge) and the main checkout (after merge). Post-merge validation failure triggers an automatic revert, while merge command failures are returned to the caller.

Public functions dispatch through impl/0, resolved via the :git_review Globals key and defaulting to GitCli.Worktree.Review.Default. Tests do NOT point this key at a mock by default; tests that script the review/merge outcome opt in per test (see Fnord.TestCase.mock_git_review/0).

Summary

Types

merge_range()
review_result()
worktree_info()

Callbacks

auto_merge(t, worktree_info, keyword)
colorize_diff(t)
interactive_review(t, worktree_info, keyword)

Functions

auto_merge(root, meta, opts \\ [])

Merges worktree changes and cleans up without prompting. Runs validation before and after merge. Pre-merge validation failure blocks the merge.

colorize_diff(diff)

Colorizes a unified diff string for terminal display.

impl()
interactive_review(root, meta, opts \\ [])

Walks the user through inspecting the diff, merging, and optionally deleting the worktree and its local branch. Runs validation before and after merge.

Types

merge_range()

@type merge_range() :: {String.t(), String.t()} | nil

review_result()

@type review_result() ::
  :ok
  | {:cleaned_up, merge_range(), :interactive | :auto}
  | {:validation_failed, :pre_merge | :post_merge, String.t()}
  | {:merge_failed, String.t()}

worktree_info()

@type worktree_info() :: %{
  path: String.t(),
  branch: String.t(),
  base_branch: String.t()
}

Callbacks

auto_merge(t, worktree_info, keyword)

@callback auto_merge(String.t(), worktree_info(), keyword()) :: review_result()

colorize_diff(t)

@callback colorize_diff(String.t()) :: Owl.Data.t()

interactive_review(t, worktree_info, keyword)

@callback interactive_review(String.t(), worktree_info(), keyword()) :: review_result()

Functions

auto_merge(root, meta, opts \\ [])

@spec auto_merge(String.t(), worktree_info(), keyword()) :: review_result()

Merges worktree changes and cleans up without prompting. Runs validation before and after merge. Pre-merge validation failure blocks the merge.

colorize_diff(diff)

@spec colorize_diff(String.t()) :: Owl.Data.t()

Colorizes a unified diff string for terminal display.

impl()

@spec impl() :: module()

interactive_review(root, meta, opts \\ [])

@spec interactive_review(String.t(), worktree_info(), keyword()) :: review_result()

Walks the user through inspecting the diff, merging, and optionally deleting the worktree and its local branch. Runs validation before and after merge.