WIP: add index 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                    |
+| `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                   |
 | `inputEdit`                 | E         | String | Key for entering edit mode                          |

src/config/src/key_bindings.rs

@@ -25,6 +25,8 @@ pub struct KeyBindings {
 	pub action_edit: Vec<String>,
 	/// Key bindings for the fixup action.
 	pub action_fixup: Vec<String>,
+	/// Key bindings for the index action.
+	pub action_index: Vec<String>,
 	/// Key bindings for the pick action.
 	pub action_pick: Vec<String>,
 	/// Key bindings for the reword action.
@@ -136,6 +138,7 @@ impl KeyBindings {
 			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")?,
+			action_index: get_input(git_config, "interactive-rebase-tool.inputActionIndex", "i")?,
 			action_pick: get_input(git_config, "interactive-rebase-tool.inputActionPick", "p")?,
 			action_reword: get_input(git_config, "interactive-rebase-tool.inputActionReword", "r")?,
 			action_squash: get_input(git_config, "interactive-rebase-tool.inputActionSquash", "s")?,
@@ -256,6 +259,7 @@ mod tests {
 		config_test!(action_drop, "inputActionDrop", "d");
 		config_test!(action_edit, "inputActionEdit", "e");
 		config_test!(action_fixup, "inputActionFixup", "f");
+		config_test!(action_index, "inputActionIndex", "i");
 		config_test!(action_pick, "inputActionPick", "p");
 		config_test!(action_reword, "inputActionReword", "r");
 		config_test!(action_squash, "inputActionSquash", "s");

src/config/src/theme.rs

@@ -38,6 +38,8 @@ pub struct Theme {
 	pub color_action_exec: Color,
 	/// The color for the fixup action.
 	pub color_action_fixup: Color,
+	/// The color for the fixup action.
+	pub color_action_index: Color,
 	/// The color for the pick action.
 	pub color_action_pick: Color,
 	/// The color for the reword action.
@@ -94,6 +96,7 @@ impl Theme {
 			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)?,
 			color_action_fixup: get_color(git_config, "interactive-rebase-tool.fixupColor", Color::LightMagenta)?,
+			color_action_index: get_color(git_config, "interactive-rebase-tool.indexColor", Color::DarkGreen)?,
 			color_action_pick: get_color(git_config, "interactive-rebase-tool.pickColor", Color::LightGreen)?,
 			color_action_reword: get_color(git_config, "interactive-rebase-tool.rewordColor", Color::LightYellow)?,
 			color_action_squash: get_color(git_config, "interactive-rebase-tool.squashColor", Color::LightCyan)?,
@@ -219,6 +222,7 @@ mod tests {
 		config_test!(color_action_edit, "editColor", Color::LightBlue);
 		config_test!(color_action_exec, "execColor", Color::LightWhite);
 		config_test!(color_action_fixup, "fixupColor", Color::LightMagenta);
+		config_test!(color_action_index, "indexColor", Color::DarkGreen);
 		config_test!(color_action_pick, "pickColor", Color::LightGreen);
 		config_test!(color_action_reword, "rewordColor", Color::LightYellow);
 		config_test!(color_action_squash, "squashColor", Color::LightCyan);

src/core/src/events/app_key_bindings.rs

@@ -21,6 +21,8 @@ pub(crate) struct AppKeyBindings {
 	pub(crate) action_edit: Vec<Event>,
 	/// Key bindings for the fixup action.
 	pub(crate) action_fixup: Vec<Event>,
+	/// Key bindings for the index action.
+	pub(crate) action_index: Vec<Event>,
 	/// Key bindings for the pick action.
 	pub(crate) action_pick: Vec<Event>,
 	/// Key bindings for the reword action.
@@ -84,6 +86,7 @@ impl CustomKeybinding for AppKeyBindings {
 			action_drop: map_keybindings(&key_bindings.action_drop),
 			action_edit: map_keybindings(&key_bindings.action_edit),
 			action_fixup: map_keybindings(&key_bindings.action_fixup),
+			action_index: map_keybindings(&key_bindings.action_index),
 			action_pick: map_keybindings(&key_bindings.action_pick),
 			action_reword: map_keybindings(&key_bindings.action_reword),
 			action_squash: map_keybindings(&key_bindings.action_squash),

src/core/src/events/meta_event.rs

@@ -18,6 +18,8 @@ pub(crate) enum MetaEvent {
 	ActionEdit,
 	/// The fixup action meta event.
 	ActionFixup,
+	/// The index (git-revise) action meta event.
+	ActionIndex,
 	/// The pick action meta event.
 	ActionPick,
 	/// The reword action meta event.

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

@@ -520,6 +520,7 @@ impl List {
 			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),
+			e if key_bindings.custom.action_index.contains(&e) => Event::from(MetaEvent::ActionIndex),
 			e if key_bindings.custom.action_pick.contains(&e) => Event::from(MetaEvent::ActionPick),
 			e if key_bindings.custom.action_reword.contains(&e) => Event::from(MetaEvent::ActionReword),
 			e if key_bindings.custom.action_squash.contains(&e) => Event::from(MetaEvent::ActionSquash),
@@ -608,6 +609,7 @@ impl List {
 					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),
+					MetaEvent::ActionIndex => self.set_selected_line_action(Action::Index),
 					MetaEvent::ActionPick => self.set_selected_line_action(Action::Pick),
 					MetaEvent::ActionReword => self.set_selected_line_action(Action::Reword),
 					MetaEvent::ActionSquash => self.set_selected_line_action(Action::Squash),

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",
+				" 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",
 				" Delete  |Completely remove the selected lines",
@@ -108,6 +109,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",
+				" i       |Set selected commits to be staged in the index (git-revise)",
 				" Delete  |Completely remove the selected lines",
 				" Controlz|Undo the last change",
 				" Controly|Redo the previous undone 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::actionindex('i', MetaEvent::ActionIndex)]
 #[case::edit('E', MetaEvent::Edit)]
 #[case::forceabort('Q', MetaEvent::ForceAbort)]
 #[case::forcerebase('W', MetaEvent::ForceRebase)]

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_index,
+			"Set selected commits to be staged in the index (git-revise)",
+			HelpLinesSelector::Common,
+		),
 		(
 			&key_bindings.edit,
 			"Edit an exec, label, reset or merge action's content",
@@ -184,6 +189,7 @@ const fn get_action_color(action: Action) -> DisplayColor {
 		Action::Edit => DisplayColor::ActionEdit,
 		Action::Exec => DisplayColor::ActionExec,
 		Action::Fixup => DisplayColor::ActionFixup,
+		Action::Index => DisplayColor::ActionIndex,
 		Action::Pick => DisplayColor::ActionPick,
 		Action::Reword => DisplayColor::ActionReword,
 		Action::Squash => DisplayColor::ActionSquash,
@@ -204,7 +210,7 @@ pub(super) fn get_line_action_maximum_width(todo_file: &TodoFile) -> usize {
 			// allow these to overflow their bounds
 			&Action::Exec | &Action::UpdateRef => 0,
 			&Action::Drop | &Action::Edit | &Action::Noop | &Action::Pick => 4,
-			&Action::Break | &Action::Label | &Action::Reset | &Action::Merge => 5,
+			&Action::Break | &Action::Label | &Action::Reset | &Action::Merge | &Action::Index => 5,
 			&Action::Fixup => {
 				if line.option().is_some() {
 					8 // "fixup -C" = 8
@@ -293,7 +299,7 @@ pub(super) fn get_todo_line_segments(
 
 	// render hash
 	match *action {
-		Action::Drop | Action::Edit | Action::Fixup | Action::Pick | Action::Reword | Action::Squash => {
+		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

@@ -13,6 +13,7 @@ pub(crate) fn create_test_custom_keybindings() -> AppKeyBindings {
 		action_drop: vec![Event::from(KeyCode::Char('d'))],
 		action_edit: vec![Event::from(KeyCode::Char('e'))],
 		action_fixup: vec![Event::from(KeyCode::Char('f'))],
+		action_index: vec![Event::from(KeyCode::Char('i'))],
 		action_pick: vec![Event::from(KeyCode::Char('p'))],
 		action_reword: vec![Event::from(KeyCode::Char('r'))],
 		action_squash: vec![Event::from(KeyCode::Char('s'))],

src/display/src/display_color.rs

@@ -12,6 +12,8 @@ pub enum DisplayColor {
 	ActionExec,
 	/// The color for the fixup action.
 	ActionFixup,
+	/// The color for the index action.
+	ActionIndex,
 	/// The color for the pick action.
 	ActionPick,
 	/// The color for the reword action.

src/display/src/lib.rs

@@ -178,6 +178,7 @@ pub struct Display<T: Tui> {
 	action_edit: (Colors, Colors),
 	action_exec: (Colors, Colors),
 	action_fixup: (Colors, Colors),
+	action_index: (Colors, Colors),
 	action_label: (Colors, Colors),
 	action_merge: (Colors, Colors),
 	action_pick: (Colors, Colors),
@@ -242,6 +243,12 @@ impl<T: Tui> Display<T> {
 			theme.color_background,
 			theme.color_selected_background,
 		);
+		let action_index = register_selectable_color_pairs(
+			color_mode,
+			theme.color_action_index,
+			theme.color_background,
+			theme.color_selected_background,
+		);
 		let action_pick = register_selectable_color_pairs(
 			color_mode,
 			theme.color_action_pick,
@@ -321,6 +328,7 @@ impl<T: Tui> Display<T> {
 			action_edit,
 			action_exec,
 			action_fixup,
+			action_index,
 			action_label,
 			action_merge,
 			action_pick,
@@ -385,6 +393,7 @@ impl<T: Tui> Display<T> {
 					DisplayColor::ActionEdit => self.action_edit.1,
 					DisplayColor::ActionExec => self.action_exec.1,
 					DisplayColor::ActionFixup => self.action_fixup.1,
+					DisplayColor::ActionIndex => self.action_index.1,
 					DisplayColor::ActionPick => self.action_pick.1,
 					DisplayColor::ActionReword => self.action_reword.1,
 					DisplayColor::ActionSquash => self.action_squash.1,
@@ -408,6 +417,7 @@ impl<T: Tui> Display<T> {
 					DisplayColor::ActionEdit => self.action_edit.0,
 					DisplayColor::ActionExec => self.action_exec.0,
 					DisplayColor::ActionFixup => self.action_fixup.0,
+					DisplayColor::ActionIndex => self.action_index.0,
 					DisplayColor::ActionPick => self.action_pick.0,
 					DisplayColor::ActionReword => self.action_reword.0,
 					DisplayColor::ActionSquash => self.action_squash.0,
@@ -575,6 +585,13 @@ mod tests {
 		CrosstermColor::Magenta,
 		CrosstermColor::AnsiValue(237)
 	)]
+	#[case::action_index(DisplayColor::ActionIndex, false, CrosstermColor::DarkGreen, CrosstermColor::Reset)]
+	#[case::action_index_selected(
+		DisplayColor::ActionIndex,
+		true,
+		CrosstermColor::DarkGreen,
+		CrosstermColor::AnsiValue(237)
+	)]
 	#[case::action_pick(DisplayColor::ActionPick, false, CrosstermColor::Green, CrosstermColor::Reset)]
 	#[case::action_pick_selected(
 		DisplayColor::ActionPick,

src/todo_file/src/action.rs

@@ -16,6 +16,8 @@ pub enum Action {
 	Exec,
 	/// A fixup action.
 	Fixup,
+	/// A index action for git-revise.
+	Index,
 	/// A noop action.
 	Noop,
 	/// A pick action.
@@ -45,6 +47,7 @@ impl Action {
 			Self::Edit => "e",
 			Self::Exec => "x",
 			Self::Fixup => "f",
+			Self::Index => "i",
 			Self::Label => "l",
 			Self::Merge => "m",
 			Self::Noop => "n",
@@ -62,7 +65,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::Fixup | Self::Pick | Self::Reword | Self::Squash => false,
+			Self::Drop | Self::Edit | Self::Index | Self::Fixup | Self::Pick | Self::Reword | Self::Squash => false,
 		}
 	}
 }
@@ -76,6 +79,7 @@ impl Display for Action {
 			Self::Edit => "edit",
 			Self::Exec => "exec",
 			Self::Fixup => "fixup",
+			Self::Index => "index",
 			Self::Label => "label",
 			Self::Merge => "merge",
 			Self::Noop => "noop",
@@ -95,10 +99,12 @@ impl TryFrom<&str> for Action {
 	fn try_from(s: &str) -> Result<Self, Self::Error> {
 		match s {
 			"break" | "b" => Ok(Self::Break),
+			// "cut" => Ok(Self::Cut),
 			"drop" | "d" => Ok(Self::Drop),
 			"edit" | "e" => Ok(Self::Edit),
 			"exec" | "x" => Ok(Self::Exec),
 			"fixup" | "f" => Ok(Self::Fixup),
+			"index" => Ok(Self::Index),
 			"noop" | "n" => Ok(Self::Noop),
 			"pick" | "p" => Ok(Self::Pick),
 			"reword" | "r" => Ok(Self::Reword),

src/todo_file/src/lib.rs

@@ -282,6 +282,7 @@ impl TodoFile {
 								Action::Drop
 								| Action::Fixup
 								| Action::Edit
+								| Action::Index
 								| Action::Pick
 								| Action::Reword
 								| Action::Squash => {

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::Pick | Action::Reword | Action::Edit | Action::Squash | Action::Drop | Action::Index => {
 				Self::new(action, line_parser.next()?, line_parser.take_remaining(), None)
 			},
 			Action::Fixup => {
@@ -207,7 +207,7 @@ impl Line {
 	#[inline]
 	pub const fn is_editable(&self) -> bool {
 		match self.action {
-			Action::Exec | Action::Label | Action::Reset | Action::Merge | Action::UpdateRef => true,
+			Action::Exec | Action::Index | Action::Label | Action::Reset | Action::Merge | Action::UpdateRef => true,
 			Action::Break
 			| Action::Drop
 			| Action::Edit
@@ -231,7 +231,7 @@ impl Line {
 	#[inline]
 	pub fn to_text(&self) -> String {
 		match self.action {
-			Action::Drop | Action::Edit | Action::Fixup | Action::Pick | Action::Reword | Action::Squash => {
+			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

@@ -40,6 +40,7 @@ impl Search {
 					Action::Drop
 					| Action::Edit
 					| Action::Fixup
+					| Action::Index
 					| Action::Pick
 					| Action::Reword
 					| Action::Squash

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::ActionIndex => String::from("ActionIndex"),
 		DisplayColor::ActionLabel => String::from("ActionLabel"),
 		DisplayColor::ActionReset => String::from("ActionReset"),
 		DisplayColor::ActionMerge => String::from("ActionMerge"),