Add exclude option in selene.toml

CHANGELOG.md

@@ -3,6 +3,9 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased](https://github.com/Kampfkarren/selene/compare/0.21.0...HEAD)
 
+### Added
+- Added exclude option to selene.toml for excluding files from lints
+
 ## [0.21.1](https://github.com/Kampfkarren/selene/releases/tag/0.21.0) - 2022-09-19
 ### Fixed
 - Fixed not being able to use projects without selene.toml.

docs/src/usage/configuration.md

@@ -62,3 +62,10 @@ For example, if we had `game.toml` and `engine.toml` standard libraries, we coul
 ```toml
 std = "game+engine"
 ```
+
+### Excluding files from being linted
+It is possible to exclude files from being linted using the exclude option:
+
+```toml
+exclude = ["external/*", "*.spec.lua"]
+```

selene-lib/src/lib.rs

@@ -65,6 +65,7 @@ pub struct CheckerConfig<V> {
     pub config: HashMap<String, V>,
     pub rules: HashMap<String, RuleVariation>,
     pub std: Option<String>,
+    pub exclude: Vec<String>,
 
     // Not locked behind Roblox feature so that selene.toml for Roblox will
     // run even without it.
@@ -83,6 +84,8 @@ impl<V> Default for CheckerConfig<V> {
             config: HashMap::new(),
             rules: HashMap::new(),
             std: None,
+            exclude: Vec::new(),
+
             roblox_std_source: RobloxStdSource::default(),
         }
     }

selene/Cargo.toml

@@ -20,6 +20,7 @@ color-eyre = "0.6.1"
 dirs = "4.0.0"
 full_moon = "0.15.1"
 glob = "0.3"
+globset = "0.4.9"
 lazy_static = "1.4"
 num_cpus = "1.10"
 profiling = { version = "1.0.6" }

selene/src/main.rs

@@ -469,6 +469,25 @@ fn start(mut matches: opts::Options) {
             }
         };
 
+    let mut builder = globset::GlobSetBuilder::new();
+    for pattern in &config.exclude {
+        builder.add(match globset::Glob::new(pattern) {
+            Ok(glob) => glob,
+            Err(error) => {
+                error!("Invalid glob pattern: {error}");
+                return;
+            }
+        });
+    }
+
+    let exclude_set = match builder.build() {
+        Ok(globset) => globset,
+        Err(error) => {
+            error!("{error}");
+            return;
+        }
+    };
+
     let checker = Arc::new(match Checker::new(config, standard_library) {
         Ok(checker) => checker,
         Err(error) => {
@@ -510,6 +529,10 @@ fn start(mut matches: opts::Options) {
                         for entry in glob {
                             match entry {
                                 Ok(path) => {
+                                    if exclude_set.is_match(&path) {
+                                        continue;
+                                    }
+
                                     let checker = Arc::clone(&checker);
 
                                     pool.execute(move || read_file(&checker, &path));