chore(project): migrate to Rust 2024 edition (#1128)

orhun · web-flow · commit 4445f063518b · 2025-04-20T23:29:29.000+03:00
diff --git a/Dockerfile b/Dockerfile
@@ -1,5 +1,5 @@
 # syntax=docker/dockerfile:1.4.3-labs
-FROM lukemathwalker/cargo-chef:0.1.70-rust-1.84.0-slim AS chef
+FROM lukemathwalker/cargo-chef:0.1.71-rust-1.85.0-slim-bookworm AS chef
 WORKDIR app
 
 FROM chef AS planner
diff --git a/flake.lock b/flake.lock
diff --git a/git-cliff-core/Cargo.toml b/git-cliff-core/Cargo.toml
@@ -8,8 +8,8 @@ readme = "../README.md"
 homepage = "https://github.com/orhun/git-cliff"
 repository = "https://github.com/orhun/git-cliff"
 keywords = ["changelog", "generator", "conventional", "commit"]
-edition = "2021"
-rust-version = "1.83.0"
+edition = "2024"
+rust-version = "1.85.0"
 
 [features]
 default = ["repo"]
diff --git a/git-cliff-core/src/commit.rs b/git-cliff-core/src/commit.rs
@@ -8,19 +8,19 @@ use crate::error::{
 	Error as AppError,
 	Result,
 };
+use git_conventional::{
+	Commit as ConventionalCommit,
+	Footer as ConventionalFooter,
+};
 #[cfg(feature = "repo")]
 use git2::{
 	Commit as GitCommit,
 	Signature as CommitSignature,
 };
-use git_conventional::{
-	Commit as ConventionalCommit,
-	Footer as ConventionalFooter,
-};
 use lazy_regex::{
-	lazy_regex,
 	Lazy,
 	Regex,
+	lazy_regex,
 };
 use serde::ser::{
 	SerializeStruct,
diff --git a/git-cliff-core/src/config.rs b/git-cliff-core/src/config.rs
@@ -490,9 +490,11 @@ mod test {
 		const TAG_PATTERN_VALUE: &str = ".*[0-9].*";
 		const IGNORE_TAGS_VALUE: &str = "v[0-9]+.[0-9]+.[0-9]+-rc[0-9]+";
 
-		env::set_var("GIT_CLIFF__CHANGELOG__FOOTER", FOOTER_VALUE);
-		env::set_var("GIT_CLIFF__GIT__TAG_PATTERN", TAG_PATTERN_VALUE);
-		env::set_var("GIT_CLIFF__GIT__IGNORE_TAGS", IGNORE_TAGS_VALUE);
+		unsafe {
+			env::set_var("GIT_CLIFF__CHANGELOG__FOOTER", FOOTER_VALUE);
+			env::set_var("GIT_CLIFF__GIT__TAG_PATTERN", TAG_PATTERN_VALUE);
+			env::set_var("GIT_CLIFF__GIT__IGNORE_TAGS", IGNORE_TAGS_VALUE);
+		};
 
 		let config = Config::parse(&path)?;
 
diff --git a/git-cliff-core/src/remote/mod.rs b/git-cliff-core/src/remote/mod.rs
@@ -22,9 +22,9 @@ use crate::error::{
 };
 use dyn_clone::DynClone;
 use futures::{
+	StreamExt,
 	future,
 	stream,
-	StreamExt,
 };
 use http_cache_reqwest::{
 	CACacheManager,
@@ -33,11 +33,11 @@ use http_cache_reqwest::{
 	HttpCache,
 	HttpCacheOptions,
 };
+use reqwest::Client;
 use reqwest::header::{
 	HeaderMap,
 	HeaderValue,
 };
-use reqwest::Client;
 use reqwest_middleware::{
 	ClientBuilder,
 	ClientWithMiddleware,
@@ -52,8 +52,8 @@ use std::env;
 use std::fmt::Debug;
 use std::time::Duration;
 use time::{
-	format_description::well_known::Rfc3339,
 	OffsetDateTime,
+	format_description::well_known::Rfc3339,
 };
 
 /// User agent for interacting with the GitHub API.
diff --git a/git-cliff-core/src/repo.rs b/git-cliff-core/src/repo.rs
@@ -17,9 +17,9 @@ use git2::{
 use glob::Pattern;
 use indexmap::IndexMap;
 use lazy_regex::{
-	lazy_regex,
 	Lazy,
 	Regex,
+	lazy_regex,
 };
 use std::io;
 use std::path::{
@@ -238,12 +238,11 @@ impl Repository {
 				.expect("failed to add '**' to the end of glob"),
 			_ => pattern,
 		};
-		let pattern_normal = match star_added.as_str().strip_prefix("./") {
+		match star_added.as_str().strip_prefix("./") {
 			Some(stripped) => Pattern::new(stripped)
 				.expect("failed to remove leading ./ from glob"),
 			None => star_added,
-		};
-		pattern_normal
+		}
 	}
 
 	/// Calculates whether the commit should be retained or not.
@@ -710,9 +709,11 @@ mod test {
 	#[test]
 	fn commit_search() -> Result<()> {
 		let repository = get_repository()?;
-		assert!(repository
-			.find_commit("e936ed571533ea6c41a1dd2b1a29d085c8dbada5")
-			.is_some());
+		assert!(
+			repository
+				.find_commit("e936ed571533ea6c41a1dd2b1a29d085c8dbada5")
+				.is_some()
+		);
 		Ok(())
 	}
 
@@ -912,10 +913,12 @@ mod test {
 
 		assert!(result.is_err());
 		if let Err(error) = result {
-			assert!(format!("{error:?}").contains(
-				format!("could not find repository at '{}'", path.display())
-					.as_str()
-			))
+			assert!(
+				format!("{error:?}").contains(
+					format!("could not find repository at '{}'", path.display())
+						.as_str()
+				)
+			)
 		}
 	}
 
@@ -945,13 +948,10 @@ mod test {
 			.expect("failed to execute git commit");
 		assert!(output.status.success(), "git commit failed {:?}", output);
 
-		let last_commit = repo
-			.inner
+		repo.inner
 			.head()
 			.and_then(|head| head.peel_to_commit())
-			.expect("failed to get the last commit");
-
-		last_commit
+			.expect("failed to get the last commit")
 	}
 
 	#[test]
diff --git a/git-cliff-core/src/template.rs b/git-cliff-core/src/template.rs
@@ -12,11 +12,11 @@ use std::collections::{
 };
 use std::error::Error as ErrorImpl;
 use tera::{
-	ast,
 	Context as TeraContext,
 	Result as TeraResult,
 	Tera,
 	Value,
+	ast,
 };
 
 /// Wrapper for [`Tera`].
diff --git a/git-cliff/Cargo.toml b/git-cliff/Cargo.toml
@@ -10,8 +10,8 @@ repository = "https://github.com/orhun/git-cliff"
 keywords = ["changelog", "generator", "conventional", "commit"]
 categories = ["command-line-utilities"]
 default-run = "git-cliff"
-edition = "2021"
-rust-version = "1.83.0"
+edition = "2024"
+rust-version = "1.85.0"
 
 [[bin]]
 name = "git-cliff-completions"
diff --git a/git-cliff/src/args.rs b/git-cliff/src/args.rs
@@ -1,27 +1,27 @@
 use clap::{
+	ArgAction,
+	Parser,
+	ValueEnum,
 	builder::{
+		Styles,
+		TypedValueParser,
+		ValueParserFactory,
 		styling::{
 			Ansi256Color,
 			AnsiColor,
 		},
-		Styles,
-		TypedValueParser,
-		ValueParserFactory,
 	},
 	error::{
 		ContextKind,
 		ContextValue,
 		ErrorKind,
 	},
-	ArgAction,
-	Parser,
-	ValueEnum,
 };
 use git_cliff_core::{
-	config::BumpType,
-	config::Remote,
 	DEFAULT_CONFIG,
 	DEFAULT_OUTPUT,
+	config::BumpType,
+	config::Remote,
 };
 use glob::Pattern;
 use regex::Regex;
@@ -512,12 +512,16 @@ mod tests {
 				OsStr::new("https://gitlab.archlinux.org/archlinux/packaging/packages/arch-repro-status")
 			)?
 		);
-		assert!(remote_value_parser
-			.parse_ref(&Opt::command(), None, OsStr::new("test"))
-			.is_err());
-		assert!(remote_value_parser
-			.parse_ref(&Opt::command(), None, OsStr::new(""))
-			.is_err());
+		assert!(
+			remote_value_parser
+				.parse_ref(&Opt::command(), None, OsStr::new("test"))
+				.is_err()
+		);
+		assert!(
+			remote_value_parser
+				.parse_ref(&Opt::command(), None, OsStr::new(""))
+				.is_err()
+		);
 		Ok(())
 	}
 
@@ -532,9 +536,11 @@ mod tests {
 				OsStr::new("auto")
 			)?
 		);
-		assert!(bump_option_parser
-			.parse_ref(&Opt::command(), None, OsStr::new("test"))
-			.is_err());
+		assert!(
+			bump_option_parser
+				.parse_ref(&Opt::command(), None, OsStr::new("test"))
+				.is_err()
+		);
 		assert_eq!(
 			BumpOption::Specific(BumpType::Major),
 			bump_option_parser.parse_ref(
diff --git a/git-cliff/src/lib.rs b/git-cliff/src/lib.rs
@@ -584,11 +584,7 @@ pub fn run_with_changelog_modifier(
 	} else if let Some(discovered_path) =
 		env::current_dir()?.ancestors().find_map(|dir| {
 			let path = dir.join(DEFAULT_CONFIG);
-			if path.is_file() {
-				Some(path)
-			} else {
-				None
-			}
+			if path.is_file() { Some(path) } else { None }
 		}) {
 		info!(
 			"Using configuration from parent directory: {}",
diff --git a/git-cliff/src/logger.rs b/git-cliff/src/logger.rs
@@ -1,10 +1,10 @@
 use env_logger::{
+	Builder,
 	fmt::{
 		Color,
 		Style,
 		StyledValue,
 	},
-	Builder,
 };
 use git_cliff_core::error::{
 	Error,
diff --git a/git-cliff/src/main.rs b/git-cliff/src/main.rs
@@ -13,11 +13,11 @@ fn main() -> Result<()> {
 	// Parse the command line arguments
 	let args = Opt::parse();
 	if args.verbose == 1 {
-		env::set_var("RUST_LOG", "debug");
+		unsafe { env::set_var("RUST_LOG", "debug") };
 	} else if args.verbose > 1 {
-		env::set_var("RUST_LOG", "trace");
+		unsafe { env::set_var("RUST_LOG", "trace") };
 	} else if env::var_os("RUST_LOG").is_none() {
-		env::set_var("RUST_LOG", "info");
+		unsafe { env::set_var("RUST_LOG", "info") };
 	}
 	logger::init()?;
 
diff --git a/rustfmt.toml b/rustfmt.toml
@@ -1,4 +1,4 @@
-edition = "2018"
+edition = "2024"
 max_width = 85
 newline_style = "Unix"
 hard_tabs = true
