lineguard 0.1.7

A fast and reliable file linter that ensures proper line endings and clean formatting
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
//! Human-readable reporter implementation
//!
//! This module provides a reporter that outputs results in a human-friendly format
//! with optional color support.

use crate::reporter::{Color, ColoredOutput, Output, Reporter, ReporterWithOutput};
use crate::{CheckResult, Issue};
use std::io;

/// Human-readable reporter with color support
pub struct HumanReporter {
    /// Whether to use colored output
    pub use_color: bool,
}

impl HumanReporter {
    /// Create a new human reporter without color
    pub fn new() -> Self {
        Self { use_color: false }
    }

    /// Create a new human reporter with color support
    pub fn with_color() -> Self {
        Self { use_color: true }
    }
}

impl Default for HumanReporter {
    fn default() -> Self {
        Self::new()
    }
}

impl Reporter for HumanReporter {
    fn report(&self, results: &[CheckResult]) {
        // Use StdOutput as the default output
        let mut output = if self.use_color {
            crate::reporter::StdOutput::with_color()
        } else {
            crate::reporter::StdOutput::new()
        };

        // Ignore any errors from output operations in the legacy interface
        let _ = self.report_to_colored(results, &mut output);
    }
}

impl ReporterWithOutput for HumanReporter {
    fn report_to(&self, results: &[CheckResult], output: &mut dyn Output) -> io::Result<()> {
        // Create a wrapper to use the colored output method without colors
        struct PlainOutputWrapper<'a>(&'a mut dyn Output);

        impl<'a> ColoredOutput for PlainOutputWrapper<'a> {
            fn write_colored(&mut self, content: &str, _color: Color) -> io::Result<()> {
                self.0.write(content)
            }
        }

        impl<'a> Output for PlainOutputWrapper<'a> {
            fn write(&mut self, content: &str) -> io::Result<()> {
                self.0.write(content)
            }

            fn write_line(&mut self, content: &str) -> io::Result<()> {
                self.0.write_line(content)
            }

            fn flush(&mut self) -> io::Result<()> {
                self.0.flush()
            }
        }

        let mut wrapper = PlainOutputWrapper(output);
        let reporter = HumanReporter { use_color: false };
        reporter.report_to_colored(results, &mut wrapper)
    }
}

impl HumanReporter {
    /// Report with colored output support
    pub fn report_to_colored(
        &self,
        results: &[CheckResult],
        output: &mut dyn ColoredOutput,
    ) -> io::Result<()> {
        let (total_issues, files_with_issues) = self.report_file_issues(results, output)?;
        self.report_summary(total_issues, files_with_issues, results.len(), output)?;
        output.flush()?;
        Ok(())
    }

    /// Report individual file issues and return summary counts
    fn report_file_issues(
        &self,
        results: &[CheckResult],
        output: &mut dyn ColoredOutput,
    ) -> io::Result<(usize, usize)> {
        let mut total_issues = 0;
        let mut files_with_issues = 0;

        for result in results {
            if !result.issues.is_empty() {
                files_with_issues += 1;
                total_issues += result.issues.len();

                // File header with color
                self.write_file_header(&result.file_path, output)?;

                // Issues
                for issue in &result.issues {
                    self.write_issue(issue, output)?;
                }
                output.write_line("")?;
            }
        }

        Ok((total_issues, files_with_issues))
    }

    /// Write file header with appropriate coloring
    fn write_file_header(
        &self,
        file_path: &std::path::Path,
        output: &mut dyn ColoredOutput,
    ) -> io::Result<()> {
        if self.use_color {
            output.write_colored("", Color::Red)?;
            output.write(" ")?;
            output.write(&format!("{}", file_path.display()))?;
            output.write_line("")?;
        } else {
            output.write_line(&format!("{}", file_path.display()))?;
        }
        Ok(())
    }

    /// Write individual issue
    fn write_issue(&self, issue: &Issue, output: &mut dyn ColoredOutput) -> io::Result<()> {
        match issue.line {
            Some(line) => {
                output.write_line(&format!("  - Line {line}: {}", issue.message))?;
            },
            None => {
                output.write_line(&format!("  - {}", issue.message))?;
            },
        }
        Ok(())
    }

    /// Write summary with appropriate coloring
    fn report_summary(
        &self,
        total_issues: usize,
        files_with_issues: usize,
        files_checked: usize,
        output: &mut dyn ColoredOutput,
    ) -> io::Result<()> {
        if total_issues == 0 {
            if self.use_color {
                output.write_colored("", Color::Green)?;
                output.write_line(" All files passed lint checks!")?;
            } else {
                output.write_line("✓ All files passed lint checks!")?;
            }
        } else if self.use_color {
            output.write_colored("", Color::Red)?;
            output.write(&format!(
                " Found {total_issues} issues in {files_with_issues} files"
            ))?;
            output.write_line("")?;
        } else {
            output.write_line(&format!(
                "✗ Found {total_issues} issues in {files_with_issues} files"
            ))?;
        }
        output.write_line(&format!("  Files checked: {files_checked}"))?;
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::testing::mocks::MockOutput;
    use crate::{Issue, IssueType};
    use std::path::PathBuf;

    fn create_test_results() -> Vec<CheckResult> {
        vec![
            CheckResult {
                file_path: PathBuf::from("test1.txt"),
                issues: vec![
                    Issue {
                        issue_type: IssueType::TrailingSpace,
                        line: Some(5),
                        message: "Trailing spaces found".to_string(),
                    },
                    Issue {
                        issue_type: IssueType::MissingNewline,
                        line: None,
                        message: "Missing newline at end of file".to_string(),
                    },
                ],
                error: None,
            },
            CheckResult {
                file_path: PathBuf::from("test2.txt"),
                issues: vec![],
                error: None,
            },
            CheckResult {
                file_path: PathBuf::from("test3.txt"),
                issues: vec![Issue {
                    issue_type: IssueType::MultipleNewlines,
                    line: None,
                    message: "Multiple newlines at end of file".to_string(),
                }],
                error: None,
            },
        ]
    }

    #[test]
    fn test_human_reporter_no_issues() {
        let reporter = HumanReporter::new();
        let mut output = MockOutput::new();
        let results = vec![
            CheckResult {
                file_path: PathBuf::from("clean1.txt"),
                issues: vec![],
                error: None,
            },
            CheckResult {
                file_path: PathBuf::from("clean2.txt"),
                issues: vec![],
                error: None,
            },
        ];

        reporter.report_to(&results, &mut output).unwrap();

        let buffer = output.get_output();
        assert!(buffer.contains("✓ All files passed lint checks!"));
        assert!(buffer.contains("Files checked: 2"));
        assert!(!buffer.contains(""));
    }

    #[test]
    fn test_human_reporter_with_issues() {
        let reporter = HumanReporter::new();
        let mut output = MockOutput::new();
        let results = create_test_results();

        reporter.report_to(&results, &mut output).unwrap();

        let buffer = output.get_output();

        // Check file headers
        assert!(buffer.contains("✗ test1.txt"));
        assert!(buffer.contains("✗ test3.txt"));
        assert!(!buffer.contains("✗ test2.txt")); // This file has no issues

        // Check issues
        assert!(buffer.contains("Line 5: Trailing spaces found"));
        assert!(buffer.contains("Missing newline at end of file"));
        assert!(buffer.contains("Multiple newlines at end of file"));

        // Check summary
        assert!(buffer.contains("✗ Found 3 issues in 2 files"));
        assert!(buffer.contains("Files checked: 3"));
    }

    #[test]
    fn test_human_reporter_with_color() {
        let reporter = HumanReporter::with_color();
        let mut output = MockOutput::new();
        let results = create_test_results();

        reporter.report_to(&results, &mut output).unwrap();

        // For now, MockOutput doesn't implement ColoredOutput,
        // so we should still get plain output
        let buffer = output.get_output();
        assert!(buffer.contains("✗ test1.txt"));
        assert!(buffer.contains("✗ Found 3 issues in 2 files"));
    }

    #[test]
    fn test_human_reporter_legacy_interface() {
        let reporter = HumanReporter::new();
        let results = create_test_results();

        // This should not panic
        reporter.report(&results);
    }

    #[test]
    fn test_human_reporter_empty_results() {
        let reporter = HumanReporter::new();
        let mut output = MockOutput::new();
        let results = vec![];

        reporter.report_to(&results, &mut output).unwrap();

        let buffer = output.get_output();
        assert!(buffer.contains("✓ All files passed lint checks!"));
        assert!(buffer.contains("Files checked: 0"));
    }

    #[test]
    fn test_human_reporter_single_issue() {
        let reporter = HumanReporter::new();
        let mut output = MockOutput::new();
        let results = vec![CheckResult {
            file_path: PathBuf::from("single.txt"),
            issues: vec![Issue {
                issue_type: IssueType::TrailingSpace,
                line: Some(10),
                message: "Trailing spaces found".to_string(),
            }],
            error: None,
        }];

        reporter.report_to(&results, &mut output).unwrap();

        let buffer = output.get_output();
        assert!(buffer.contains("✗ single.txt"));
        assert!(buffer.contains("Line 10: Trailing spaces found"));
        assert!(buffer.contains("✗ Found 1 issues in 1 files"));
    }

    #[test]
    fn test_human_reporter_default() {
        let reporter = HumanReporter::default();
        assert!(!reporter.use_color);
    }

    #[test]
    fn test_human_reporter_report_to_colored_with_issues() {
        let reporter = HumanReporter::new();
        let mut output = MockOutput::new();
        let results = create_test_results();

        reporter.report_to_colored(&results, &mut output).unwrap();

        // Note: report_to_colored doesn't actually use colors in current implementation
        // It just outputs to ColoredOutput trait object
        let output_str = output.get_output();
        assert!(output_str.contains("test1.txt"));
        assert!(output_str.contains("Trailing spaces found"));
    }

    #[test]
    fn test_human_reporter_report_to_colored_no_issues() {
        let reporter = HumanReporter::new();
        let mut output = MockOutput::new();
        let results = vec![
            CheckResult {
                file_path: PathBuf::from("clean1.txt"),
                issues: vec![],
                error: None,
            },
            CheckResult {
                file_path: PathBuf::from("clean2.txt"),
                issues: vec![],
                error: None,
            },
        ];

        reporter.report_to_colored(&results, &mut output).unwrap();

        // Note: report_to_colored doesn't actually use colors in current implementation
        let output_str = output.get_output();
        assert!(output_str.contains("All files passed lint checks!"));
    }

    #[test]
    fn test_human_reporter_legacy_with_color() {
        let reporter = HumanReporter { use_color: true };
        let results = create_test_results();

        // This should not panic and should use colored output
        reporter.report(&results);
    }

    #[test]
    fn test_human_reporter_multiple_files_no_issues() {
        let reporter = HumanReporter::new();
        let mut output = MockOutput::new();
        let results = vec![
            CheckResult {
                file_path: PathBuf::from("file1.txt"),
                issues: vec![],
                error: None,
            },
            CheckResult {
                file_path: PathBuf::from("file2.txt"),
                issues: vec![],
                error: None,
            },
            CheckResult {
                file_path: PathBuf::from("file3.txt"),
                issues: vec![],
                error: None,
            },
        ];

        reporter.report_to(&results, &mut output).unwrap();

        let output_str = output.get_output();
        assert!(output_str.contains("✓ All files passed lint checks!"));
        assert!(output_str.contains("Files checked: 3"));
    }
}