Struct CheckCmd

pub struct CheckCmd { /* private fields */ }

Implementation of the main check command of the cli.

Implementations

impl CheckCmd

pub fn new(schema: Schema) -> Self

Create a new instance of the check command

pub fn global_result(hs: HashSet<CheckResult>) -> bool

Return true if all checks were OK, false otherwise.

pub fn run( config: &PRDocConfig, schema: Option<PathBuf>, dir: &PathBuf, file: Option<PathBuf>, numbers: Option<Vec<PRNumber>>, list: Option<PathBuf>, ) -> Result<HashSet<CheckResult>>

Run the check: considering an input directory and either a file, some numbers, of a list file, run thru the list and check the validity of the PRDoc files. We return a Vec instead of a HashSet because a check based on a file may not always lead to a PR number, making the HashSet made of a bunch of (None, bool).