rslint_core 0.2.2

The core linter housing all of the rules for the rslint project
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

//! A rule store, which houses rule groups as well as individual rules.

use crate::groups::*;
use crate::CstRule;

/// A utility structure for housing CST rules for a linting run.
#[derive(Debug, Default, Clone)]
pub struct CstRuleStore {
    pub rules: Vec<Box<dyn CstRule>>,
}

impl CstRuleStore {
    pub fn new() -> Self {
        Self::default()
    }

    /// All built in rules from every group.
    pub fn builtins(mut self) -> Self {
        self.rules.extend(errors());
        self
    }

    /// Load a list of rules into this store.
    pub fn load_rules(&mut self, rules: impl IntoIterator<Item = Box<dyn CstRule>>) {
        self.rules.extend(rules);
    }

    /// Get a rule using its rule name from this store.
    ///
    /// # Examples
    /// ```
    /// use rslint_core::CstRuleStore;
    ///
    /// assert!(CstRuleStore::new().builtins().get("no-empty").is_some())
    /// ```
    pub fn get(&self, rule_name: impl AsRef<str>) -> Option<Box<dyn CstRule>> {
        self.rules
            .iter()
            .find(|rule| rule.name() == rule_name.as_ref())
            .cloned()
    }
}