Struct ShellCheckRule

pub struct ShellCheckRule { /* private fields */ }

Runs ShellCheck on a command section and reports diagnostics.

Trait Implementations

impl Clone for ShellCheckRule

fn clone(&self) -> ShellCheckRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShellCheckRule

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

Formats the value using the given formatter.

impl Default for ShellCheckRule

fn default() -> ShellCheckRule

Returns the “default value” for a type.

impl Rule for ShellCheckRule

fn id(&self) -> &'static str

The unique identifier for the lint rule.

fn description(&self) -> &'static str

A short, single sentence description of the lint rule.

fn explanation(&self) -> &'static str

Get the long-form explanation of the lint rule.

fn tags(&self) -> TagSet

Get the tags of the lint rule.

fn exceptable_nodes(&self) -> Option<&'static [SyntaxKind]>

Gets the nodes that are exceptable for this rule.

fn related_rules(&self) -> &[&'static str]

Gets the ID of rules that are related to this rule.

fn url(&self) -> Option<&'static str>

Gets the optional URL of the lint rule.

impl Visitor for ShellCheckRule

fn reset(&mut self)

Resets the visitor to its initial state.

fn document( &mut self, _: &mut Diagnostics, reason: VisitReason, document: &Document, _: SupportedVersion, )

Visits the root document node.

fn command_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &CommandSection, )

Visits a command section node.

fn whitespace(&mut self, diagnostics: &mut Diagnostics, whitespace: &Whitespace)

Visits a whitespace token.

fn comment(&mut self, diagnostics: &mut Diagnostics, comment: &Comment)

Visit a comment token.

fn version_statement( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, stmt: &VersionStatement, )

Visits a top-level version statement node.

fn import_statement( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, stmt: &ImportStatement, )

Visits a top-level import statement node.

fn struct_definition( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, def: &StructDefinition, )

Visits a struct definition node.

fn task_definition( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, task: &TaskDefinition, )

Visits a task definition node.

fn workflow_definition( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, workflow: &WorkflowDefinition, )

Visits a workflow definition node.

fn input_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &InputSection, )

Visits an input section node.

fn output_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &OutputSection, )

Visits an output section node.

fn command_text(&mut self, diagnostics: &mut Diagnostics, text: &CommandText)

Visits a command text token in a command section node.

fn requirements_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &RequirementsSection, )

Visits a requirements section node.

fn task_hints_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &TaskHintsSection, )

Visits a task hints section node.

fn workflow_hints_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &WorkflowHintsSection, )

Visits a workflow hints section node.

fn runtime_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &RuntimeSection, )

Visits a runtime section node.

fn runtime_item( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, item: &RuntimeItem, )

Visits a runtime item node.

fn metadata_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &MetadataSection, )

Visits a metadata section node.

fn parameter_metadata_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &ParameterMetadataSection, )

Visits a parameter metadata section node.

fn metadata_object( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, object: &MetadataObject, )

Visits a metadata object in a metadata or parameter metadata section.

fn metadata_object_item( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, item: &MetadataObjectItem, )

Visits a metadata object item in a metadata object.

fn metadata_array( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, item: &MetadataArray, )

Visits a metadata array node in a metadata or parameter metadata section.

fn unbound_decl( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, decl: &UnboundDecl, )

Visits an unbound declaration node.

fn bound_decl( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, decl: &BoundDecl, )

Visits a bound declaration node.

fn expr( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, expr: &Expr, )

Visits an expression node.

fn string_text(&mut self, diagnostics: &mut Diagnostics, text: &StringText)

Visits a string text token in a literal string node.

fn placeholder( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, placeholder: &Placeholder, )

Visits a placeholder node.

fn conditional_statement( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, stmt: &ConditionalStatement, )

Visits a conditional statement node in a workflow.

fn scatter_statement( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, stmt: &ScatterStatement, )

Visits a scatter statement node in a workflow.

fn call_statement( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, stmt: &CallStatement, )

Visits a call statement node in a workflow.