Struct Config 

pub struct Config {
    pub include: Vec<String>,
    pub exclude: Vec<String>,
    pub interface: Option<InterfaceConfig>,
    pub parsers: HashMap<String, ParserConfig>,
    pub rules: HashMap<String, RuleConfig>,
    pub config_dir: Option<PathBuf>,
}

Fields

include: Vec<String>

Glob patterns declaring which filesystem paths become File nodes. Default: ["*.md"].

exclude: Vec<String>

Glob patterns removed from the graph (applied after include). Also respects .gitignore.

interface: Option<InterfaceConfig>

parsers: HashMap<String, ParserConfig>

rules: HashMap<String, RuleConfig>

config_dir: Option<PathBuf>

Directory containing the drft.toml this config was loaded from.

Implementations

impl Config

pub fn defaults() -> Self

pub fn load(root: &Path) -> Result<Self>

pub fn rule_severity(&self, name: &str) -> RuleSeverity

pub fn is_rule_in_scope(&self, rule: &str, path: &str) -> bool

Check if a path is in scope for a specific rule (passes files filter).

pub fn is_rule_ignored(&self, rule: &str, path: &str) -> bool

Check if a path should be ignored for a specific rule.

pub fn rule_options(&self, name: &str) -> Option<&Value>

Get a rule’s options (the [rules.<name>.options] section).

pub fn custom_rules(&self) -> impl Iterator<Item = (&str, &RuleConfig)>

Get custom rules (rules with a command field).

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.