Struct Linter

pub struct Linter { /* private fields */ }

Implementations

impl Linter

pub fn new( config: FluffConfig, formatter: Option<Arc<dyn Formatter>>, templater: Option<&'static dyn Templater>, include_parse_errors: bool, ) -> Linter

pub fn lint_string_wrapped( &mut self, sql: &str, filename: Option<String>, fix: bool, ) -> LintingResult

Lint strings directly.

pub fn parse_string( &self, tables: &Tables, sql: &str, filename: Option<String>, ) -> Result<ParsedString, SQLFluffUserError>

Parse a string.

pub fn lint_string( &self, sql: &str, filename: Option<String>, fix: bool, ) -> LintedFile

Lint a string.

pub fn lint_paths( &mut self, paths: Vec<PathBuf>, fix: bool, ignorer: &(dyn Fn(&Path) -> bool + Send + Sync), ) -> LintingResult

ignorer is an optional argument that takes in a function that returns a bool based on the path passed to it. If the function returns true, the path is ignored.

pub fn get_rulepack(&self) -> RulePack

pub fn render_file(&self, fname: String) -> RenderedFile

pub fn lint_rendered(&self, rendered: RenderedFile, fix: bool) -> LintedFile

pub fn lint_parsed( &self, tables: &Tables, parsed_string: ParsedString, fix: bool, ) -> LintedFile

pub fn lint_fix_parsed( &self, tables: &Tables, tree: ErasedSegment, templated_file: &TemplatedFile, fix: bool, ) -> (ErasedSegment, Option<IgnoreMask>, Vec<SQLLintError>)

pub fn render_string( &self, sql: &str, filename: String, config: &FluffConfig, ) -> Result<RenderedFile, SQLFluffUserError>

Template the file.

pub fn parse_rendered( &self, tables: &Tables, rendered: RenderedFile, ) -> ParsedString

Parse a rendered file.

pub fn lex_templated_file( tables: &Tables, templated_file: TemplatedFile, dialect: &Dialect, ) -> (Option<Vec<ErasedSegment>>, Vec<SQLLexError>)

Lex a templated file.

pub fn config(&self) -> &FluffConfig

pub fn config_mut(&mut self) -> &mut FluffConfig

pub fn rules(&self) -> &[ErasedRule]

pub fn formatter(&self) -> Option<&Arc<dyn Formatter>>

pub fn formatter_mut(&mut self) -> Option<&mut Arc<dyn Formatter>>