snipdoc 0.1.12

Code Documentation Made Simple
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

use std::{collections::BTreeMap, path::Path};

use tabled::{builder::Builder, settings::Style};

use super::ReporterOutput;
use crate::parser::{
    injector::{InjectSnippets, InjectStatus, InjectedContent},
    Snippet,
};

pub struct Output {}

impl Output {}

impl ReporterOutput for Output {
    fn snippets(&self, root_folder: &Path, snippets: &BTreeMap<String, Snippet>) {
        let mut builder = Builder::default();
        builder.push_record(["#", "Snippet Kind", "ID", "Path"]);

        println!("Found {} snippets", snippets.len());
        let mut count = 1;
        for (id, snippet) in snippets {
            let path_view = dunce::canonicalize(root_folder)
                .map(|absolute_path| {
                    snippet
                        .path
                        .strip_prefix(absolute_path)
                        .unwrap_or(&snippet.path)
                })
                .unwrap_or(&snippet.path);

            builder.push_record([
                format!("{count}"),
                format!("{:#?}", snippet.kind),
                id.to_string(),
                format!("{}", path_view.display()),
            ]);
            count += 1;
        }

        println!("{}", builder.build().with(Style::modern()));
    }

    fn inject(&self, root_folder: &Path, result: &InjectSnippets) {
        let mut builder = Builder::default();
        builder.push_record(["Path", "Action", "Snippet ID", ""]);

        for (file, status) in result.iter() {
            let path_view = dunce::canonicalize(root_folder)
                .map(|absolute_path| file.strip_prefix(absolute_path).unwrap_or(file))
                .unwrap_or(file);

            match status {
                InjectedContent::Injected(summary) => {
                    for action in &summary.actions {
                        match action {
                            InjectStatus::Equal { snippet_id } => {
                                builder.push_record([
                                    format!("{}", path_view.display()),
                                    "equal".to_string(),
                                    snippet_id.to_string(),
                                    String::new(),
                                ]);
                            }
                            InjectStatus::Injected {
                                snippet_id,
                                content: _,
                            } => {
                                builder.push_record([
                                    format!("{}", path_view.display()),
                                    "injected".to_string(),
                                    snippet_id.to_string(),
                                    String::new(),
                                ]);
                            }
                            InjectStatus::NotFound {
                                snippet_id,
                                snippet_kind,
                            } => {
                                builder.push_record([
                                    format!("{}", path_view.display()),
                                    "not-found-snippets".to_string(),
                                    snippet_id.to_string(),
                                    format!("Inject from: {snippet_kind:?}"),
                                ]);
                            }
                        }
                    }
                }
                InjectedContent::None => (),
                InjectedContent::Error(error) => {
                    builder.push_record([
                        format!("{}", path_view.display()),
                        "error".to_string(),
                        String::new(),
                        error.to_string(),
                    ]);
                }
            }
        }

        println!("{}", builder.build().with(Style::modern()));
    }
}