Skip to main content

Config

Struct Config 

Source
pub struct Config { /* private fields */ }
Expand description

Resolved project configuration. Construct with Config::load_explicit (for --config PATH) or Config::discover (for the ancestor walk from CWD).

Implementations§

Source§

impl Config

Source

pub fn load_explicit(path: &Path) -> Result<Self, ConfigError>

Load configuration from exactly path. Used for --config PATH.

§Errors

Returns ConfigError if the file is missing, unreadable, malformed TOML, or fails schema validation (an unknown key or a malformed value is an error, not a silent default).

Source

pub fn discover(cwd: &Path) -> Result<Self, ConfigError>

Discover the nearest applicable config by walking upward from cwd. At each directory, candidates are tried in precedence order: .mdwright.toml, then mdwright.toml, then pyproject.toml’s [tool.mdwright] table (a pyproject.toml without that table does not stop the walk). The walk stops at the filesystem root or the first directory containing a .git/ entry (the workspace boundary).

Returns the all-defaults instance if no candidate is found. Absence of a config file is not an error.

§Errors

Returns ConfigError if a candidate file is found but cannot be read, parsed as TOML, or matched against the schema.

Source

pub fn source(&self) -> Option<&Path>

Path of the configuration file this Config was loaded from, or None if no file was used (the defaults instance).

Source

pub fn source_dir(&self) -> Option<&Path>

Directory containing the configuration file, useful as the base for resolving relative paths inside the config (e.g. [lint] exclude globs). None when no file was loaded; in that case callers typically use $PWD as the base.

Source

pub fn lint_rule_selection(&self) -> &LintRuleSelection

Resolved lint rule selection from [lint].

Source

pub fn exclude_globs(&self) -> &[String]

Gitignore-style patterns from [lint] exclude. Files matching any pattern are dropped from lint runs.

Source

pub fn extra_info_strings(&self) -> &[String]

Project-specific allowlist extension for info-string-typo. The stdlib default still applies; these are additions.

Source

pub fn fmt_options(&self) -> &FmtOptions

Resolved formatter knobs from [fmt]. Formatter sessions are the first consumers; the lint side ignores these.

Source

pub fn parse_options(&self) -> ParseOptions

Resolved Markdown recognition policy.

Source

pub fn render_options(&self) -> RenderOptions

Resolved HTML rendering policy.

Source

pub fn defaults() -> Self

The all-defaults Config — what Self::discover returns when no .mdwright.toml / mdwright.toml / pyproject.toml is found on the upward walk. Exposed for long-lived processes (the LSP server) that need a synchronous fallback when discover encounters an unreadable config file mid-walk.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more