cargo-docgen 0.1.3

run and format small doctest snippets
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

//! A simple doc test runner. Packages up snippets using similar rules
//! to cargo test.
//!
//! Please see [readme](https://github.com/stevedonovan/cargo-docgen/blob/master/readme.md)

extern crate easy_shortcuts as es;
extern crate lapp;
use es::traits::*;

mod cache;
mod example;
mod config;
mod util;

use std::path::PathBuf;
use example::Example;
use util::{findstr,dump_indented};

fn main() {
    let mut config = config::Config::new();

    let code = es::read_to_string(&config.file);

    if ! config.module_doc {
        // just a doc test snippet
        let ex = Example::new(&config,&code);
        let (ok,stdout) = ex.run();
        if ok {
            if stdout.len() > 0 {
                eprintln!("****** tests will ignore this output ****");
                eprintln!("{}\n******",stdout);
            }
            let snip = ex.format();
            eprintln!("****** Copy and paste this into your code ******\n");
            println!("{}",snip);
        }
    } else {
        // a whole markdown file
        let start_guard = "```rust";
        let guard = "```\n";
        let doc_file = config.file.clone();
        let mut s = code.as_str();
        let mut kount = 1;
        let sep = "---\n";
        let mut snippet_cache = cache::read(&doc_file,sep).or_die("bad cache");
        let comment = config.comment.as_str();
        while let Some((start1,start2)) = findstr(s,start_guard) {
            // just comment the text
            dump_indented(&s[0..start1], comment);
            // and skip the guard and find the end
            s = &s[start2..];
            // ```rust? means the snippet has a Question
            // and this might be followed with 'n' for 'just compile dammit'
            config.question = false;
            config.no_run = false;
            if s.starts_with('?') {
                s = &s[1..];
                config.question = true;
            }
            if s.starts_with('n') {
                s = &s[1..];
                config.no_run = true;
            }
            s = &s[1..]; // skip \n
            let (end1,end2) = findstr(s,guard).or_die("expecting end of code ```");
            let snippet = &s[0..end1];
            config.file = PathBuf::from(format!("t{}.rs",kount));
            let ex = Example::new(&config,snippet);
            // don't run the test again if we have seen this snippet!
            if snippet_cache.iter().position(|s| s == snippet).is_none() {
                snippet_cache.push(snippet.into());
                let (_,stdout) = ex.run();
                if stdout.len() > 0 {
                    let comment_comment = format!("{} // ",comment);
                    dump_indented(&stdout, &comment_comment);
                }
            }
            print!("{}", ex.format());
            kount += 1;

            // let's look for next code block
            s = &s[end2..];
        }
        dump_indented(s, comment);
        cache::write(&doc_file,snippet_cache,sep).or_die("cannot write cache");
    }

}