Struct ConfigSettings 

pub struct ConfigSettings {
    pub dictionaries: Vec<String>,
    pub words: Vec<String>,
    pub flag_words: Vec<String>,
    pub include_paths: Vec<String>,
    pub ignore_paths: Vec<String>,
    pub ignore_patterns: Vec<String>,
    pub use_global: bool,
    pub min_word_length: usize,
    pub include_tags: Vec<String>,
    pub exclude_tags: Vec<String>,
}

Fields

dictionaries: Vec<String>

List of dictionaries to use for spell checking

words: Vec<String>

Custom allowlist of words

flag_words: Vec<String>

Words that should always be flagged

include_paths: Vec<String>

Glob patterns for paths to include

ignore_paths: Vec<String>

Glob patterns for paths to ignore

ignore_patterns: Vec<String>

Regex patterns for text to ignore

use_global: bool

Whether to use global configuration

min_word_length: usize

Minimum word length to check (words shorter than this are ignored)

include_tags: Vec<String>

Tag prefixes to include (if non-empty, only matching tags are checked)

exclude_tags: Vec<String>

Tag prefixes to exclude (takes precedence over include_tags)

Implementations

impl ConfigSettings

pub fn merge(&mut self, other: ConfigSettings)

Merge another config settings into this one, sorting and deduplicating all collections

pub fn sort_and_dedup(&mut self)

Sort and deduplicate all collections in the config

impl ConfigSettings

pub fn should_check_tag(&self, tag: &str) -> bool

Determine whether a capture tag should be spell-checked based on include_tags and exclude_tags. exclude_tags takes precedence.

pub fn insert_word(&mut self, word: &str) -> bool

Insert a word into the allowlist, returning true when it was newly added.

pub fn insert_ignore(&mut self, file: &str) -> bool

Insert a path into the ignore list, returning true when it was newly added.

pub fn insert_include(&mut self, file: &str) -> bool

Insert a path into the include list, returning true when it was newly added.

pub fn dictionary_ids(&self) -> Vec<String>

Resolve configured dictionary IDs, providing a default when none are set.

pub fn should_include_path(&self, path: &Path) -> bool

Determine whether a path should be included based on the configured glob patterns.

pub fn should_ignore_path(&self, path: &Path) -> bool

Determine whether a path should be ignored based on the configured glob patterns.

pub fn is_allowed_word(&self, word: &str) -> bool

Check if a word is explicitly allowed.

pub fn should_flag_word(&self, word: &str) -> bool

Check if a word should be flagged.

pub fn min_word_length(&self) -> usize

Retrieve the configured minimum word length.

Trait Implementations

impl Clone for ConfigSettings

fn clone(&self) -> ConfigSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigSettings

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

Formats the value using the given formatter.

impl Default for ConfigSettings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ConfigSettings

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ConfigSettings

fn eq(&self, other: &ConfigSettings) -> 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 Serialize for ConfigSettings

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ConfigSettings