Struct Config 

#[non_exhaustive]
pub struct Config {
    pub format: FormatConfig,
    pub lint: LintConfig,
    pub excluded_dirs: Vec<String>,
    pub respect_gitignore: bool,
}

The full configuration for a run.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

format: FormatConfig

lint: LintConfig

excluded_dirs: Vec<String>

respect_gitignore: bool

Skip files a .gitignore covers.

On, because a .gd file git has been told to ignore is almost always something generated or vendored, and reporting on it is noise about code nobody is going to edit. A path named directly on the command line is still processed: naming a file is a stronger signal than a pattern.

Implementations

impl Config

pub fn is_excluded_dir(&self, name: &str) -> bool

Whether a directory name should be skipped when collecting files.

pub fn to_toml(&self) -> String

Write these settings out as a gdck.toml.

Every setting is written, including the ones left at their default, because the question this answers is what a run is actually using.

pub fn to_starter_toml(&self) -> String

Write these settings out as a gdck.toml for a project to keep.

Every setting appears, but the ones still at their default are commented out. The live lines are then what this project decided, and the commented ones are a catalogue to uncomment from — and a project inherits later changes to a default rather than pinning today’s value without meaning to.

This is what gdck init writes. to_toml is the other question — what a run is using — and answers it in full.

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 Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Config

impl PartialEq for Config

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Config