drep-ai 3.0.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
65
66

//! Tests for `drep lint-docs`.
//!
//! Every file here must be declared below - Rust silently ignores a test file
//! no `mod` points at.

mod gating;
mod render;
mod resolve;
mod staged;

use std::path::Path;

use tempfile::TempDir;

use crate::analysis::findings::Severity;
use crate::cli::lint_docs::{LintDocsArgs, LintOutcome, analyze};

/// A temp directory with the named files written into it.
///
/// Paths may contain a directory component; parents are created.
fn repo(files: &[(&str, &str)]) -> TempDir {
    let dir = TempDir::new().expect("temp dir");
    for (name, content) in files {
        let path = dir.path().join(name);
        if let Some(parent) = path.parent() {
            std::fs::create_dir_all(parent).expect("mkdir");
        }
        std::fs::write(&path, content).expect("write");
    }
    dir
}

/// Run `lint-docs` over `root` with the given arguments.
///
/// `paths` are joined onto `root`, which is what a user gets by `cd`-ing into
/// the repository: in production `root` is the process cwd (`"."`), so an
/// argument and the walk root are relative to the same place. The parameter
/// exists so a test does not have to chdir a shared process.
fn run_in(root: &Path, paths: &[&str], strict: bool) -> LintOutcome {
    analyze(&args_for(root, paths, strict, None), root)
}

/// The same, gated at an explicit severity rather than by `--strict`.
fn run_failing_on(root: &Path, paths: &[&str], severity: Severity) -> LintOutcome {
    analyze(&args_for(root, paths, false, Some(severity)), root)
}

/// The argument struct, built in one place.
///
/// `LintDocsArgs` has gained three fields so far, and each helper spelling out
/// its own literal means every new field is edited into every helper - or
/// missed in one, where it silently takes the `Default`-shaped value the test
/// author never considered.
fn args_for(root: &Path, paths: &[&str], strict: bool, fail_on: Option<Severity>) -> LintDocsArgs {
    LintDocsArgs {
        paths: paths.iter().map(|p| root.join(p)).collect(),
        staged: false,
        strict,
        fail_on,
    }
}

/// Run over the whole of `root` (no explicit paths), report-only.
fn walk(root: &Path) -> LintOutcome {
    run_in(root, &[], false)
}