pub struct InstantiatedConfig {
pub root_dirs: RootDirs,
pub code_results_subdir_regex: Option<Regex>,
pub lints: Vec<LintCheck>,
pub root_files: Vec<PathBuf>,
pub readme_names: Option<Vec<String>>,
pub workflow_names: Option<Vec<String>>,
}Expand description
The internal representation of all the important files, directories, and lints to check.
This data structure isn’t created directly from a configuration file.
It is instead instantiated from the ConfigFile struct, using some intermediate
logic that can fail along the way.
Fields§
§root_dirs: RootDirsExpected top-level directories to organize the project folder.
code_results_subdir_regex: Option<Regex>Regular expression for units of analysis within the code and their matching results.
The default value for this regular expression is CODE_RESULTS_SUBDIR_REGEX.
lints: Vec<LintCheck>The explicit list of lint checks that should be performed.
See LintCheck for the complete list.
root_files: Vec<PathBuf>The explicit list of files that should be present at the root of the project directory.
readme_names: Option<Vec<String>>The file name for the READMEs that should be present within each
subdirectory in the code and data
directories.
workflow_names: Option<Vec<String>>The file name for the workflow file that should be present within each
subdirectory in the code directory.
Implementations§
Source§impl InstantiatedConfig
impl InstantiatedConfig
Sourcepub fn execute_lints(self) -> Result<(), LintError>
pub fn execute_lints(self) -> Result<(), LintError>
The main method to run all the requested lints on the project directory.
Trait Implementations§
Source§impl Clone for InstantiatedConfig
impl Clone for InstantiatedConfig
Source§fn clone(&self) -> InstantiatedConfig
fn clone(&self) -> InstantiatedConfig
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more