Struct Codeowners 

pub struct Codeowners {
    pub platform: Option<Platform>,
    pub path: Option<String>,
    pub header: Option<String>,
    pub default_owners: Option<Vec<String>>,
    pub rules: Vec<Rule>,
}

CODEOWNERS file configuration and generator.

Use Codeowners::builder() to create a new instance.

Example

use cuenv_codeowners::{Codeowners, Platform, Rule};

let codeowners = Codeowners::builder()
    .platform(Platform::Github)
    .header("Custom header comment")
    .default_owners(["@org/maintainers"])
    .rule(Rule::new("*.rs", ["@rust-team"]))
    .build();

println!("{}", codeowners.generate());

Fields

platform: Option<Platform>

Target platform for the CODEOWNERS file.

path: Option<String>

Custom output path override.

header: Option<String>

Custom header comment for the file.

default_owners: Option<Vec<String>>

Default owners applied to all files (* rule).

rules: Vec<Rule>

Ownership rules.

Implementations

impl Codeowners

pub fn builder() -> CodeownersBuilder

Create a new builder for constructing a Codeowners configuration.

Example

use cuenv_codeowners::Codeowners;

let codeowners = Codeowners::builder()
    .rule(cuenv_codeowners::Rule::new("*", ["@fallback-team"]))
    .build();

pub fn generate(&self) -> String

Generate the CODEOWNERS file content.

Example

use cuenv_codeowners::{Codeowners, Rule};

let codeowners = Codeowners::builder()
    .rule(Rule::new("*.rs", ["@rust-team"]))
    .build();

let content = codeowners.generate();
assert!(content.contains("*.rs @rust-team"));

pub fn output_path(&self) -> &str

Get the output path for the CODEOWNERS file.

Returns the custom path if set, otherwise the platform’s default path.

pub fn detect_platform(repo_root: &Path) -> Platform

Detect the platform from repository structure.

Checks for platform-specific files/directories:

• .github/ directory -> GitHub
• .gitlab-ci.yml file -> GitLab
• bitbucket-pipelines.yml file -> Bitbucket
• Falls back to GitHub if none detected

Example

use cuenv_codeowners::{Codeowners, Platform};
use std::path::Path;

let platform = Codeowners::detect_platform(Path::new("."));

Trait Implementations

impl Clone for Codeowners

fn clone(&self) -> Codeowners

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Codeowners

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Codeowners

fn default() -> Codeowners

Returns the “default value” for a type.

impl PartialEq for Codeowners

fn eq(&self, other: &Codeowners) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Codeowners

impl StructuralPartialEq for Codeowners