lintje 0.7.0

Lintje is an opinionated linter for Git.
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

use crate::rule::Rule;
use core::ops::Range;
use std::fmt;

#[derive(Debug, PartialEq)]
pub enum IssueType {
    Error,
    Hint,
}

impl fmt::Display for IssueType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let label = match self {
            IssueType::Error => "Error",
            IssueType::Hint => "Hint",
        };
        write!(f, "{}", label)
    }
}

#[derive(Debug, PartialEq)]
pub struct Issue {
    pub r#type: IssueType,
    pub rule: Rule,
    pub message: String,
    pub position: Position,
    pub context: Vec<Context>,
}

impl Issue {
    pub fn error(rule: Rule, message: String, position: Position, context: Vec<Context>) -> Self {
        Self {
            r#type: IssueType::Error,
            rule,
            message,
            position,
            context,
        }
    }

    pub fn hint(rule: Rule, message: String, position: Position, context: Vec<Context>) -> Self {
        Self {
            r#type: IssueType::Hint,
            rule,
            message,
            position,
            context,
        }
    }
}

#[derive(Debug, PartialEq)]
pub enum Position {
    Subject { line: usize, column: usize },
    MessageLine { line: usize, column: usize },
    Diff,
    Branch { column: usize },
}

#[derive(Debug, PartialEq)]
pub enum ContextType {
    Plain,
    Error,
    Addition,
}

#[derive(Debug, PartialEq)]
pub struct Context {
    pub r#type: ContextType,
    pub line: Option<usize>,
    pub content: String,
    pub range: Option<Range<usize>>,
    pub message: Option<String>,
}

impl Context {
    pub fn subject(content: String) -> Self {
        Self {
            r#type: ContextType::Plain,
            line: Some(1),
            content,
            range: None,
            message: None,
        }
    }

    pub fn subject_error(content: String, range: Range<usize>, message: String) -> Self {
        Self {
            r#type: ContextType::Error,
            line: Some(1),
            content,
            range: Some(range),
            message: Some(message),
        }
    }

    pub fn message_line(line: usize, content: String) -> Self {
        Self {
            r#type: ContextType::Plain,
            line: Some(line),
            content,
            range: None,
            message: None,
        }
    }

    pub fn message_line_error(
        line: usize,
        content: String,
        range: Range<usize>,
        message: String,
    ) -> Self {
        Self {
            r#type: ContextType::Error,
            line: Some(line),
            content,
            range: Some(range),
            message: Some(message),
        }
    }

    pub fn message_line_addition(
        line: usize,
        content: String,
        range: Range<usize>,
        message: String,
    ) -> Self {
        Self {
            r#type: ContextType::Addition,
            line: Some(line),
            content,
            range: Some(range),
            message: Some(message),
        }
    }

    pub fn diff_error(content: String, range: Range<usize>, message: String) -> Self {
        Self {
            r#type: ContextType::Error,
            line: None,
            content,
            range: Some(range),
            message: Some(message),
        }
    }

    pub fn branch_error(content: String, range: Range<usize>, message: String) -> Self {
        Self {
            r#type: ContextType::Error,
            line: None,
            content,
            range: Some(range),
            message: Some(message),
        }
    }
}