Struct CodeOwners 

pub struct CodeOwners {
    pub section_style: Option<SectionStyle>,
    pub header: Option<String>,
    pub rules: Vec<Rule>,
}

CODEOWNERS file configuration and generator.

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

Example

use cuenv_codeowners::{CodeOwners, SectionStyle, Rule};

let codeowners = CodeOwners::builder()
    .section_style(SectionStyle::Comment)
    .header("Custom header comment")
    .rule(Rule::new("*", ["@org/maintainers"]))
    .rule(Rule::new("*.rs", ["@rust-team"]))
    .build();

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

Fields

section_style: Option<SectionStyle>

Section formatting style.

header: Option<String>

Custom header comment for the file.

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"));

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