Multiline TextEdit cleanups (#2053)

* change commit default binding * animated gif of multiline text edit * update changelog * fix style of default text * textinput should not need to know about its users * fix branch create popup
extrawurst · Feb 18, 2024 · 825935b · 825935b
1 parent b9a2e13
commit 825935b
Show file tree

Hide file tree

Showing 6 changed files with 468 additions and 447 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,10 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+** multiline text editor **
+
+![multiline editor](assets/multiline-texteditor.gif)
+
+### Breaking Change
+The Commit message popup now supports multiline editing! Inserting a **newline** defaults to `enter`. This comes with a new default to confirm the commit message (`ctrl+d`).
+Both commands can be overwritten via `newline` and `commit` in the key bindings. see [KEY_CONFIG](./KEY_CONFIG.md) on how.
+These defaults require some adoption from existing users but feel more natural to new users.
+
 ### Added
 * `theme.ron` now supports customizing line break symbol ([#1894](https://github.com/extrawurst/gitui/issues/1894))
 * add confirmation for dialog for undo commit [[@TeFiLeDo](https://github.com/TeFiLeDo)] ([#1912](https://github.com/extrawurst/gitui/issues/1912))
 * support `prepare-commit-msg` hook ([#1873](https://github.com/extrawurst/gitui/issues/1873))
+* support for new-line in text-input (e.g. commit message editor) [[@pm100]](https://github/pm100) ([#1662](https://github.com/extrawurst/gitui/issues/1662)).
 
 ### Changed
 * do not allow tag when `tag.gpgsign` enabled [[@TeFiLeDo](https://github.com/TeFiLeDo)] ([#1915](https://github.com/extrawurst/gitui/pull/1915))

diff --git a/assets/multiline-texteditor.gif b/assets/multiline-texteditor.gif
diff --git a/src/components/commit.rs b/src/components/commit.rs
@@ -512,7 +512,7 @@ impl Component for CommitComponent {
 
 		if self.is_visible() || force_all {
 			out.push(CommandInfo::new(
-				strings::commands::commit_enter(&self.key_config),
+				strings::commands::commit_submit(&self.key_config),
 				self.can_commit(),
 				true,
 			));
@@ -566,57 +566,67 @@ impl Component for CommitComponent {
 
 	fn event(&mut self, ev: &Event) -> Result<EventState> {
 		if self.is_visible() {
-			if self.input.event(ev)?.is_consumed() {
-				return Ok(EventState::Consumed);
-			}
-
 			if let Event::Key(e) = ev {
-				if key_match(e, self.key_config.keys.commit)
-					&& self.can_commit()
-				{
-					try_or_popup!(
-						self,
-						"commit error:",
-						self.commit()
-					);
-				} else if key_match(
-					e,
-					self.key_config.keys.toggle_verify,
-				) && self.can_commit()
-				{
-					self.toggle_verify();
-				} else if key_match(
-					e,
-					self.key_config.keys.commit_amend,
-				) && self.can_amend()
-				{
-					self.amend()?;
-				} else if key_match(
-					e,
-					self.key_config.keys.open_commit_editor,
-				) {
-					self.queue.push(
-						InternalEvent::OpenExternalEditor(None),
-					);
-					self.hide();
-				} else if key_match(
-					e,
-					self.key_config.keys.commit_history_next,
-				) {
-					if let Some(msg) = self
-						.options
-						.borrow()
-						.commit_msg(self.commit_msg_history_idx)
+				let input_consumed =
+					if key_match(e, self.key_config.keys.commit)
+						&& self.can_commit()
+					{
+						try_or_popup!(
+							self,
+							"commit error:",
+							self.commit()
+						);
+						true
+					} else if key_match(
+						e,
+						self.key_config.keys.toggle_verify,
+					) && self.can_commit()
+					{
+						self.toggle_verify();
+						true
+					} else if key_match(
+						e,
+						self.key_config.keys.commit_amend,
+					) && self.can_amend()
 					{
-						self.input.set_text(msg);
-						self.commit_msg_history_idx += 1;
-					}
-				} else if key_match(
-					e,
-					self.key_config.keys.toggle_signoff,
-				) {
-					self.signoff_commit();
+						self.amend()?;
+						true
+					} else if key_match(
+						e,
+						self.key_config.keys.open_commit_editor,
+					) {
+						self.queue.push(
+							InternalEvent::OpenExternalEditor(None),
+						);
+						self.hide();
+						true
+					} else if key_match(
+						e,
+						self.key_config.keys.commit_history_next,
+					) {
+						if let Some(msg) = self
+							.options
+							.borrow()
+							.commit_msg(self.commit_msg_history_idx)
+						{
+							self.input.set_text(msg);
+							self.commit_msg_history_idx += 1;
+						}
+						true
+					} else if key_match(
+						e,
+						self.key_config.keys.toggle_signoff,
+					) {
+						self.signoff_commit();
+						true
+					} else {
+						false
+					};
+
+				if !input_consumed {
+					self.input.event(ev)?;
 				}
+
 				// stop key event propagation
 				return Ok(EventState::Consumed);
 			}