Struct Linter 

pub struct Linter { /* private fields */ }

Implementations

impl Linter

pub fn new( settings: Settings, interner: ThreadedInterner, codebase: CodebaseReflection, ) -> Self

Creates a new linter.

This method will create a new linter with the given settings and interner.

Parameters

• settings: The settings to use for the linter.
• interner: The interner to use for the linter, usually the same one used by the parser, and the module.
• codebase: The codebase reflection to use for the linter.

Returns

A new linter.

pub fn with_all_plugins( settings: Settings, interner: ThreadedInterner, codebase: CodebaseReflection, ) -> Self

Creates a new linter with all plugins enabled.

This method will create a new linter with all plugins enabled. This is useful for when you want to lint a source with all available rules.

Parameters

• settings: The settings to use for the linter.
• interner: The interner to use for the linter, usually the same one used by the parser, and the module.
• codebase: The codebase reflection to use for the linter.

Returns

A new linter with all plugins enabled.

pub fn add_plugin(&mut self, plugin: impl Plugin)

Adds a plugin to the linter.

This method will add a plugin to the linter. The plugin will be enabled if it is enabled in the settings. If the plugin is not enabled in the settings, it will only be enabled if it is a default plugin.

Parameters

• plugin: The plugin to add to the linter.

pub fn add_rule(&mut self, plugin_slug: impl Into<String>, rule: Box<dyn Rule>)

Adds a rule to the linter.

This method will add a rule to the linter. The rule will be enabled if it is enabled in the settings.

Parameters

• plugin_slug: The slug of the plugin that the rule belongs to.
• rule: The rule to add to the linter.

pub fn get_configured_rules(&self) -> RwLockReadGuard<'_, Vec<ConfiguredRule>>

Returns a read lock for the vector of ConfiguredRule instances maintained by the linter.

This method provides direct, read-only access to all currently configured rules. You can iterate over them or inspect their fields (e.g., slug, level, etc.).

Panics

If the underlying RwLock is poisoned (e.g. another thread panicked while holding the lock), this method will panic with "Unable to get rule: poisoned lock".

pub fn get_rule_level(&self, slug: &str) -> Option<Level>

Retrieves the level of a rule by its fully qualified slug.

This method looks up a configured rule by its slug (e.g., "plugin-slug/rule-slug") and returns the rule’s current level (e.g., Level::Warning).

Parameters

• slug: The fully qualified slug of the rule (e.g. "best-practices/excessive-nesting").

Returns

An Option<Level>. Returns Some(Level) if the slug is found among the currently configured rules, or None if no matching rule is found.

pub fn lint(&self, module: &Module) -> IssueCollection

Lints the given module.

This method will lint the given module and return a collection of issues.

Parameters

• module: The module to lint.

Returns

A collection of issues.

Trait Implementations

impl Clone for Linter

fn clone(&self) -> Linter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Linter

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

Formats the value using the given formatter.