Enum LintCheck 

pub enum LintCheck {
    CodeResultsSubdirPairing,
    CodeResultsSubdirRegex,
    CodeSubdirReadmes,
    CodeSubdirWorkflows,
    DataSubdirReadmes,
    RootDirs,
    RootFiles,
}

The linting checks that are currently supported.

Lint codes available in a configuration file are snake_case versions of the enum names here.

Variants

CodeResultsSubdirPairing

Check that every subdirectory within the project’s code directory has a corresponding subdirectory with the same name in the results directory, and vice versa.

CodeResultsSubdirRegex

All subdirectories within the project’s code and results directory should have names that match the regular expression in code_results_subdir_regex.

CodeSubdirReadmes

Each subdirectory within the project’s code directory should contain a README file.

CodeSubdirWorkflows

Each subdirectory within the project’s code directory should contain a workflow file.

DataSubdirReadmes

Each subdirectory within the project’s data directory should contain a README file.

RootDirs

Check for a set of required directories that should be present in the project’s root directory.

RootFiles

Check for a set of required files that should be present in the project’s root directory.

Implementations

impl LintCheck

pub fn check(self, cfg: &InstantiatedConfig) -> Result<(), LintError>

Execute a lint check.

This is effectively a large match statement that dispatches the relevant checks to other functions.

Trait Implementations

impl Clone for LintCheck

fn clone(&self) -> LintCheck

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LintCheck

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

Formats the value using the given formatter.

impl Display for LintCheck

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

Formats the value using the given formatter.

impl FromStr for LintCheck

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<LintCheck, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl IntoEnumIterator for LintCheck

type Iterator = LintCheckIter

fn iter() -> LintCheckIter

impl TryFrom<&str> for LintCheck

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<LintCheck, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for LintCheck