Skip to main content

Config

Struct Config 

Source
pub struct Config {
Show 20 fields pub languages: HashSet<String>, pub includes: Vec<String>, pub excludes: Vec<String>, pub max_complexity: Option<u32>, pub preset: Option<String>, pub verbose: Option<bool>, pub source: Option<SourceConfig>, pub language_overrides: LanguageOverrides, pub plugins: Option<PluginConfig>, pub plugin_auto_sync: Option<AutoSyncConfig>, pub self_auto_update: Option<SelfUpdateConfig>, pub tool_auto_install: Option<ToolAutoInstallConfig>, pub performance: PerformanceConfig, pub hook: HookConfig, pub cmsg: CmsgConfig, pub rules: RulesConfig, pub ai: AiConfig, pub review: ReviewConfig, pub retention: RetentionConfig, pub checks: ChecksConfig,
}
Expand description

Main configuration structure for linthis.

Contains all configuration options for controlling lint behavior, formatting, language-specific settings, and plugin configuration.

§Example

use linthis::config::Config;
use std::path::Path;

// Load from project directory
let config = Config::load_merged(Path::new("."));

// Access configuration values
println!("Max complexity: {:?}", config.max_complexity);
println!("Excluded patterns: {:?}", config.excludes);

Fields§

§languages: HashSet<String>

Languages to check (empty = auto-detect)

§includes: Vec<String>

Paths/patterns to include (glob patterns)

§excludes: Vec<String>

Paths/patterns to exclude (glob patterns)

§max_complexity: Option<u32>

Maximum cyclomatic complexity allowed

§preset: Option<String>

Format preset to use (google, standard, airbnb)

§verbose: Option<bool>

Verbose output

§source: Option<SourceConfig>

Source configuration (compatible with CodeCC .code.yml)

§language_overrides: LanguageOverrides

Language-specific overrides (flattened to root level)

§plugins: Option<PluginConfig>

Plugin configuration

§plugin_auto_sync: Option<AutoSyncConfig>

Plugin auto-sync configuration

§self_auto_update: Option<SelfUpdateConfig>

Self auto-update configuration

§tool_auto_install: Option<ToolAutoInstallConfig>

Tool auto-install configuration

§performance: PerformanceConfig

Performance settings

§hook: HookConfig

Hook settings

§cmsg: CmsgConfig

Commit message validation settings

§rules: RulesConfig

Custom rules, rule disable, and severity overrides

§ai: AiConfig

AI configuration for fix suggestions

§review: ReviewConfig

Code review settings

§retention: RetentionConfig

Retention settings for results, backups, reviews, and cache

§checks: ChecksConfig

Checks configuration: which checks to run and per-check settings.

[checks]
run = ["lint"]                    # default: only lint
# run = ["lint", "security", "complexity"]  # enable all

[checks.security]
scan_type = "sast"
fail_on = "high"

[checks.complexity]
threshold = 15

Implementations§

Source§

impl Config

Source

pub fn new() -> Self

Create a new empty configuration

Source

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

Load configuration from a file

Source

pub fn built_in_defaults() -> Self

Load built-in default configuration

Source

pub fn load_user_config() -> Option<Self>

Load user-level configuration from ~/.linthis/config.toml

Source

pub fn load_project_config(start_dir: &Path) -> Option<Self>

Load project-level configuration from the given directory Searches for .linthis/config.toml in the start directory and parent directories

Source

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

Merge another configuration into this one. Values from other override values in self.

Source

pub fn get_plugin_sources(&self) -> Vec<PluginSource>

Get plugin sources from config, converting to PluginSource type

Source

pub fn load_merged(project_dir: &Path) -> Self

Load and merge configuration from all sources with proper precedence.

Priority chain (lowest to highest): built-in defaults → global plugin linthis.toml (from plugins in ~/.linthis/config.toml) → project plugin linthis.toml (from plugins in .linthis/config.toml) → ~/.linthis/config.toml (user config — overrides plugin) → .linthis/config.toml (project config — highest)

Source

pub fn get_active_config_paths(project_dir: &Path) -> Vec<PathBuf>

Return the ordered list of config file paths that are actually loaded by [load_merged], from lowest to highest priority.

Only paths that exist on disk are included. Built-in defaults have no file path and are therefore not listed.

Source

pub fn generate_default_toml() -> String

Generate a default configuration file content

Source

pub fn project_config_path(project_dir: &Path) -> PathBuf

Get the path for a new project config file

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
Source§

impl Default for Config

Source§

fn default() -> Config

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Config

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Config

Source§

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

Serialize this value into the given Serde serializer. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,