Struct git_checks::config::ValidNameConfig

pub struct ValidNameConfig { /* fields omitted */ }

Configuration for the ValidName check.

The full_name_policy key is a string which must be one of "optional", "preferred", or "required" (the default). The whitelisted_domains is a list of strings which defaults to empty for domains which are assumed to be valid in email addresses. This should contain addresses which are common to the project being watched to avoid false positives when DNS lookup failures occur.

This check is registered as a commit check with the name "valid_name".

Example

{
    "full_name_policy": "required",
    "whitelisted_domains": [
        "mycompany.invalid"
    ]
}

Trait Implementations

impl Debug for ValidNameConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ValidNameConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl IntoCheck for ValidNameConfig

type Check = ValidName

The check parsed by this configuration.

fn into_check(self) -> Self::Check

Create a new instance of the check from the configuration.