config file as yml

Author: perryqh

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "codeowners"
-version = "0.2.12"
+version = "0.2.13"
 edition = "2024"
 
 [profile.release]

Cargo.toml

@@ -25,8 +25,8 @@ pub struct Config {
     #[serde(default = "default_ignore_dirs")]
     pub ignore_dirs: Vec<String>,
 
-    #[serde(default = "default_skip_untracked_files_config_path")]
-    pub skip_untracked_files_config_path: String,
+    #[serde(default = "default_codeowners_override_config_file_path")]
+    pub codeowners_override_config_file_path: String,
 }
 
 #[allow(dead_code)]
@@ -63,8 +63,8 @@ fn vendored_gems_path() -> String {
     "vendored/".to_string()
 }
 
-fn default_skip_untracked_files_config_path() -> String {
-    ".codeowners-skip-untracked-files".to_string()
+fn default_codeowners_override_config_file_path() -> String {
+    ".codeowners.yml".to_string()
 }
 
 fn default_ignore_dirs() -> Vec<String> {

src/config.rs

@@ -303,7 +303,7 @@ mod tests {
             vendored_gems_path: vendored_path.to_string(),
             cache_directory: "tmp/cache/codeowners".to_string(),
             ignore_dirs: vec![],
-            skip_untracked_files_config_path: ".codeowners-skip-untracked-files".to_string(),
+            codeowners_override_config_file_path: ".codeowners.yml".to_string(),
         }
     }
 

src/ownership/for_file_fast.rs

@@ -8,6 +8,7 @@ use error_stack::{Report, Result, ResultExt};
 use fast_glob::glob_match;
 use ignore::{DirEntry, WalkBuilder, WalkParallel, WalkState};
 use rayon::iter::{IntoParallelIterator, ParallelIterator};
+use serde::Deserialize;
 use tracing::{instrument, warn};
 
 use crate::{
@@ -61,7 +62,7 @@ impl<'a> ProjectBuilder<'a> {
         // Prune traversal early: skip heavy and irrelevant directories
         let ignore_dirs = self.config.ignore_dirs.clone();
         let base_path = self.base_path.clone();
-        let untracked_files = if skip_untracked_files_config_path_exists(&self.base_path, &self.config.skip_untracked_files_config_path) {
+        let untracked_files = if should_skip_untracked_files(&self.base_path, &self.config.codeowners_override_config_file_path) {
             files::untracked_files(&base_path).unwrap_or_default()
         } else {
             vec![]
@@ -297,10 +298,27 @@ fn matches_globs(path: &Path, globs: &[String]) -> bool {
     }
 }
 
-// If skip_untracked_files_config_path exists, we skip untracked files. We don't do this be default because it's slow.
-fn skip_untracked_files_config_path_exists(base_path: &Path, skip_untracked_files_config_path: &str) -> bool {
-    let path = base_path.join(skip_untracked_files_config_path);
-    path.exists()
+fn should_skip_untracked_files(base_path: &Path, codeowners_override_config_file_path: &str) -> bool {
+    let path = base_path.join(codeowners_override_config_file_path);
+    if !path.exists() {
+        return false;
+    }
+    if let Ok(file) = File::open(path) {
+        #[derive(Deserialize)]
+        struct OverrideConfig {
+            #[serde(default)]
+            skip_untracked_files: bool,
+        }
+
+        let config: OverrideConfig = match serde_yaml::from_reader(file) {
+            Ok(cfg) => cfg,
+            Err(_) => return false,
+        };
+
+        return config.skip_untracked_files;
+    }
+
+    false
 }
 
 fn ruby_package_owner(path: &Path) -> Result<Option<String>, Error> {

src/project_builder.rs

@@ -21,8 +21,8 @@ fn test_skip_untracked_files() -> Result<(), Box<dyn Error>> {
         .assert()
         .failure();
 
-    let skip_untracked_files_config_path = project_root.join(".codeowners-skip-untracked-files");
-    fs::write(&skip_untracked_files_config_path, "true")?;
+    let skip_untracked_files_config_path = project_root.join(".codeowners.yml");
+    fs::write(&skip_untracked_files_config_path, "skip_untracked_files: true")?;
 
     // should succeed if skip_untracked_false is false
     Command::cargo_bin("codeowners")?
@@ -33,5 +33,15 @@ fn test_skip_untracked_files() -> Result<(), Box<dyn Error>> {
         .assert()
         .success();
 
+    // should fail if skip_untracked_false is false
+    fs::write(&skip_untracked_files_config_path, "skip_untracked_files: false")?;
+    Command::cargo_bin("codeowners")?
+        .arg("--project-root")
+        .arg(project_root)
+        .arg("--no-cache")
+        .arg("gv")
+        .assert()
+        .failure();
+
     Ok(())
 }