Struct CodebookConfig

pub struct CodebookConfig {
    pub project_config_path: Option<PathBuf>,
    pub global_config_path: Option<PathBuf>,
    pub cache_dir: PathBuf,
    /* private fields */
}

Fields

project_config_path: Option<PathBuf>

Path to the project-specific config file

global_config_path: Option<PathBuf>

Path to the global config file

cache_dir: PathBuf

Directory for caching

Implementations

impl CodebookConfig

pub fn load(current_dir: Option<&Path>) -> Result<Self, Error>

Load configuration by searching for both global and project-specific configs

pub fn reload(&self) -> Result<bool, Error>

Reload both global and project configurations, only reading files if they’ve changed

pub fn add_word(&self, word: &str) -> Result<bool, Error>

Add a word to the project configs allowlist

pub fn add_word_global(&self, word: &str) -> Result<bool, Error>

Add a word to the global configs allowlist

pub fn add_ignore(&self, file: &str) -> Result<bool, Error>

Add a file to the ignore list

pub fn save(&self) -> Result<(), Error>

Save the project configuration to its file

pub fn save_global(&self) -> Result<(), Error>

Save the global configuration to its file

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

Get dictionary IDs from effective configuration

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

Check if a path should be ignored based on the effective configuration

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

Check if a word is in the effective allowlist

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

Check if a word should be flagged according to effective configuration

pub fn get_ignore_patterns(&self) -> Option<Vec<Regex>>

Get the list of user-defined ignore patterns

pub fn clean_cache(&self)

Clean the cache directory

Trait Implementations

impl Debug for CodebookConfig

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

Formats the value using the given formatter.

impl Default for CodebookConfig

fn default() -> Self

Returns the “default value” for a type.