rrubocop 0.8.15

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

//! Style/MagicCommentFormat — breadth-first tree-sitter port.

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

pub struct MagicCommentFormat;

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

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

    fn check_lines(
        &self,
        source: &SourceFile,
        _config: &CopConfig,
        diagnostics: &mut Vec<Diagnostic>,
        _corrections: Option<&mut Vec<crate::correction::Correction>>,
    ) {
        for (idx, line) in source.lines().enumerate().take(5) {
            if bad_magic_case(line) {
                let (line_n, col) =
                    source.offset_to_line_col(source.line_start(idx + 1).unwrap_or(0));
                diagnostics.push(self.diagnostic(
                    source,
                    line_n,
                    col,
                    "Use snake_case for magic comment keys.".to_string(),
                ));
            }
        }
    }
}

fn bad_magic_case(line: &[u8]) -> bool {
    let t = String::from_utf8_lossy(line);
    let lower = t.to_ascii_lowercase();
    let is_magic = lower.contains("frozen_string_literal")
        || lower.contains("encoding")
        || lower.contains("coding:");
    is_magic && (t.contains("frozenStringLiteral") || t.contains("FrozenStringLiteral"))
}