WIP: add cut action for git-revise

Author: forivall

readme/customization.md

@@ -113,6 +113,7 @@ Most keys can be changed to any printable character or supported special charact
 | `inputActionPick`           | p         | String | Key for setting action to pick                      |
 | `inputActionReword`         | r         | String | Key for setting action to reword                    |
 | `inputActionSquash`         | s         | String | Key for setting action to squash                    |
+| `inputActionCut`            | x         | String | Key for setting action to cut (git-revise)          |
 | `inputActionIndex`          | i         | String | Key for setting action to index (git-revise)        |
 | `inputConfirmNo`            | n         | String | Key for rejecting a confirmation                    |
 | `inputConfirmYes`           | y         | String | Key for confirming a confirmation                   |

src/config/src/key_bindings.rs

@@ -19,6 +19,8 @@ pub struct KeyBindings {
 	pub abort: Vec<String>,
 	/// Key bindings for the break action.
 	pub action_break: Vec<String>,
+	/// Key bindings for the cut action.
+	pub action_cut: Vec<String>,
 	/// Key bindings for the drop action.
 	pub action_drop: Vec<String>,
 	/// Key bindings for the edit action.
@@ -135,6 +137,7 @@ impl KeyBindings {
 		Ok(Self {
 			abort: get_input(git_config, "interactive-rebase-tool.inputAbort", "q")?,
 			action_break: get_input(git_config, "interactive-rebase-tool.inputActionBreak", "b")?,
+			action_cut: get_input(git_config, "interactive-rebase-tool.inputActionCut", "x")?,
 			action_drop: get_input(git_config, "interactive-rebase-tool.inputActionDrop", "d")?,
 			action_edit: get_input(git_config, "interactive-rebase-tool.inputActionEdit", "e")?,
 			action_fixup: get_input(git_config, "interactive-rebase-tool.inputActionFixup", "f")?,

src/config/src/theme.rs

@@ -30,6 +30,8 @@ pub struct Theme {
 	pub character_vertical_spacing: String,
 	/// The color for the break action.
 	pub color_action_break: Color,
+	/// The color for the cut action.
+	pub color_action_cut: Color,
 	/// The color for the drop action.
 	pub color_action_drop: Color,
 	/// The color for the edit action.
@@ -92,6 +94,7 @@ impl Theme {
 				"~",
 			)?,
 			color_action_break: get_color(git_config, "interactive-rebase-tool.breakColor", Color::LightWhite)?,
+			color_action_cut: get_color(git_config, "interactive-rebase-tool.cutColor", Color::DarkRed)?,
 			color_action_drop: get_color(git_config, "interactive-rebase-tool.dropColor", Color::LightRed)?,
 			color_action_edit: get_color(git_config, "interactive-rebase-tool.editColor", Color::LightBlue)?,
 			color_action_exec: get_color(git_config, "interactive-rebase-tool.execColor", Color::LightWhite)?,

src/core/src/events/app_key_bindings.rs

@@ -15,6 +15,8 @@ pub(crate) struct AppKeyBindings {
 	pub(crate) abort: Vec<Event>,
 	/// Key bindings for the break action.
 	pub(crate) action_break: Vec<Event>,
+	/// Key bindings for the cut action.
+	pub(crate) action_cut: Vec<Event>,
 	/// Key bindings for the drop action.
 	pub(crate) action_drop: Vec<Event>,
 	/// Key bindings for the edit action.
@@ -83,6 +85,7 @@ impl CustomKeybinding for AppKeyBindings {
 		Self {
 			abort: map_keybindings(&key_bindings.abort),
 			action_break: map_keybindings(&key_bindings.action_break),
+			action_cut: map_keybindings(&key_bindings.action_cut),
 			action_drop: map_keybindings(&key_bindings.action_drop),
 			action_edit: map_keybindings(&key_bindings.action_edit),
 			action_fixup: map_keybindings(&key_bindings.action_fixup),

src/core/src/events/meta_event.rs

@@ -12,6 +12,8 @@ pub(crate) enum MetaEvent {
 	ForceRebase,
 	/// The break action meta event.
 	ActionBreak,
+	/// The cut (git-revise) action meta event.
+	ActionCut,
 	/// The drop action meta event.
 	ActionDrop,
 	/// The edit action meta event.

src/core/src/modules/list/mod.rs

@@ -517,6 +517,7 @@ impl List {
 		match event {
 			e if key_bindings.custom.abort.contains(&e) => Event::from(MetaEvent::Abort),
 			e if key_bindings.custom.action_break.contains(&e) => Event::from(MetaEvent::ActionBreak),
+			e if key_bindings.custom.action_cut.contains(&e) => Event::from(MetaEvent::ActionCut),
 			e if key_bindings.custom.action_drop.contains(&e) => Event::from(MetaEvent::ActionDrop),
 			e if key_bindings.custom.action_edit.contains(&e) => Event::from(MetaEvent::ActionEdit),
 			e if key_bindings.custom.action_fixup.contains(&e) => Event::from(MetaEvent::ActionFixup),
@@ -606,6 +607,7 @@ impl List {
 			Event::MetaEvent(meta_event) => {
 				match meta_event {
 					MetaEvent::Abort => self.abort(&mut results),
+					MetaEvent::ActionCut => self.set_selected_line_action(Action::Cut),
 					MetaEvent::ActionDrop => self.set_selected_line_action(Action::Drop),
 					MetaEvent::ActionEdit => self.set_selected_line_action(Action::Edit),
 					MetaEvent::ActionFixup => self.set_selected_line_action(Action::Fixup),

src/core/src/modules/list/tests/help.rs

@@ -43,6 +43,7 @@ fn normal_mode_help() {
 				" s       |Set selected commits to be squashed",
 				" f       |Set selected commits to be fixed-up",
 				" d       |Set selected commits to be dropped",
+				" x       |Set selected commits to be cut / split (git-revise)",
 				" i       |Set selected commits to be staged in the index (git-revise)",
 				" E       |Edit an exec, label, reset or merge action's content",
 				" I       |Insert a new line",
@@ -109,6 +110,7 @@ fn visual_mode_help() {
 				" s       |Set selected commits to be squashed",
 				" f       |Set selected commits to be fixed-up",
 				" d       |Set selected commits to be dropped",
+				" x       |Set selected commits to be cut / split (git-revise)",
 				" i       |Set selected commits to be staged in the index (git-revise)",
 				" Delete  |Completely remove the selected lines",
 				" Controlz|Undo the last change",

src/core/src/modules/list/tests/read_event.rs

@@ -49,6 +49,7 @@ fn search() {
 #[case::actionpick('p', MetaEvent::ActionPick)]
 #[case::actionreword('r', MetaEvent::ActionReword)]
 #[case::actionsquash('s', MetaEvent::ActionSquash)]
+#[case::actioncut('x', MetaEvent::ActionCut)]
 #[case::actionindex('i', MetaEvent::ActionIndex)]
 #[case::edit('E', MetaEvent::Edit)]
 #[case::forceabort('Q', MetaEvent::ForceAbort)]

src/core/src/modules/list/utils.rs

@@ -122,6 +122,11 @@ fn build_help_lines(key_bindings: &KeyBindings, selector: HelpLinesSelector) ->
 			"Set selected commits to be dropped",
 			HelpLinesSelector::Common,
 		),
+		(
+			&key_bindings.action_cut,
+			"Set selected commits to be cut / split (git-revise)",
+			HelpLinesSelector::Common,
+		),
 		(
 			&key_bindings.action_index,
 			"Set selected commits to be staged in the index (git-revise)",
@@ -185,6 +190,7 @@ pub(super) fn get_list_visual_mode_help_lines(key_bindings: &KeyBindings) -> Vec
 const fn get_action_color(action: Action) -> DisplayColor {
 	match action {
 		Action::Break => DisplayColor::ActionBreak,
+		Action::Cut => DisplayColor::ActionCut,
 		Action::Drop => DisplayColor::ActionDrop,
 		Action::Edit => DisplayColor::ActionEdit,
 		Action::Exec => DisplayColor::ActionExec,
@@ -209,7 +215,7 @@ pub(super) fn get_line_action_maximum_width(todo_file: &TodoFile) -> usize {
 		let action_length = match line.get_action() {
 			// allow these to overflow their bounds
 			&Action::Exec | &Action::UpdateRef => 0,
-			&Action::Drop | &Action::Edit | &Action::Noop | &Action::Pick => 4,
+			&Action::Cut | &Action::Drop | &Action::Edit | &Action::Noop | &Action::Pick => 4,
 			&Action::Break | &Action::Label | &Action::Reset | &Action::Merge | &Action::Index => 5,
 			&Action::Fixup => {
 				if line.option().is_some() {
@@ -299,7 +305,7 @@ pub(super) fn get_todo_line_segments(
 
 	// render hash
 	match *action {
-		Action::Drop | Action::Edit | Action::Fixup | Action::Index | Action::Pick | Action::Reword | Action::Squash => {
+		Action::Cut | Action::Drop | Action::Edit | Action::Fixup | Action::Index | Action::Pick | Action::Reword | Action::Squash => {
 			let action_width = if is_full_width { 8 } else { 3 };
 			let max_index = cmp::min(line.get_hash().len(), action_width);
 			let search_match = search_term.map_or(false, |term| line.get_hash().starts_with(term));

src/core/src/testutil/create_test_keybindings.rs

@@ -10,6 +10,7 @@ pub(crate) fn create_test_custom_keybindings() -> AppKeyBindings {
 	AppKeyBindings {
 		abort: vec![Event::from(KeyCode::Char('q'))],
 		action_break: vec![Event::from(KeyCode::Char('b'))],
+		action_cut: vec![Event::from(KeyCode::Char('x'))],
 		action_drop: vec![Event::from(KeyCode::Char('d'))],
 		action_edit: vec![Event::from(KeyCode::Char('e'))],
 		action_fixup: vec![Event::from(KeyCode::Char('f'))],

src/display/src/display_color.rs

@@ -4,6 +4,8 @@
 pub enum DisplayColor {
 	/// The color for the break action.
 	ActionBreak,
+	/// The color for the cut action.
+	ActionCut,
 	/// The color for the drop action.
 	ActionDrop,
 	/// The color for the edit action.

src/display/src/lib.rs

@@ -174,6 +174,7 @@ pub use self::{
 #[derive(Debug)]
 pub struct Display<T: Tui> {
 	action_break: (Colors, Colors),
+	action_cut: (Colors, Colors),
 	action_drop: (Colors, Colors),
 	action_edit: (Colors, Colors),
 	action_exec: (Colors, Colors),
@@ -219,6 +220,12 @@ impl<T: Tui> Display<T> {
 			theme.color_background,
 			theme.color_selected_background,
 		);
+		let action_cut = register_selectable_color_pairs(
+			color_mode,
+			theme.color_action_cut,
+			theme.color_background,
+			theme.color_selected_background,
+		);
 		let action_drop = register_selectable_color_pairs(
 			color_mode,
 			theme.color_action_drop,
@@ -324,6 +331,7 @@ impl<T: Tui> Display<T> {
 
 		Self {
 			action_break,
+			action_cut,
 			action_drop,
 			action_edit,
 			action_exec,
@@ -389,6 +397,7 @@ impl<T: Tui> Display<T> {
 			if selected {
 				match color {
 					DisplayColor::ActionBreak => self.action_break.1,
+					DisplayColor::ActionCut => self.action_cut.1,
 					DisplayColor::ActionDrop => self.action_drop.1,
 					DisplayColor::ActionEdit => self.action_edit.1,
 					DisplayColor::ActionExec => self.action_exec.1,
@@ -413,6 +422,7 @@ impl<T: Tui> Display<T> {
 			else {
 				match color {
 					DisplayColor::ActionBreak => self.action_break.0,
+					DisplayColor::ActionCut => self.action_cut.0,
 					DisplayColor::ActionDrop => self.action_drop.0,
 					DisplayColor::ActionEdit => self.action_edit.0,
 					DisplayColor::ActionExec => self.action_exec.0,

src/todo_file/src/action.rs

@@ -8,6 +8,8 @@ use crate::errors::ParseError;
 pub enum Action {
 	/// A break action.
 	Break,
+	/// A cut action for git-revise.
+	Cut,
 	/// A drop action.
 	Drop,
 	/// An edit action.
@@ -44,6 +46,7 @@ impl Action {
 		String::from(match self {
 			Self::Break => "b",
 			Self::Drop => "d",
+			Self::Cut => "c",
 			Self::Edit => "e",
 			Self::Exec => "x",
 			Self::Fixup => "f",
@@ -65,7 +68,7 @@ impl Action {
 	pub const fn is_static(self) -> bool {
 		match self {
 			Self::Break | Self::Exec | Self::Noop | Self::Reset | Self::Label | Self::Merge | Self::UpdateRef => true,
-			Self::Drop | Self::Edit | Self::Index | Self::Fixup | Self::Pick | Self::Reword | Self::Squash => false,
+			Self::Cut | Self::Drop | Self::Edit | Self::Index | Self::Fixup | Self::Pick | Self::Reword | Self::Squash => false,
 		}
 	}
 }
@@ -75,6 +78,7 @@ impl Display for Action {
 	fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
 		write!(f, "{}", match *self {
 			Self::Break => "break",
+			Self::Cut => "cut",
 			Self::Drop => "drop",
 			Self::Edit => "edit",
 			Self::Exec => "exec",

src/todo_file/src/lib.rs

@@ -279,7 +279,8 @@ impl TodoFile {
 
 							match *action {
 								Action::Break | Action::Noop => {},
-								Action::Drop
+								Action::Cut
+								| Action::Drop
 								| Action::Fixup
 								| Action::Edit
 								| Action::Index

src/todo_file/src/line.rs

@@ -102,7 +102,7 @@ impl Line {
 		Ok(match action {
 			Action::Noop => Self::new_noop(),
 			Action::Break => Self::new_break(),
-			Action::Pick | Action::Reword | Action::Edit | Action::Squash | Action::Drop | Action::Index => {
+			Action::Pick | Action::Reword | Action::Edit | Action::Squash | Action::Drop | Action::Cut | Action::Index => {
 				Self::new(action, line_parser.next()?, line_parser.take_remaining(), None)
 			},
 			Action::Fixup => {
@@ -209,6 +209,7 @@ impl Line {
 		match self.action {
 			Action::Exec | Action::Index | Action::Label | Action::Reset | Action::Merge | Action::UpdateRef => true,
 			Action::Break
+			| Action::Cut
 			| Action::Drop
 			| Action::Edit
 			| Action::Fixup
@@ -231,7 +232,7 @@ impl Line {
 	#[inline]
 	pub fn to_text(&self) -> String {
 		match self.action {
-			Action::Drop | Action::Edit | Action::Fixup | Action::Index | Action::Pick | Action::Reword | Action::Squash => {
+			Action::Cut | Action::Drop | Action::Edit | Action::Fixup | Action::Index | Action::Pick | Action::Reword | Action::Squash => {
 				if let Some(opt) = self.option.as_ref() {
 					format!("{} {opt} {} {}", self.action, self.hash, self.content)
 				}

src/todo_file/src/search.rs

@@ -37,7 +37,8 @@ impl Search {
 			for (i, line) in rebase_todo.lines_iter().enumerate() {
 				match *line.get_action() {
 					Action::Break | Action::Noop => continue,
-					Action::Drop
+					Action::Cut
+					| Action::Drop
 					| Action::Edit
 					| Action::Fixup
 					| Action::Index

src/view/src/testutil/render_view_line.rs

@@ -83,6 +83,7 @@ pub(crate) fn render_style(line_segment: &LineSegment) -> String {
 		DisplayColor::DiffWhitespaceColor => String::from("DiffWhitespaceColor"),
 		DisplayColor::IndicatorColor => String::from("IndicatorColor"),
 		DisplayColor::Normal => String::from("Normal"),
+		DisplayColor::ActionCut => String::from("ActionCut"),
 		DisplayColor::ActionIndex => String::from("ActionIndex"),
 		DisplayColor::ActionLabel => String::from("ActionLabel"),
 		DisplayColor::ActionReset => String::from("ActionReset"),