refactor: add force_detach checkout option

This will be used to circumvent the "autocheckout" setting in `git split` (in
the next commit), so that we can preserve the current detached/attached state.

FIXME is this really needed? Maybe we don't need to force-re-checkout?

Author: claytonrcarter

git-branchless-lib/src/core/check_out.rs

@@ -44,6 +44,9 @@ pub struct CheckOutCommitOptions {
     /// Additional arguments to pass to `git checkout`.
     pub additional_args: Vec<OsString>,
 
+    /// Ignore the `autoSwitchBranches` setting?
+    pub force_detach: bool,
+
     /// Use `git reset` rather than `git checkout`; that is, leave the index and
     /// working copy unchanged, and just adjust the `HEAD` pointer.
     pub reset: bool,
@@ -56,6 +59,7 @@ impl Default for CheckOutCommitOptions {
     fn default() -> Self {
         Self {
             additional_args: Default::default(),
+            force_detach: false,
             reset: false,
             render_smartlog: true,
         }
@@ -116,6 +120,7 @@ pub fn check_out_commit(
 ) -> EyreExitOr<()> {
     let CheckOutCommitOptions {
         additional_args,
+        force_detach,
         reset,
         render_smartlog,
     } = options;
@@ -134,7 +139,7 @@ pub fn check_out_commit(
         create_snapshot(effects, git_run_info, repo, event_log_db, event_tx_id)?;
     }
 
-    let target = if get_auto_switch_branches(repo)? && !reset {
+    let target = if get_auto_switch_branches(repo)? && !reset && !force_detach {
         maybe_get_branch_name(target, oid, repo)?
     } else {
         target

git-branchless-lib/tests/test_rewrite_plan.rs

@@ -762,6 +762,7 @@ fn create_and_execute_plan(
         resolve_merge_conflicts: true,
         check_out_commit_options: CheckOutCommitOptions {
             additional_args: Default::default(),
+            force_detach: false,
             reset: false,
             render_smartlog: false,
         },

git-branchless-navigation/src/lib.rs

@@ -617,6 +617,7 @@ pub fn switch(
         target,
         &CheckOutCommitOptions {
             additional_args,
+            force_detach: false,
             reset: false,
             render_smartlog: true,
         },

git-branchless-record/src/lib.rs

@@ -129,6 +129,7 @@ fn record(
             None,
             &CheckOutCommitOptions {
                 additional_args: vec![OsString::from("-b"), OsString::from(branch_name)],
+                force_detach: false,
                 reset: false,
                 render_smartlog: false,
             },
@@ -227,6 +228,7 @@ fn record(
                 checkout_target,
                 &CheckOutCommitOptions {
                     additional_args: vec![],
+                    force_detach: false,
                     reset: false,
                     render_smartlog: false,
                 },

git-branchless-reword/src/lib.rs

@@ -292,6 +292,7 @@ pub fn reword(
         resolve_merge_conflicts: false,
         check_out_commit_options: CheckOutCommitOptions {
             additional_args: Default::default(),
+            force_detach: false,
             reset: false,
             render_smartlog: false,
         },

git-branchless-undo/src/lib.rs

@@ -743,6 +743,7 @@ fn extract_checkout_target(
                     target: CheckoutTarget::Oid(*new_oid),
                     options: CheckOutCommitOptions {
                         additional_args: vec!["--detach".into()],
+                        force_detach: false,
                         reset: false,
                         render_smartlog: true,
                     },
@@ -766,6 +767,7 @@ fn extract_checkout_target(
                             }
                             None => Default::default(),
                         },
+                        force_detach: false,
                         reset: false,
                         render_smartlog: true,
                     },
@@ -1077,6 +1079,7 @@ mod tests {
                         additional_args: [
                             "--detach",
                         ],
+                        force_detach: false,
                         reset: false,
                         render_smartlog: true,
                     },

git-branchless/src/commands/amend.rs

@@ -203,6 +203,7 @@ pub fn amend(
             Some(target),
             &CheckOutCommitOptions {
                 additional_args: Default::default(),
+                force_detach: false,
                 reset: true,
                 render_smartlog: false,
             },
@@ -297,6 +298,7 @@ pub fn amend(
             resolve_merge_conflicts: move_options.resolve_merge_conflicts,
             check_out_commit_options: CheckOutCommitOptions {
                 additional_args: Default::default(),
+                force_detach: false,
                 reset: false,
                 render_smartlog: false,
             },

git-branchless/src/commands/restack.rs

@@ -328,6 +328,7 @@ pub fn restack(
         resolve_merge_conflicts,
         check_out_commit_options: CheckOutCommitOptions {
             additional_args: Default::default(),
+            force_detach: false,
             reset: false,
             render_smartlog: false,
         },

git-branchless/src/commands/sync.rs

@@ -94,6 +94,7 @@ pub fn sync(
         resolve_merge_conflicts,
         check_out_commit_options: CheckOutCommitOptions {
             additional_args: Default::default(),
+            force_detach: false,
             reset: false,
             render_smartlog: false,
         },