cargo-quickstart 0.1.4

A cargo subcommand for quickly generating Rust project scaffolds
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
105
106
107
108
109
110
111

//! Check for template usage and consistency

use crate::commands::doctor::diagnosis::Check;
use crate::commands::doctor::types::{Diagnostic, Severity};
use std::path::PathBuf;

/// Check for template consistency across the project
pub struct TemplatesCheck {
    #[allow(dead_code)]
    template_dir: PathBuf,
}

impl TemplatesCheck {
    /// Create a new TemplatesCheck that examines the templates directory
    pub fn new() -> Self {
        Self {
            template_dir: PathBuf::from("templates"),
        }
    }

    /// Check that templates have consistent naming
    fn check_template_naming(&self) -> Diagnostic {
        // In a real implementation, we would scan template files
        // For now, just a placeholder
        Diagnostic::new(
            self.name(),
            Severity::Info,
            "Templates follow consistent naming conventions",
            self.category(),
        )
    }

    /// Check that templates have documentation
    fn check_template_docs(&self) -> Diagnostic {
        // In a real implementation, we would check for README files
        // For now, just a placeholder
        Diagnostic::new(
            self.name(),
            Severity::Info,
            "All templates have documentation",
            self.category(),
        )
    }

    /// Check that templates are valid
    fn check_template_validity(&self) -> Diagnostic {
        // In a real implementation, we would validate template syntax
        // For now, just a placeholder
        Diagnostic::new(
            self.name(),
            Severity::Info,
            "All templates have valid syntax",
            self.category(),
        )
    }
}

impl Check for TemplatesCheck {
    fn run(&self) -> Vec<Diagnostic> {
        vec![
            self.check_template_naming(),
            self.check_template_docs(),
            self.check_template_validity(),
        ]
    }

    fn name(&self) -> &str {
        "Templates"
    }

    fn description(&self) -> &str {
        "Check for template consistency and documentation"
    }

    fn category(&self) -> &str {
        "templates"
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_name_method() {
        let check = TemplatesCheck::new();
        assert_eq!(check.name(), "Templates");
    }

    #[test]
    fn test_description_method() {
        let check = TemplatesCheck::new();
        assert_eq!(
            check.description(),
            "Check for template consistency and documentation"
        );
    }

    #[test]
    fn test_category_method() {
        let check = TemplatesCheck::new();
        assert_eq!(check.category(), "templates");
    }

    #[test]
    fn test_run_returns_diagnostics() {
        let check = TemplatesCheck::new();
        let diagnostics = check.run();
        assert!(!diagnostics.is_empty());
    }
}