typope 0.4.1

Pedantic source code checker for orthotypography mistakes and other typographical errors
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
105
106
107
108
109
110
111
112
113
114
115
116
117

use serde::Deserialize;
use toml::Spanned;

use super::{Language, LintableNode, Mode, Parsed};

/// Lintable metadata of a Rust package (`Cargo.toml`)
#[derive(Deserialize)]
struct Manifest {
    /// Defines a package
    pub package: Option<Package>,

    /// Defines a workspace
    pub workspace: Option<Workspace>,
}

#[derive(Deserialize)]
struct Package {
    /// A description of the package
    pub description: Spanned<String>,
}

#[derive(Deserialize)]
struct Workspace {
    /// Keys for inheriting in packages
    pub package: Option<Package>,
}

/// Parser for `Cargo.toml` files that only returns relevant lintable strings (e.g., the description field)
struct ParsedManifest {
    manifest: Manifest,
}

impl ParsedManifest {
    pub fn new(text: impl AsRef<[u8]>) -> anyhow::Result<Self> {
        let text = String::from_utf8_lossy(text.as_ref());
        let manifest: Manifest = toml::from_str(text.as_ref())?;

        Ok(Self { manifest })
    }
}

impl Parsed for ParsedManifest {
    fn lintable_nodes<'t>(&'t mut self) -> Box<dyn Iterator<Item = LintableNode<'t>> + 't> {
        Box::new(std::iter::empty())
    }

    fn strings<'t>(
        &'t mut self,
        _source: &'t [u8],
    ) -> Box<dyn Iterator<Item = super::LintableString> + 't> {
        let descriptions = self
            .manifest
            .package
            .iter()
            .chain(self.manifest.workspace.iter().flat_map(|w| &w.package))
            .map(|p| &p.description)
            .filter(|s| s.get_ref().len() >= 3)
            .map(Into::into);

        Box::new(descriptions)
    }
}

impl Language {
    /// Creates a language parser for `Cargo.toml` files
    pub fn cargo_toml() -> Self {
        Self {
            name: "Cargo.toml",
            detections: &["Cargo.toml"],
            parser: Mode::Custom(Box::new(move |text| {
                Ok(Box::new(ParsedManifest::new(text)?))
            })),
        }
    }
}

#[cfg(test)]
mod tests {
    use std::ffi::OsStr;

    use crate::SharedSource;
    use crate::lang::LintableString;

    use super::Language;

    #[test]
    fn exists_in_iter() {
        assert!(Language::iter().any(|lang| lang.name() == "Cargo.toml"));
    }

    #[test]
    fn find_from_filename() {
        assert_eq!(
            "Cargo.toml",
            Language::from_filename(OsStr::new("Cargo.toml"))
                .unwrap()
                .name()
        );
    }

    #[test]
    fn lintable_strings() {
        let cargo_toml = include_str!("../../Cargo.toml");
        let toml = SharedSource::new("Cargo.toml", cargo_toml.as_bytes().to_vec());
        let mut parsed = Language::cargo_toml().parse(&toml).unwrap();
        let strings = parsed.strings(toml.as_ref()).collect::<Vec<_>>();
        assert_eq!(
            strings,
            [
                LintableString {
                    offset: 58,
                    value: "Pedantic source code checker for orthotypography mistakes and other typographical errors".into()
                }
            ]
        );
    }
}