drep-ai 2.3.0

A local commit gate: runs the linters your repo configures, and sends changed code to an LLM for review
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

//! Render a [`LintOutcome`] to stdout.
//!
//! Text only. `lint-docs` has no `--format json`: it is a hook-facing command
//! whose consumer is a human reading a terminal, and adding a wire format
//! before anything consumes one means committing to a shape nobody has tested
//! against.
//!
//! The finding line and the failure block come from `cli::render`, shared with
//! `check`. The one deliberate difference is the source prefix: `check` tags
//! each line `tool/` or `llm/` because two layers write into one list and they
//! gate differently, and passing `None` here is what says "one source".

use std::io::Write;

use anyhow::Result;

use crate::cli::lint_docs::{Gating, LintOutcome};
use crate::cli::render::{finding_line, write_failures, write_suggestion};

/// Render to stdout.
pub fn render(outcome: &LintOutcome) -> Result<()> {
    render_to(&mut std::io::stdout().lock(), outcome)
}

/// Render to an arbitrary sink, so a test can capture the bytes without a
/// subprocess.
pub fn render_to<W: Write>(out: &mut W, outcome: &LintOutcome) -> Result<()> {
    for finding in &outcome.findings {
        writeln!(out, "{}", finding_line(None, finding))?;
        write_suggestion(out, finding)?;
    }
    write_failures(out, &outcome.failures, !outcome.findings.is_empty())?;

    if outcome.findings.is_empty() && outcome.failures.is_empty() {
        writeln!(out, "No issues found.")?;
        return Ok(());
    }

    // The report-only footer exists because the exit code is otherwise the
    // only signal, and it is zero. Without this line a hook that prints forty
    // findings and lets the commit through looks broken.
    if !outcome.findings.is_empty() {
        writeln!(out)?;
        let count = outcome.findings.len();
        // Three footers, because there are three ways a run can end with
        // findings on screen, and `Gating` is the gate's own answer rather
        // than a second reading of it. The middle case is the one that needs
        // saying: `--fail-on error` over this repository prints two dozen
        // findings and exits 0, and a bare count there reads as a broken gate.
        match outcome.gating {
            Gating::ReportOnly => writeln!(
                out,
                "{count} issue(s) found (report only; pass --strict to fail)."
            )?,
            Gating::NoneReached(threshold) => writeln!(
                out,
                "{count} issue(s) found (none at or above {}).",
                threshold.as_str()
            )?,
            Gating::Blocked => writeln!(out, "{count} issue(s) found.")?,
        }
    }
    Ok(())
}