Support executable_name in config and API

Cargo.toml

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

src/config.rs

@@ -25,6 +25,9 @@ pub struct Config {
 
     #[serde(default = "default_ignore_dirs")]
     pub ignore_dirs: Vec<String>,
+
+    #[serde(default = "default_executable_name")]
+    pub executable_name: String,
 }
 
 #[allow(dead_code)]
@@ -61,6 +64,10 @@ fn vendored_gems_path() -> String {
     "vendored/".to_string()
 }
 
+fn default_executable_name() -> String {
+    "codeowners".to_string()
+}
+
 fn default_ignore_dirs() -> Vec<String> {
     vec![
         ".cursor".to_owned(),
@@ -121,6 +128,40 @@ mod tests {
             vec!["frontend/**/node_modules/**/*", "frontend/**/__generated__/**/*"]
         );
         assert_eq!(config.vendored_gems_path, "vendored/");
+        assert_eq!(config.executable_name, "codeowners");
+        Ok(())
+    }
+
+    #[test]
+    fn test_parse_config_with_custom_executable_name() -> Result<(), Box<dyn Error>> {
+        let temp_dir = tempdir()?;
+        let config_path = temp_dir.path().join("config.yml");
+        let config_str = indoc! {"
+            ---
+            owned_globs:
+              - \"**/*.rb\"
+            executable_name: my-custom-codeowners
+        "};
+        fs::write(&config_path, config_str)?;
+        let config_file = File::open(&config_path)?;
+        let config: Config = serde_yaml::from_reader(config_file)?;
+        assert_eq!(config.executable_name, "my-custom-codeowners");
+        Ok(())
+    }
+
+    #[test]
+    fn test_executable_name_defaults_when_not_specified() -> Result<(), Box<dyn Error>> {
+        let temp_dir = tempdir()?;
+        let config_path = temp_dir.path().join("config.yml");
+        let config_str = indoc! {"
+            ---
+            owned_globs:
+              - \"**/*.rb\"
+        "};
+        fs::write(&config_path, config_str)?;
+        let config_file = File::open(&config_path)?;
+        let config: Config = serde_yaml::from_reader(config_file)?;
+        assert_eq!(config.executable_name, "codeowners");
         Ok(())
     }
 }

src/ownership.rs

@@ -123,6 +123,7 @@ impl Ownership {
             project: self.project.clone(),
             mappers: self.mappers(),
             file_generator: FileGenerator { mappers: self.mappers() },
+            executable_name: self.project.executable_name.clone(),
         };
 
         validator.validate()

src/ownership/file_owner_resolver.rs

@@ -293,6 +293,7 @@ mod tests {
             vendored_gems_path: vendored_path.to_string(),
             cache_directory: "tmp/cache/codeowners".to_string(),
             ignore_dirs: vec![],
+            executable_name: "codeowners".to_string(),
         }
     }
 

src/ownership/validator.rs

@@ -21,14 +21,15 @@ pub struct Validator {
     pub project: Arc<Project>,
     pub mappers: Vec<Box<dyn Mapper>>,
     pub file_generator: FileGenerator,
+    pub executable_name: String,
 }
 
 #[derive(Debug)]
 enum Error {
     InvalidTeam { name: String, path: PathBuf },
     FileWithoutOwner { path: PathBuf },
     FileWithMultipleOwners { path: PathBuf, owners: Vec<Owner> },
-    CodeownershipFileIsStale,
+    CodeownershipFileIsStale { executable_name: String },
 }
 
 #[derive(Debug)]
@@ -130,12 +131,16 @@ impl Validator {
         match self.project.get_codeowners_file() {
             Ok(current_file) => {
                 if generated_file != current_file {
-                    vec![Error::CodeownershipFileIsStale]
+                    vec![Error::CodeownershipFileIsStale {
+                        executable_name: self.executable_name.to_string(),
+                    }]
                 } else {
                     vec![]
                 }
             }
-            Err(_) => vec![Error::CodeownershipFileIsStale], // Treat any read error as stale file
+            Err(_) => vec![Error::CodeownershipFileIsStale {
+                executable_name: self.executable_name.to_string(),
+            }],
         }
     }
 
@@ -161,13 +166,13 @@ impl Validator {
 impl Error {
     pub fn category(&self) -> String {
         match self {
-            Error::FileWithoutOwner { path: _ } => "Some files are missing ownership".to_owned(),
-            Error::FileWithMultipleOwners { path: _, owners: _ } => "Code ownership should only be defined for each file in one way. The following files have declared ownership in multiple ways".to_owned(),
-            Error::CodeownershipFileIsStale => {
-                "CODEOWNERS out of date. Run `codeowners generate` to update the CODEOWNERS file".to_owned()
+                Error::FileWithoutOwner { path: _ } => "Some files are missing ownership".to_owned(),
+                Error::FileWithMultipleOwners { path: _, owners: _ } => "Code ownership should only be defined for each file in one way. The following files have declared ownership in multiple ways".to_owned(),
+                Error::CodeownershipFileIsStale { executable_name } => {
+                    format!("CODEOWNERS out of date. Run `{} generate` to update the CODEOWNERS file", executable_name)
+                }
+                Error::InvalidTeam { name: _, path: _ } => "Found invalid team annotations".to_owned(),
             }
-            Error::InvalidTeam { name: _, path: _ } => "Found invalid team annotations".to_owned(),
-        }
     }
 
     pub fn messages(&self) -> Vec<String> {
@@ -187,7 +192,7 @@ impl Error {
 
                 vec![messages.join("\n")]
             }
-            Error::CodeownershipFileIsStale => vec![],
+            Error::CodeownershipFileIsStale { executable_name: _ } => vec![],
             Error::InvalidTeam { name, path } => vec![format!("- {} is referencing an invalid team - '{}'", path.to_string_lossy(), name)],
         }
     }

src/project.rs

@@ -17,6 +17,7 @@ pub struct Project {
     pub codeowners_file_path: PathBuf,
     pub directory_codeowner_files: Vec<DirectoryCodeownersFile>,
     pub teams_by_name: HashMap<String, Team>,
+    pub executable_name: String,
 }
 
 #[derive(Clone, Debug)]
@@ -219,6 +220,7 @@ mod tests {
             codeowners_file_path: PathBuf::from(".github/CODEOWNERS"),
             directory_codeowner_files: vec![],
             teams_by_name: HashMap::new(),
+            executable_name: "codeowners".to_string(),
         };
 
         let map = project.vendored_gem_by_name();

src/project_builder.rs

@@ -294,6 +294,7 @@ impl<'a> ProjectBuilder<'a> {
             codeowners_file_path: self.codeowners_file_path.to_path_buf(),
             directory_codeowner_files: directory_codeowners,
             teams_by_name,
+            executable_name: self.config.executable_name.clone(),
         })
     }
 }

tests/custom_executable_name_test.rs

@@ -0,0 +1,32 @@
+use predicates::prelude::*;
+use std::error::Error;
+
+mod common;
+use common::OutputStream;
+use common::run_codeowners;
+
+#[test]
+fn test_validate_uses_custom_executable_name() -> Result<(), Box<dyn Error>> {
+    run_codeowners(
+        "custom_executable_name",
+        &["validate"],
+        false,
+        OutputStream::Stdout,
+        predicate::str::contains("CODEOWNERS out of date. Run `my-custom-tool generate` to update the CODEOWNERS file"),
+    )?;
+    Ok(())
+}
+
+#[test]
+fn test_validate_default_executable_name() -> Result<(), Box<dyn Error>> {
+    // This tests the invalid_project which doesn't specify executable_name
+    // and should use the default "codeowners"
+    run_codeowners(
+        "invalid_project",
+        &["validate"],
+        false,
+        OutputStream::Stdout,
+        predicate::str::contains("CODEOWNERS out of date. Run `codeowners generate` to update the CODEOWNERS file"),
+    )?;
+    Ok(())
+}

tests/fixtures/custom_executable_name/.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# This is a stale CODEOWNERS file - it's intentionally wrong to trigger the error
+ruby/app/payments/bar.rb @PaymentTeam
+

tests/fixtures/custom_executable_name/config/code_ownership.yml

@@ -0,0 +1,6 @@
+owned_globs:
+  - "**/*.rb"
+team_file_glob:
+  - config/teams/**/*.yml
+executable_name: my-custom-tool
+

tests/fixtures/custom_executable_name/config/teams/payments.yml

@@ -0,0 +1,6 @@
+name: Payments
+github:
+  team: "@PaymentTeam"
+owned_globs:
+  - ruby/app/payments/**
+

tests/fixtures/custom_executable_name/ruby/app/payments/foo.rb

@@ -0,0 +1,4 @@
+# A file owned by Payments
+class Foo
+end
+