whichdoc 0.2.1

A cargo documentation diagnostics-driven editor
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

//! Parse the compiler's diagnostic output (cargo doc diagnostics).
//!
//! These either come from a pipe over STDIN or we execute cargo doc ourselves.
//! We filter out all but the `missing_docs` diagnostics.
//! Parse the compiler's diagnostic output (cargo doc diagnostics).
//!
//! These either come from a pipe over STDIN or we execute cargo doc ourselves.
//! We filter out all but the `missing_docs` diagnostics.
//! Parse the compiler's diagnostic output (cargo doc diagnostics).
//!
//! These either come from a pipe over STDIN or we execute cargo doc ourselves.
//! We filter out all but the `missing_docs` diagnostics.
use crate::types::Coordinate;
use std::io::{self, BufRead};
use std::process::{Command, Stdio};

///
/// # Errors
///
/// Returns an error if cargo command fails or output cannot be parsed.
///
/// # Panics
///
/// Panics if stdout cannot be captured from the cargo process.
pub fn read_cargo_diagnostics() -> io::Result<Vec<Coordinate>> {
    let input: Box<dyn BufRead> = if atty::is(atty::Stream::Stdin) {
        let child = Command::new("cargo")
            .args(["doc", "--message-format=json"])
            .stdout(Stdio::piped())
            .stderr(Stdio::null())
            .spawn()?;
        Box::new(io::BufReader::new(child.stdout.unwrap()))
    } else {
        Box::new(io::BufReader::new(io::stdin()))
    };

    let mut diagnostics = Vec::new();
    for line in input.lines() {
        let line = line?;
        if line.trim().is_empty() {
            continue;
        }
        if let Ok(coord) = serde_json::from_str::<Coordinate>(&line) {
            if let Some(ref msg) = coord.message {
                if msg.code.code == "missing_docs" {
                    diagnostics.push(coord);
                }
            }
        }
    }
    Ok(diagnostics)
}