feat: add keybinding to copy commit message

Author: wugeer

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixes
 * respect env vars like `GIT_CONFIG_GLOBAL` ([#2298](https://github.com/extrawurst/gitui/issues/2298))
+* keybinding to copy commit message ([#2370](https://github.com/extrawurst/gitui/issues/2370))
 
 ### Added
 * add popups for viewing, adding, updating and removing remotes [[@robin-thoene](https://github.com/robin-thoene)] ([#2172](https://github.com/extrawurst/gitui/issues/2172))

asyncgit/src/sync/commit_filter.rs

@@ -214,8 +214,7 @@ pub fn filter_commit_by_search(
 
 			Ok(msg_summary_match
 				|| msg_body_match
-				|| file_match
-				|| authors_match)
+				|| file_match || authors_match)
 		},
 	))
 }

src/components/commitlist.rs

@@ -170,6 +170,33 @@ impl CommitList {
 		Ok(())
 	}
 
+	///
+	pub fn selected_commit_message(&self) -> Option<String> {
+		let commit = self.selected_entry().map(|e| e.id);
+		let data = commit.and_then(|id| {
+			sync::get_commit_details(&self.repo.borrow(), id).ok()
+		});
+		data.as_ref().and_then(|data| data.message.as_ref()).map(
+			|message| {
+				message.body.as_ref().map_or_else(
+					|| message.subject.clone(),
+					|body| format!("{}\n{}", message.subject, body),
+				)
+			},
+		)
+	}
+
+	///
+	pub fn copy_commit_msg(&self) -> Result<()> {
+		if let Some(yank) = self.selected_commit_message() {
+			crate::clipboard::copy_string(&yank)?;
+			self.queue.push(InternalEvent::ShowInfoMsg(
+				strings::copy_success(&yank),
+			));
+		};
+		Ok(())
+	}
+
 	///
 	pub fn checkout(&self) {
 		if let Some(commit_hash) =

src/keys/key_list.rs

@@ -93,6 +93,7 @@ pub struct KeysList {
 	pub toggle_signoff: GituiKeyEvent,
 	pub toggle_verify: GituiKeyEvent,
 	pub copy: GituiKeyEvent,
+	pub copy_commit_msg: GituiKeyEvent,
 	pub create_branch: GituiKeyEvent,
 	pub rename_branch: GituiKeyEvent,
 	pub select_branch: GituiKeyEvent,
@@ -190,6 +191,7 @@ impl Default for KeysList {
 			toggle_signoff: GituiKeyEvent::new(KeyCode::Char('s'),  KeyModifiers::CONTROL),
 			toggle_verify: GituiKeyEvent::new(KeyCode::Char('f'),  KeyModifiers::CONTROL),
 			copy: GituiKeyEvent::new(KeyCode::Char('y'),  KeyModifiers::empty()),
+			copy_commit_msg: GituiKeyEvent::new(KeyCode::Char('m'),  KeyModifiers::empty()),
 			create_branch: GituiKeyEvent::new(KeyCode::Char('c'),  KeyModifiers::empty()),
 			rename_branch: GituiKeyEvent::new(KeyCode::Char('r'),  KeyModifiers::empty()),
 			select_branch: GituiKeyEvent::new(KeyCode::Char('b'),  KeyModifiers::empty()),

src/popups/remotelist.rs

@@ -245,8 +245,7 @@ impl RemoteListPopup {
 				.enumerate()
 				.map(|(i, remote)| {
 					let selected = (self.selection as usize
-						- self.scroll.get_top())
-						== i;
+						- self.scroll.get_top()) == i;
 					let mut remote_name = remote.clone();
 					if remote_name.len()
 						> name_length

src/strings.rs

@@ -636,6 +636,20 @@ pub mod commands {
 			CMD_GROUP_LOG,
 		)
 	}
+
+	pub fn copy_commit_msg(
+		key_config: &SharedKeyConfig,
+	) -> CommandText {
+		CommandText::new(
+			format!(
+				"Copy Msg [{}]",
+				key_config.get_hint(key_config.keys.copy_commit_msg),
+			),
+			"copy selected commit msg to clipboard",
+			CMD_GROUP_LOG,
+		)
+	}
+
 	pub fn copy_path(key_config: &SharedKeyConfig) -> CommandText {
 		CommandText::new(
 			format!(

src/tabs/revlog.rs

@@ -478,6 +478,16 @@ impl Component for Revlog {
 						self.list.copy_commit_hash()
 					);
 					return Ok(EventState::Consumed);
+				} else if key_match(
+					k,
+					self.key_config.keys.copy_commit_msg,
+				) {
+					try_or_popup!(
+						self,
+						strings::POPUP_FAIL_COPY,
+						self.list.copy_commit_msg()
+					);
+					return Ok(EventState::Consumed);
 				} else if key_match(k, self.key_config.keys.push) {
 					self.queue.push(InternalEvent::PushTags);
 					return Ok(EventState::Consumed);
@@ -611,6 +621,8 @@ impl Component for Revlog {
 		Ok(EventState::NotConsumed)
 	}
 
+	//TODO: cleanup
+	#[allow(clippy::too_many_lines)]
 	fn commands(
 		&self,
 		out: &mut Vec<CommandInfo>,
@@ -677,6 +689,12 @@ impl Component for Revlog {
 			self.visible || force_all,
 		));
 
+		out.push(CommandInfo::new(
+			strings::commands::copy_commit_msg(&self.key_config),
+			self.selected_commit().is_some(),
+			self.visible || force_all,
+		));
+
 		out.push(CommandInfo::new(
 			strings::commands::log_tag_commit(&self.key_config),
 			self.selected_commit().is_some(),
@@ -718,11 +736,13 @@ impl Component for Revlog {
 			self.selected_commit().is_some(),
 			(self.visible && !self.is_search_pending()) || force_all,
 		));
+
 		out.push(CommandInfo::new(
 			strings::commands::log_reword_commit(&self.key_config),
 			self.selected_commit().is_some(),
 			(self.visible && !self.is_search_pending()) || force_all,
 		));
+
 		out.push(CommandInfo::new(
 			strings::commands::log_find_commit(&self.key_config),
 			self.can_start_search(),

src/tabs/status.rs

@@ -686,8 +686,7 @@ impl Status {
 				strings::commands::select_staging(&self.key_config),
 				!focus_on_diff,
 				(self.visible
-					&& !focus_on_diff
-					&& self.focus == Focus::WorkDir)
+					&& !focus_on_diff && self.focus == Focus::WorkDir)
 					|| force_all,
 			)
 			.order(strings::order::NAV),
@@ -697,8 +696,7 @@ impl Status {
 				strings::commands::select_unstaged(&self.key_config),
 				!focus_on_diff,
 				(self.visible
-					&& !focus_on_diff
-					&& self.focus == Focus::Stage)
+					&& !focus_on_diff && self.focus == Focus::Stage)
 					|| force_all,
 			)
 			.order(strings::order::NAV),