rrubocop 0.7.0

Fast RuboCop-compatible Ruby linter in Rust (tree-sitter). No Ruby for linting; ERB configs need ruby.
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

//! RuboCop gem `config/default.yml` as the lowest-priority base layer.

use std::collections::{HashMap, HashSet};
use std::path::{Path, PathBuf};

use serde_yml::Value;

use super::gem_path;
use super::parse::parse_config_layer;
use super::types::ConfigLayer;

/// Minimal AllCops.Exclude patterns matching rubocop's config/default.yml.
pub(crate) fn fallback_default_excludes() -> ConfigLayer {
    let mut layer = ConfigLayer::empty();
    layer.global_excludes = vec![
        "node_modules/**/*".to_string(),
        "tmp/**/*".to_string(),
        "vendor/**/*".to_string(),
        ".git/**/*".to_string(),
    ];
    layer
}

fn rubocop_gem_root(
    working_dir: &Path,
    gem_cache: Option<&HashMap<String, PathBuf>>,
) -> Option<PathBuf> {
    if let Some(path) = gem_cache.and_then(|c| c.get("rubocop")) {
        return Some(path.clone());
    }
    gem_path::resolve_gem_path("rubocop", working_dir).ok()
}

fn read_default_yml(gem_root: &Path, working_dir: &Path) -> Option<(PathBuf, String)> {
    let default_config = gem_root.join("config").join("default.yml");
    if !default_config.exists() {
        return None;
    }
    let contents = super::yaml_read::load_yaml_text(&default_config, working_dir).ok()?;
    Some((default_config, contents))
}

fn parse_default_yml(path: &Path, contents: &str) -> Option<Value> {
    match serde_yml::from_str(contents) {
        Ok(v) => Some(v),
        Err(e) => {
            eprintln!(
                "warning: failed to parse rubocop default config {}: {e}",
                path.display()
            );
            None
        }
    }
}

fn collect_known_cops(raw: &Value) -> HashSet<String> {
    let Value::Mapping(map) = raw else {
        return HashSet::new();
    };
    map.keys()
        .filter_map(|k| k.as_str())
        .filter(|k| k.contains('/'))
        .map(|k| k.to_string())
        .collect()
}

/// Load rubocop's `config/default.yml` as the base layer, or fallback excludes.
///
/// Also returns known cop names from the installed gem for version awareness.
pub(crate) fn try_load_rubocop_defaults(
    working_dir: &Path,
    gem_cache: Option<&HashMap<String, PathBuf>>,
) -> (ConfigLayer, HashSet<String>) {
    let Some(gem_root) = rubocop_gem_root(working_dir, gem_cache) else {
        return (fallback_default_excludes(), HashSet::new());
    };
    let Some((path, contents)) = read_default_yml(&gem_root, working_dir) else {
        return (fallback_default_excludes(), HashSet::new());
    };
    let Some(raw) = parse_default_yml(&path, &contents) else {
        return (fallback_default_excludes(), HashSet::new());
    };
    let known_cops = collect_known_cops(&raw);
    (parse_config_layer(&raw), known_cops)
}