Struct rslint_cli::ExplanationRunner

pub struct ExplanationRunner {
    pub rules: Vec<String>,
    pub rule_names: Vec<String>,
}

A structure for converting user facing markdown docs to ANSI colored terminal explanations.

Fields

rules: Vec<String>

rule_names: Vec<String>

Implementations

impl ExplanationRunner

pub fn new(rules: Vec<String>) -> Self

Make a new runner and try to fetch the remote docs files for each rule. This automatically issues any linter errors for invalid rules.

pub fn replace_headers(&mut self)

pub fn replace_code_blocks(&mut self)

pub fn strip_config_or_extra_examples(&mut self)

pub fn replace_inline_code_blocks(&mut self)

pub fn append_link_to_docs(&mut self)

pub fn render(&mut self)

pub fn print(self)

Trait Implementations

impl Clone for ExplanationRunner

fn clone(&self) -> ExplanationRunner

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExplanationRunner

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

Formats the value using the given formatter.

impl Eq for ExplanationRunner

impl Hash for ExplanationRunner

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<ExplanationRunner> for ExplanationRunner

fn eq(&self, other: &ExplanationRunner) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ExplanationRunner) -> bool

This method tests for !=.

impl StructuralEq for ExplanationRunner

impl StructuralPartialEq for ExplanationRunner