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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

//! Naming/FileName — path basenames should be snake_case.

use std::path::Path;

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

pub struct FileName;

const ALLOWED: &[&str] = &[
    "Gemfile",
    "Rakefile",
    "Capfile",
    "Vagrantfile",
    "Guardfile",
    "Procfile",
];

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

    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>>,
    ) {
        let Some(file_name) = bad_filename(source.path_str()) else {
            return;
        };
        diagnostics.push(self.diagnostic(
            source,
            1,
            0,
            format!("The file name `{file_name}` should use snake_case."),
        ));
    }
}

fn bad_filename(path_str: &str) -> Option<&str> {
    let path = Path::new(path_str);
    let file_name = path.file_name()?.to_str()?;
    if ALLOWED.contains(&file_name) {
        return None;
    }
    path.file_stem()
        .and_then(|s| s.to_str())
        .unwrap_or(file_name)
        .split('.')
        .any(|seg| !is_filename_snake_case(seg))
        .then_some(file_name)
}

fn is_filename_snake_case(segment: &str) -> bool {
    segment.chars().all(|ch| {
        if ch.is_ascii() {
            ch.is_ascii_lowercase() || ch.is_ascii_digit() || matches!(ch, '_' | '?' | '!')
        } else {
            ch.is_lowercase()
        }
    })
}