typos-git-commit 0.8.2

This program analyzes a json file produced with `typos` and makes commits for each correction.
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

use crate::cli::Cli;
use serde::Deserialize;

// A typical typo line in JSON format from typos output program:
// {"type":"typo","path":"doc/man/man5/burst_buffer.conf.5","line_num":65,"byte_offset":20,"typo":"preceeded","corrections":["preceded","proceeded"]}

#[derive(Deserialize, Debug, Clone)]
pub struct TyposJsonLine {
    #[serde(default, rename = "type")]
    pub type_id: String,

    #[serde(default)]
    pub path: String,

    #[serde(default)]
    pub line_num: u32,

    #[serde(default)]
    pub byte_offset: u32,

    #[serde(default)]
    pub typo: String,

    #[serde(default)]
    pub corrections: Vec<String>,
}

impl TyposJsonLine {
    // Tells whether the file has been excluded from typos corrections
    #[must_use]
    pub fn is_file_excluded(&self, cli: &Cli) -> bool {
        match &cli.exclude_file {
            Some(list) => {
                for file in list {
                    if self.path.contains(file) {
                        return true;
                    }
                }
                false
            }
            None => false,
        }
    }

    // Tells whether typo contains one excluded typo
    #[must_use]
    pub fn is_typo_excluded(&self, cli: &Cli) -> bool {
        match &cli.exclude_typo {
            Some(list) => {
                for t in list {
                    if self.typo.contains(t) {
                        return true;
                    }
                }
                false
            }
            None => false,
        }
    }

    // Tells whether typo contains one excluded correction
    #[must_use]
    pub fn is_correction_excluded(&self, cli: &Cli) -> bool {
        match &cli.exclude_correction {
            Some(list) => {
                for t in list {
                    for correction in &self.corrections {
                        if correction.contains(t) {
                            return true;
                        }
                    }
                }
                false
            }
            None => false,
        }
    }

    // A TypoJsonLine is excluded if at least one of typo, correction or file is excluded
    // from being corrected
    #[must_use]
    pub fn is_excluded(&self, cli: &Cli) -> bool {
        self.is_typo_excluded(cli) || self.is_correction_excluded(cli) || self.is_file_excluded(cli)
    }
}