feat: add cherry-pick command and status display

Author: altsem

src/default_config.toml

@@ -227,6 +227,15 @@ revert_menu.revert_continue = ["c"]
 revert_menu.revert_commit = ["V"]
 revert_menu.quit = ["q", "esc"]
 
+root.cherry_pick_menu = ["A"]
+cherry_pick_menu.--no-commit = ["-n"]
+cherry_pick_menu.--signoff = ["-s"]
+cherry_pick_menu.--edit = ["-e"]
+cherry_pick_menu.cherry_pick_abort = ["a"]
+cherry_pick_menu.cherry_pick_continue = ["c"]
+cherry_pick_menu.cherry_pick = ["A"]
+cherry_pick_menu.quit = ["q", "esc"]
+
 root.stash_menu = ["z"]
 stash_menu.--all = ["-a"]
 stash_menu.--include-untracked = ["-u"]

src/git/mod.rs

@@ -111,6 +111,34 @@ pub(crate) fn revert_status(repo: &Repository) -> Res<Option<RevertStatus>> {
  }
 }
 
+#[derive(Debug, Clone)]
+pub(crate) struct CherryPickStatus {
+ pub head: String,
+}
+
+pub(crate) fn cherry_pick_status(repo: &Repository) -> Res<Option<CherryPickStatus>> {
+ let dir = repo.workdir().expect("No workdir");
+ let mut cherry_pick_head_file = dir.to_path_buf();
+ cherry_pick_head_file.push(".git/CHERRY_PICK_HEAD");
+
+ match fs::read_to_string(&cherry_pick_head_file) {
+ Ok(content) => {
+ let head = content.trim().to_string();
+ Ok(Some(CherryPickStatus {
+ head: branch_name_lossy(dir, &head)?.unwrap_or(head[..7].to_string()),
+ }))
+ }
+ Err(err) => {
+ log::warn!(
+ "Couldn't read {}, due to {}",
+ cherry_pick_head_file.to_string_lossy(),
+ err
+ );
+ Ok(None)
+ }
+ }
+}
+
 fn branch_name_lossy(dir: &Path, hash: &str) -> Res<Option<String>> {
  let out = Command::new("git")
  .args(["for-each-ref", "--format", "%(objectname) %(refname:short)"])

src/item_data.rs

@@ -149,6 +149,7 @@ pub(crate) enum SectionHeader {
  Rebase(String, String),
  Merge(String),
  Revert(String),
+ CherryPick(String),
  Stashes,
  RecentCommits,
  Commit(String),

src/items.rs

@@ -145,6 +145,7 @@ impl Item {
  SectionHeader::Rebase(head, onto) => format!("Rebasing {head} onto {onto}"),
  SectionHeader::Merge(head) => format!("Merging {head}"),
  SectionHeader::Revert(head) => format!("Reverting {head}"),
+ SectionHeader::CherryPick(head) => format!("Cherry-picking {head}"),
  SectionHeader::Stashes => "Stashes".to_string(),
  SectionHeader::RecentCommits => "Recent commits".to_string(),
  SectionHeader::Commit(oid) => format!("commit {oid}"),

src/menu.rs

@@ -51,6 +51,9 @@ pub(crate) enum Menu {
  #[serde(rename = "revert_menu")]
  #[strum(serialize = "revert_menu")]
  Revert,
+ #[serde(rename = "cherry_pick_menu")]
+ #[strum(serialize = "cherry_pick_menu")]
+ CherryPick,
  #[serde(rename = "stash_menu")]
  #[strum(serialize = "stash_menu")]
  Stash,
@@ -81,6 +84,7 @@ impl PendingMenu {
  Menu::Remote => vec![],
  Menu::Reset => ops::reset::init_args(),
  Menu::Revert => ops::revert::init_args(),
+ Menu::CherryPick => ops::cherry_pick::init_args(),
  Menu::Stash => ops::stash::init_args(),
  }
  .into_iter()

src/ops/cherry_pick.rs

@@ -0,0 +1,87 @@
+use std::{process::Command, rc::Rc};
+
+use crate::{
+ Res,
+ app::{App, PromptParams, State},
+ item_data::{ItemData, Rev},
+ menu::arg::Arg,
+ term::Term,
+};
+
+use super::{Action, OpTrait, selected_rev};
+
+pub(crate) fn init_args() -> Vec<Arg> {
+ vec![
+ Arg::new_flag("--no-commit", "Don't commit", false),
+ Arg::new_flag("--signoff", "Add Signed-off-by lines", false),
+ Arg::new_flag("--edit", "Edit commit message", false),
+ ]
+}
+
+pub(crate) struct CherryPickAbort;
+impl OpTrait for CherryPickAbort {
+ fn get_action(&self, _target: &ItemData) -> Option<Action> {
+ Some(Rc::new(|app: &mut App, term: &mut Term| {
+ let mut cmd = Command::new("git");
+ cmd.args(["cherry-pick", "--abort"]);
+ app.run_cmd_interactive(term, cmd)?;
+ Ok(())
+ }))
+ }
+
+ fn display(&self, _state: &State) -> String {
+ "Abort".into()
+ }
+}
+
+pub(crate) struct CherryPickContinue;
+impl OpTrait for CherryPickContinue {
+ fn get_action(&self, _target: &ItemData) -> Option<Action> {
+ Some(Rc::new(|app: &mut App, term: &mut Term| {
+ let mut cmd = Command::new("git");
+ cmd.args(["cherry-pick", "--continue"]);
+ app.run_cmd_interactive(term, cmd)?;
+ Ok(())
+ }))
+ }
+
+ fn display(&self, _state: &State) -> String {
+ "Continue".into()
+ }
+}
+
+pub(crate) struct CherryPick;
+impl OpTrait for CherryPick {
+ fn get_action(&self, _target: &ItemData) -> Option<Action> {
+ Some(Rc::new(move |app: &mut App, term: &mut Term| {
+ let commit = app.prompt(
+ term,
+ &PromptParams {
+ prompt: "Cherry-pick commit",
+ create_default_value: Box::new(|app| {
+ selected_rev(app)
+ .as_ref()
+ .map(Rev::shorthand)
+ .map(String::from)
+ }),
+ ..Default::default()
+ },
+ )?;
+
+ cherry_pick(app, term, &commit)?;
+ Ok(())
+ }))
+ }
+
+ fn display(&self, _state: &State) -> String {
+ "Cherry-pick commit(s)".into()
+ }
+}
+
+fn cherry_pick(app: &mut App, term: &mut Term, input: &str) -> Res<()> {
+ let mut cmd = Command::new("git");
+ cmd.arg("cherry-pick");
+ cmd.args(app.state.pending_menu.as_ref().unwrap().args());
+ cmd.arg(input);
+ app.run_cmd_interactive(term, cmd)
+}

src/ops/mod.rs

@@ -10,6 +10,7 @@ use crate::{
 use std::{fmt::Display, rc::Rc};
 
 pub(crate) mod branch;
+pub(crate) mod cherry_pick;
 pub(crate) mod commit;
 pub(crate) mod copy_hash;
 pub(crate) mod discard;
@@ -93,6 +94,9 @@ pub(crate) enum Op {
  RevertAbort,
  RevertContinue,
  RevertCommit,
+ CherryPickAbort,
+ CherryPickContinue,
+ CherryPick,
  Merge,
  MergeAbort,
  MergeContinue,
@@ -186,6 +190,9 @@ impl Op {
  Op::RevertAbort => Box::new(revert::RevertAbort),
  Op::RevertContinue => Box::new(revert::RevertContinue),
  Op::RevertCommit => Box::new(revert::RevertCommit),
+ Op::CherryPickAbort => Box::new(cherry_pick::CherryPickAbort),
+ Op::CherryPickContinue => Box::new(cherry_pick::CherryPickContinue),
+ Op::CherryPick => Box::new(cherry_pick::CherryPick),
  Op::Show => Box::new(show::Show),
  Op::Stage => Box::new(stage::Stage),
  Op::Unstage => Box::new(unstage::Unstage),
@@ -218,6 +225,7 @@ impl Display for Menu {
  Menu::Rebase => "Rebase",
  Menu::Reset => "Reset",
  Menu::Revert => "Revert",
+ Menu::CherryPick => "Cherry-pick",
  Menu::Stash => "Stash",
  })
  }

src/screen/status.rs

@@ -15,6 +15,7 @@ enum SectionID {
  RebaseStatus,
  MergeStatus,
  RevertStatus,
+ CherryPickStatus,
  Untracked,
  Stashes,
  RecentCommits,
@@ -29,6 +30,7 @@ impl Hash for SectionID {
  SectionID::RebaseStatus => "rebase_status",
  SectionID::MergeStatus => "merge_status",
  SectionID::RevertStatus => "revert_status",
+ SectionID::CherryPickStatus => "cherry_pick_status",
  SectionID::Untracked => "untracked",
  SectionID::Stashes => "stashes",
  SectionID::RecentCommits => "recent_commits",
@@ -77,6 +79,13 @@ pub(crate) fn create(config: Arc<Config>, repo: Rc<Repository>, size: Size) -> R
  ..Default::default()
  }]
  .into_iter()
+ } else if let Some(cherry_pick) = git::cherry_pick_status(&repo)? {
+ vec![Item {
+ id: hash(SectionID::CherryPickStatus),
+ data: ItemData::Header(SectionHeader::CherryPick(cherry_pick.head)),
+ ..Default::default()
+ }]
+ .into_iter()
  } else {
  branch_status_items(&status.branch_status)?.into_iter()
  }

src/tests/cherry_pick.rs

@@ -0,0 +1,67 @@
+use super::*;
+
+fn setup_cherry_pickable(ctx: TestContext) -> TestContext {
+ run(&ctx.dir, &["git", "checkout", "-b", "other-branch"]);
+ commit(&ctx.dir, "cherry-file", "cherry content");
+ run(&ctx.dir, &["git", "checkout", "main"]);
+ ctx
+}
+
+fn setup_conflict(ctx: TestContext) -> TestContext {
+ commit(&ctx.dir, "conflict-file", "hello");
+ run(&ctx.dir, &["git", "checkout", "-b", "other-branch"]);
+ commit(&ctx.dir, "conflict-file", "hey");
+ run(&ctx.dir, &["git", "checkout", "main"]);
+ commit(&ctx.dir, "conflict-file", "hi");
+ run_ignore_status(&ctx.dir, &["git", "cherry-pick", "other-branch"]);
+ ctx
+}
+
+#[test]
+fn cherry_pick_menu() {
+ snapshot!(setup_clone!(), "A");
+}
+
+#[test]
+fn cherry_pick_prompt() {
+ // Navigate to the log, select the initial commit, then open cherry-pick prompt
+ snapshot!(setup_cherry_pickable(setup_clone!()), "llAA");
+}
+
+#[test]
+fn cherry_pick_prompt_cancel() {
+ snapshot!(setup_cherry_pickable(setup_clone!()), "llAA<esc>");
+}
+
+#[test]
+fn cherry_pick() {
+ snapshot!(
+ setup_cherry_pickable(setup_clone!()),
+ "llAAother-branch<enter>"
+ );
+}
+
+#[test]
+fn cherry_pick_no_commit() {
+ snapshot!(
+ setup_cherry_pickable(setup_clone!()),
+ "llA-nAAother-branch<enter>"
+ );
+}
+
+#[test]
+fn cherry_pick_conflict_status() {
+ let mut ctx = setup_conflict(setup_clone!());
+ ctx.init_app();
+ insta::assert_snapshot!(ctx.redact_buffer());
+}
+
+#[test]
+fn cherry_pick_abort() {
+ snapshot!(setup_conflict(setup_clone!()), "Aa");
+}
+
+#[test]
+fn cherry_pick_continue() {
+ snapshot!(setup_conflict(setup_clone!()), "Ac");
+}

src/tests/mod.rs

@@ -15,6 +15,7 @@ use std::fs;
 mod helpers;
 mod arg;
 mod branch;
+mod cherry_pick;
 mod commit;
 mod discard;
 mod editor;