rumk 0.0.1

A fast linter for Makefiles
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
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172

use crate::diagnostic::{Diagnostic, Severity};
use crate::parser::Makefile;
use crate::rules::{Rule, RuleCategory};

#[derive(Debug, Clone, Copy, PartialEq)]
pub enum NamingStyle {
    Upper,
    Lower,
}

pub struct LineLength {
    max_length: usize,
}

impl LineLength {
    pub fn new(max_length: usize) -> Self {
        Self { max_length }
    }
}

impl Rule for LineLength {
    fn id(&self) -> &'static str {
        "MK101"
    }

    fn name(&self) -> &'static str {
        "Line exceeds maximum length"
    }

    fn description(&self) -> &'static str {
        "Lines should not exceed the configured maximum length for better readability."
    }

    fn category(&self) -> RuleCategory {
        RuleCategory::Style
    }

    fn check(&self, _makefile: &Makefile, content: &str) -> Vec<Diagnostic> {
        let mut diagnostics = Vec::new();

        for (line_num, line) in content.lines().enumerate() {
            if line.len() > self.max_length {
                diagnostics.push(Diagnostic::new(
                    self.id(),
                    Severity::Warning,
                    format!(
                        "Line length {} exceeds maximum of {}",
                        line.len(),
                        self.max_length
                    ),
                    line_num + 1,
                    self.max_length + 1,
                ));
            }
        }

        diagnostics
    }
}

pub struct VariableNaming {
    style: NamingStyle,
}

impl VariableNaming {
    pub fn new(style: NamingStyle) -> Self {
        Self { style }
    }
}

impl Rule for VariableNaming {
    fn id(&self) -> &'static str {
        "MK102"
    }

    fn name(&self) -> &'static str {
        "Variable naming convention"
    }

    fn description(&self) -> &'static str {
        "Variables should follow the configured naming convention for consistency."
    }

    fn category(&self) -> RuleCategory {
        RuleCategory::Style
    }

    fn check(&self, makefile: &Makefile, _content: &str) -> Vec<Diagnostic> {
        let mut diagnostics = Vec::new();

        for variable in makefile.variables.values() {
            if !matches_naming_style(&variable.name, self.style) {
                let expected = naming_style_description(self.style);
                diagnostics.push(Diagnostic::new(
                    self.id(),
                    Severity::Warning,
                    format!(
                        "Variable '{}' does not follow {} convention",
                        variable.name, expected
                    ),
                    variable.line,
                    variable.column,
                ));
            }
        }

        diagnostics
    }
}

pub struct TargetNaming {
    style: NamingStyle,
}

impl TargetNaming {
    pub fn new(style: NamingStyle) -> Self {
        Self { style }
    }
}

impl Rule for TargetNaming {
    fn id(&self) -> &'static str {
        "MK103"
    }

    fn name(&self) -> &'static str {
        "Target naming convention"
    }

    fn description(&self) -> &'static str {
        "Targets should follow the configured naming convention for consistency."
    }

    fn category(&self) -> RuleCategory {
        RuleCategory::Style
    }

    fn check(&self, makefile: &Makefile, _content: &str) -> Vec<Diagnostic> {
        let mut diagnostics = Vec::new();

        for rule in &makefile.rules {
            for target in &rule.targets {
                if !target.starts_with('.') && !matches_naming_style(target, self.style) {
                    let expected = naming_style_description(self.style);
                    diagnostics.push(Diagnostic::new(
                        self.id(),
                        Severity::Warning,
                        format!("Target '{target}' does not follow {expected} convention"),
                        rule.line,
                        rule.column,
                    ));
                }
            }
        }

        diagnostics
    }
}

fn matches_naming_style(name: &str, style: NamingStyle) -> bool {
    match style {
        NamingStyle::Upper => name.chars().all(|c| !c.is_alphabetic() || c.is_uppercase()),
        NamingStyle::Lower => name.chars().all(|c| !c.is_alphabetic() || c.is_lowercase()),
    }
}

fn naming_style_description(style: NamingStyle) -> &'static str {
    match style {
        NamingStyle::Upper => "UPPER_CASE",
        NamingStyle::Lower => "lower_case",
    }
}