fix: make text-mode progress output usable in CI

[jdx]

Summary

Cleans up hk's text-mode (CI / piped stderr) progress output. The previous behavior was unreadable in GitHub Actions logs: raw [9A[80D[0J cursor-control escapes leaked into the log, every status change duplicated, failure stderr was suppressed, and a step matching hundreds of files dumped ~4KB of paths into every progress line. After this PR a 14-step pre-commit run reads as a clean append-only stream with one full diagnostic block per failure.

What changed

Bumped clx 2.0 → 2.0.1 (clx#86)

• refresh_once() is now a no-op in ProgressOutput::Text so terminal-state transitions and stop() don't leak UI escape codes
• render_text_mode() dedupes consecutive identical job lines per job (multiple props updated in quick succession no longer print the same line N times)
• next_operation() resets the dedup cache so multi-operation transitions are never silently swallowed

Failure summaries shown in text mode (src/hook.rs)

• HookContext.failed_steps: Mutex<HashSet<String>> tracks failures so the end-of-run summary survives the step_contexts.shift_remove that fires when each step finishes
• In text mode, the per-step output summary block is now emitted for failed steps by default — successful steps stay quiet (their output already streamed). HK_SUMMARY_TEXT=1 still forces every step's summary to print
• Docs updated for HK_SUMMARY_TEXT to reflect the new default behavior

Bounded progress message rendering (src/step/runner.rs, src/tera.rs, src/step_job.rs)

• New Context::for_display() returns a tera context where files / workspace_files are rewritten to first_token … when more than one file matches. The runner renders twice — display version for the progress message, full version for execution
• truncate_progress_message() caps the formatted progress message at 2048 printable chars with a trailing …, ANSI-aware so escape sequences don't get split mid-cluster
• Dropped the truncate_text filter from step_job.rs body_text — clx's filter clamped to (term_width - 20) which is 60 chars in non-TTY environments, cutting exactly the diagnostic detail you need to debug a CI failure

Examples — dbg step matching 98 .rs files in CI:

# before:
  dbg – 98 files – **/*.rs – ! rg -e 'dbg!' bin/generate_docs.rs build/generate_builtins.rs ... [continues for 98 paths] ...

# after:
  dbg – 98 files – **/*.rs – ! rg -e 'dbg!' bin/generate_docs.rs …

Failed step in CI:

# before (excerpt — full block was ~85 lines of escape-code-littered duplication):
[9A[80D[0J✔ files - Fetching all files in repo (671 files)
✗ demo-fail
✗ demo-fail
✗ demo-fail
✗ demo-fail – ERROR
[9A[80D[0J✔ files - Fetching all files in repo (671 files)
... (escape-code redraws repeat for every aborted sibling step)

# after:
  demo-fail – 98 files – **/*.rs – echo "..." (multi-line script)
  demo-fail – this step is intentionally failing so we can see what the output looks like
  demo-fail – line two of stderr
  demo-fail – line three of stdout
✗ demo-fail
✗ demo-fail – ERROR

demo-fail stderr:
this step is intentionally failing so we can see what the output looks like
line two of stderr
line three of stdout

Test plan

• cargo test — 149 pass (11 new across src/tera.rs::tests and src/step::runner::tests)
• mise run test:bats test/git.bats — 4 pass under both libgit2 and nolibgit2 (assertions updated for first_file … display)
• mise run test:bats test/output_summary.bats test/output_summary_no_duplicate.bats test/output_summary_check_first.bats — 11 pass
• Verified end-to-end in CI via the (now-removed) demo-fail scaffolding step — see runs 25166877825 (before) and 25168039915 (after)

🤖 Generated with Claude Code

[cursor]

Deliberately failing CI step must not be merged

High Severity

The demo-fail step is a temporary debugging aid that unconditionally fails with exit 1. If this lands on the default branch, it will cause every CI run to fail on any commit that touches **/*.rs files. The PR description's test plan calls for removing it before merge, but it's still present.

 

^{Reviewed by Cursor Bugbot for commit 94f6568. Configure here.}

[gemini-code-assist]

Code Review

This pull request introduces a temporary, intentionally failing linter step named 'demo-fail' to the hk.pkl configuration to capture and inspect CI failure output. Feedback suggests isolating this step using a specific profile to prevent it from disrupting local developer workflows by causing pre-commit or pre-push hooks to fail globally.

[gemini-code-assist]

Adding a deliberately failing step to the global linters mapping will cause the pre-commit and pre-push hooks to fail for all developers working on this branch. This can be disruptive to local workflows.

Consider isolating this step using a specific profile so it only runs in the CI environment where you intend to capture the output. You can then trigger it in CI by passing the --profile flag.

  // TEMP: deliberately failing step to capture the ugly clx failure output in CI.
  // Remove once we've fixed the formatting in a follow-up.
  ["demo-fail"] = new Step {
    profiles = List("ci-debug")
    glob = "**/*.rs"
    check =
      #"""
      echo "this step is intentionally failing so we can see what the output looks like"
      echo "line two of stderr" 1>&2
      echo "line three of stdout"
      exit 1
      """#
  }

[greptile-apps]

Greptile Summary

This PR improves CI/text-mode output readability by: (1) tracking failed steps in HookContext.failed_steps and only emitting end-of-run output summaries for those steps in text mode by default (UI mode is unchanged), (2) rendering a truncated display variant of {{files}}/{{workspace_files}} for progress messages to keep CI log lines bounded, and (3) removing the truncate_text filter from text-mode progress bodies so CI diagnostics are no longer clipped. New unit tests cover the token-splitting and truncation helpers.

Confidence Score: 5/5

Safe to merge once the demo-fail step and [patch.crates-io] branch pin are removed (both noted in existing threads).

No P0 or P1 issues found. All logic changes are well-reasoned, well-commented, and backed by unit tests. The summary-display condition is correct, the token-splitter correctly handles multi-byte UTF-8, and the dual-render approach for display vs. execution is sound.

No files require special attention beyond the pre-merge checklist items already tracked in existing review threads.

Important Files Changed

Filename	Overview
src/hook.rs	Adds failed_steps: Mutex<HashSet> to HookContext, mark_step_failed helper, and revised summary display logic that filters to failed-only in text mode.
src/step/output.rs	Calls mark_step_failed after the check_first early-return guard so only the failing run phase marks the step.
src/step/runner.rs	Adds truncate_progress_message helper and renders commands twice — once via for_display() for the progress message, once in full for execution.
src/tera.rs	Adds Context::for_display(), truncate_quoted_list, and split_quoted_tokens with thorough unit tests covering quoted paths, escapes, and edge cases.
src/step_job.rs	Removes truncate_text filter from the body_text template so text-mode CI output is no longer truncated mid-diagnostic.
test/git.bats	Updates bats assertion to match new truncated-file-list display format.
Cargo.toml	Bumps clx to 2.0.1; still carries a [patch.crates-io] entry pinning a branch (noted in existing review thread).

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Hook run completes] --> B[clx::progress::stop]
    B --> C{in_text_mode?}
    C -->|No — UI mode| D[Enter output loop]
    C -->|Yes| E{HK_SUMMARY_TEXT=1?}
    E -->|Yes — force_summary| D
    E -->|No| F{failed_steps not empty?}
    F -->|No| G[Skip all summaries]
    F -->|Yes| D
    D --> H[For each step in output_by_step]
    H --> I{in_text_mode && !force_summary?}
    I -->|No| J[Print step summary]
    I -->|Yes| K{step in failed_steps?}
    K -->|Yes| J
    K -->|No| L[Skip — already streamed live]
    J --> M{More steps?}
    L --> M
    M -->|Yes| H
    M -->|No| N[End]
    G --> N

Loading

_{Reviews (7): Last reviewed commit: "fix(step): cap progress message length" | Re-trigger Greptile}

[cursor]

Cursor Bugbot has reviewed your changes and found 1 potential issue.

There are 2 total unresolved issues (including 1 from previous review).

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit eb79985. Configure here.}