refactor: add sorting flag

kondanta · kondanta · commit c62ca036521d · 2021-09-28T17:34:35.000+03:00
I don't expect any other sorting types will be added
so the logic consist of checking whether it is
`newest` or not.

One could argue with why wouldn't I make this a boolean.
My answer would be, in my opinion, it lose its meaning
because this is not something we want to enable or disable
but something that we want to decide which pattern
we want to use. So it is more like a semantic choice.

Signed-off-by: Taylan Dogan &lt;git@taylandogan.info&gt;
diff --git a/git-cliff/src/args.rs b/git-cliff/src/args.rs
@@ -77,4 +77,20 @@ pub struct Opt {
 	/// Sets the commit range to process.
 	#[structopt(value_name = "RANGE")]
 	pub range:       Option<String>,
+
+	/// Sets sorting of the commits inside the sections
+	///
+	/// If sort is `oldest`, the oldest commit will be on top. {n}
+	/// - PR #1 {n}
+	/// - PR #2
+	///
+	/// If sort is `newest`, the newest commit will be on top. {n}
+	/// - PR #2 {n}
+	/// - PR #1 {n}
+	#[structopt(
+		long,
+		possible_values = &["oldest", "newest"],
+		default_value = "oldest"
+	)]
+	pub sort: String,
 }
diff --git a/git-cliff/src/lib.rs b/git-cliff/src/lib.rs
@@ -145,7 +145,11 @@ pub fn run(mut args: Opt) -> Result<()> {
 	for git_commit in commits.into_iter().rev() {
 		let commit = Commit::from(&git_commit);
 		let commit_id = commit.id.to_string();
-		releases[release_index].commits.insert(0, commit);
+		if args.sort == "newest" {
+			releases[release_index].commits.insert(0, commit);
+		} else {
+			releases[release_index].commits.push(commit);
+		}
 		if let Some(tag) = tags.get(&commit_id) {
 			releases[release_index].version = Some(tag.to_string());
 			releases[release_index].commit_id = Some(commit_id);
