Struct Context

pub struct Context<'a> { /* private fields */ }

Context stores all data needed to perform linting of a particular file.

Implementations

impl<'a> Context<'a>

pub fn specifier(&self) -> &ModuleSpecifier

File specifier on which the lint rule is run.

pub fn media_type(&self) -> MediaType

The media type which linter was configured with. Can be used to skip checking some rules.

pub fn comments(&self) -> &MultiThreadedComments

Comment collection.

pub fn diagnostics(&self) -> &[LintDiagnostic]

Stores diagnostics that are generated while linting

pub fn parsed_source(&self) -> &ParsedSource

Parsed source of the program.

pub fn text_info(&self) -> &SourceTextInfo

Information about the file text.

pub fn program(&self) -> Program<'a>

The AST view of the program, which for example can be used for getting comments

pub fn file_ignore_directive(&self) -> Option<&IgnoreDirective<File>>

File-level ignore directive (deno-lint-ignore-file)

pub fn line_ignore_directives(&self) -> &HashMap<usize, IgnoreDirective<Line>>

The map that stores line-level ignore directives (deno-lint-ignore). The key of the map is line number.

pub fn scope(&self) -> &Scope

Scope analysis result

pub fn control_flow(&self) -> &ControlFlow

Control-flow analysis result

pub fn jsx_factory(&self) -> Option<Rc<Box<Expr>>>

Get the JSX factory expression for this file, if one is specified (via pragma or using a default). If this file is not JSX, uses the automatic transform, or the default factory is not specified, this will return None.

pub fn jsx_fragment_factory(&self) -> Option<Rc<Box<Expr>>>

Get the JSX fragment factory expression for this file, if one is specified (via pragma or using a default). If this file is not JSX, uses the automatic transform, or the default factory is not specified, this will return None.

pub fn all_comments(&self) -> impl Iterator<Item = &'a Comment>

pub fn leading_comments_at( &self, start: SourcePos, ) -> impl Iterator<Item = &'a Comment>

pub fn trailing_comments_at( &self, end: SourcePos, ) -> impl Iterator<Item = &'a Comment>

pub fn add_diagnostic( &mut self, range: SourceRange, code: impl ToString, message: impl ToString, )

pub fn add_diagnostic_with_hint( &mut self, range: SourceRange, code: impl ToString, message: impl ToString, hint: impl ToString, )

pub fn add_diagnostic_with_fixes( &mut self, range: SourceRange, code: impl ToString, message: impl ToString, hint: Option<String>, fixes: Vec<LintFix>, )

pub fn add_diagnostic_details( &mut self, maybe_range: Option<LintDiagnosticRange>, details: LintDiagnosticDetails, )

pub fn add_external_diagnostics(&mut self, diagnostics: &[LintDiagnostic])

Add fully constructed diagnostics.

This function can be used by the “external linter” to provide its own diagnostics.