rrubocop 0.7.5

10x faster RuboCop drop-in. Same output format and configs, without maintaining RuboCop gems.
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

use crate::cop::{Cop, CopConfig};
use crate::diagnostic::{Diagnostic, Severity};
use crate::parse::codemap::CodeMap;
use crate::parse::source::SourceFile;

/// Lint/OrderedMagicComments — encoding before other magic comments.
pub struct OrderedMagicComments;

fn is_encoding(line: &str) -> bool {
    let lower = line.to_ascii_lowercase();
    lower.contains("encoding:") || lower.contains("coding:") || lower.contains("encoding =")
}

fn is_other_magic(line: &str) -> bool {
    let lower = line.to_ascii_lowercase();
    lower.contains("frozen_string_literal") || lower.contains("shareable_constant_value")
}

fn first_disorder(source: &SourceFile) -> Option<usize> {
    let mut encoding_seen = false;
    let mut other_line = None;
    for (i, line) in source.lines().enumerate() {
        let s = String::from_utf8_lossy(line);
        let t = s.trim();
        if t.is_empty() {
            continue;
        }
        if !t.starts_with('#') {
            break;
        }
        if is_encoding(t) {
            encoding_seen = true;
            if let Some(line_no) = other_line {
                return Some(line_no);
            }
        } else if is_other_magic(t) && !encoding_seen {
            other_line = Some(i + 1);
        }
    }
    None
}

impl Cop for OrderedMagicComments {
    fn name(&self) -> &'static str {
        "Lint/OrderedMagicComments"
    }

    fn default_severity(&self) -> Severity {
        Severity::Warning
    }

    fn uses_source_phase(&self) -> bool {
        true
    }

    fn check_source(
        &self,
        source: &SourceFile,
        _tree: &tree_sitter::Tree,
        _code_map: &CodeMap,
        _config: &CopConfig,
        diagnostics: &mut Vec<Diagnostic>,
        _corrections: Option<&mut Vec<crate::correction::Correction>>,
    ) {
        let Some(line) = first_disorder(source) else {
            return;
        };
        diagnostics.push(self.diagnostic(
            source,
            line,
            0,
            "The encoding magic comment should precede all other magic comments.".to_string(),
        ));
    }
}