Struct LintContext 

pub struct LintContext<'a> {
    pub source: &'a str,
    pub file_path: Option<&'a Path>,
    pub ast: &'a Block,
    pub engine_state: &'a EngineState,
    pub working_set: &'a StateWorkingSet<'a>,
}

Context containing all lint information (source, AST, and engine state) Rules can use whatever they need from this context

Fields

source: &'a str

file_path: Option<&'a Path>

ast: &'a Block

engine_state: &'a EngineState

working_set: &'a StateWorkingSet<'a>

Implementations

impl LintContext<'_>

pub fn violations_from_regex<MatchPredicate>( &self, pattern: &Regex, rule_id: &'static str, predicate: MatchPredicate, ) -> Vec<RuleViolation>

where MatchPredicate: Fn(Match<'_>) -> Option<(String, Option<String>)>,

Find violations by applying a conditional predicate to regex matches

pub fn collect_violations<F>(&self, collector: F) -> Vec<Violation>

where F: Fn(&Expression, &Self) -> Vec<Violation>,

Collect all violations using a closure over expressions (Traverse-based)

This method uses Nushell’s upstream Traverse trait to walk the AST and collect violations. The collector function is called for each expression in the AST and should return a vector of violations.

pub fn collect_rule_violations<F>(&self, collector: F) -> Vec<RuleViolation>

where F: Fn(&Expression, &Self) -> Vec<RuleViolation>,

Collect all rule violations using a closure over expressions (Traverse-based)

This method uses Nushell’s upstream Traverse trait to walk the AST and collect rule violations. The collector function is called for each expression in the AST and should return a vector of rule violations.

pub fn find_match<T, F>(&self, finder: F) -> Option<T>

where F: Fn(&Expression) -> FindMapResult<T>,

Find first match using find_map (Traverse-based)

This method uses Nushell’s upstream Traverse trait to search the AST for the first matching expression. The finder function should return FindMapResult::Found(value) to return a value, FindMapResult::Stop to stop searching, or FindMapResult::Continue to continue searching.

pub fn new_user_functions( &self, ) -> impl Iterator<Item = (usize, &dyn Command)> + '_

Iterator over newly added user-defined function declarations Filters out built-in functions (those with spaces or starting with ‘_’)

pub fn find_declaration_span(&self, name: &str) -> Span

Find the span of a function/declaration name in the source code Returns a span pointing to the first occurrence of the name, or a fallback span

pub fn new_decl_range(&self) -> (usize, usize)

Get the range of declaration IDs that were added during parsing (the delta) Returns (base_count, total_count) for iterating: base_count..total_count