Sort results (#32)

Fixes #31
paritytech · May 8, 2024 · e3c8ecb · e3c8ecb
1 parent 0b0d363
commit e3c8ecb
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 8 deletions.
diff --git a/cli/src/main.rs b/cli/src/main.rs
@@ -16,8 +16,11 @@ use prdoclib::{
 	},
 	common::PRNumber,
 	config::Config,
+	prdoc_source::PRDocSource,
+	prdoc_source::PRDocSource::File,
 	schema::Schema,
 };
+use std::cmp::Ordering;
 use std::{collections::HashSet, env, path::PathBuf};
 
 /// Main entry point of the cli
@@ -64,7 +67,7 @@ fn main() -> color_eyre::Result<()> {
 
 		Some(SubCommand::Check(cmd_opts)) => {
 			log::debug!("cmd_opts: {cmd_opts:#?}");
-			let results: HashSet<CheckResult> = prdoc_dir
+			let mut results: Vec<CheckResult> = prdoc_dir
 				.iter()
 				.flat_map(|dir| {
 					CheckCmd::run(
@@ -79,6 +82,13 @@ fn main() -> color_eyre::Result<()> {
 				})
 				.collect();
 
+			results.sort_by(|a, b| match (&a.0, &b.0) {
+				(File(path_a), File(path_b)) => path_a.cmp(path_b),
+				(PRDocSource::Number(num_a), PRDocSource::Number(num_b))
+				| (PRDocSource::Both(_, num_a), PRDocSource::Both(_, num_b)) => num_a.cmp(num_b),
+				_ => Ordering::Greater,
+			});
+
 			if !opts.json {
 				for (src, result) in &results {
 					if *result {

diff --git a/prdoclib/src/commands/check.rs b/prdoclib/src/commands/check.rs
@@ -146,7 +146,7 @@ impl CheckCmd {
 	pub fn global_result(hs: HashSet<CheckResult>) -> bool {
 		for item in hs.iter() {
 			if !item.1 {
-				return false
+				return false;
 			}
 		}
 

diff --git a/prdoclib/src/config.rs b/prdoclib/src/config.rs
@@ -49,15 +49,15 @@ impl Config {
 		if let Some(config) = config_file {
 			if PathBuf::from(&config).exists() {
 				log::debug!("Found config in {config:?}");
-				return Ok(config)
+				return Ok(config);
 			}
 		}
 
 		for name in CONFIG_NAMES {
 			let candidate = root.join(name);
 			if candidate.exists() {
 				log::debug!("Found config in {}", candidate.display());
-				return Ok(candidate)
+				return Ok(candidate);
 			}
 		}
 

diff --git a/prdoclib/src/doc_filename.rs b/prdoclib/src/doc_filename.rs
@@ -87,7 +87,7 @@ impl DocFileName {
 				// First we exclude anything that is not a file
 				let metadata = std::fs::metadata(candidate.path()).unwrap();
 				if !metadata.is_file() {
-					return None
+					return None;
 				}
 
 				// Fetch the file name

diff --git a/prdoclib/src/schema.rs b/prdoclib/src/schema.rs
@@ -76,7 +76,7 @@ impl Schema {
 		if !(validation_result && validation_result_strict) {
 			log::debug!("validation_result: {validation_result}");
 			log::debug!("validation_result_strict: {validation_result_strict}");
-			return Err(PRdocLibError::ValidationErrors(validation))
+			return Err(PRdocLibError::ValidationErrors(validation));
 		}
 
 		Ok(doc_as_yaml)

diff --git a/prdoclib/src/utils.rs b/prdoclib/src/utils.rs
@@ -18,7 +18,7 @@ pub fn get_project_root() -> io::Result<PathBuf> {
 	for p in path_ancestors {
 		let has_cargo = read_dir(p)?.any(|p| p.unwrap().file_name() == "Cargo.lock");
 		if has_cargo {
-			return Ok(PathBuf::from(p))
+			return Ok(PathBuf::from(p));
 		}
 	}
 	Err(io::Error::new(ErrorKind::NotFound, "Ran out of places to find Cargo.toml"))
@@ -39,7 +39,7 @@ pub(crate) fn get_numbers_from_file(file: &PathBuf) -> error::Result<Vec<ParseRe
 /// Return the path of the folder where PRDoc are stored
 pub fn get_pr_doc_folder(output_dir: Option<PathBuf>, config: &PRDocConfig) -> PathBuf {
 	if let Some(path) = output_dir {
-		return path
+		return path;
 	}
 
 	config.output_dir.clone()