// Copyright 2020 The Jujutsu Authors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // https://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. use std::io::Write; use itertools::Itertools; use jj_lib::object_id::ObjectId; use tracing::instrument; use crate::cli_util::{print_conflicted_paths, CommandHelper, RevisionArg}; use crate::command_error::{cli_error, CommandError}; use crate::ui::Ui; /// Resolve a conflicted file with an external merge tool /// /// Only conflicts that can be resolved with a 3-way merge are supported. See /// docs for merge tool configuration instructions. /// /// Note that conflicts can also be resolved without using this command. You may /// edit the conflict markers in the conflicted file directly with a text /// editor. // TODOs: // - `jj resolve --editor` to resolve a conflict in the default text editor. Should work for // conflicts with 3+ adds. Useful to resolve conflicts in a commit other than the current one. // - A way to help split commits with conflicts that are too complicated (more than two sides) // into commits with simpler conflicts. In case of a tree with many merges, we could for example // point to existing commits with simpler conflicts where resolving those conflicts would help // simplify the present one. #[derive(clap::Args, Clone, Debug)] pub(crate) struct ResolveArgs { #[arg(long, short, default_value = "@")] revision: RevisionArg, /// Instead of resolving one conflict, list all the conflicts // TODO: Also have a `--summary` option. `--list` currently acts like // `diff --summary`, but should be more verbose. #[arg(long, short)] list: bool, /// Specify 3-way merge tool to be used #[arg(long, conflicts_with = "list", value_name = "NAME")] tool: Option, /// Restrict to these paths when searching for a conflict to resolve. We /// will attempt to resolve the first conflict we can find. You can use /// the `--list` argument to find paths to use here. // TODO: Find the conflict we can resolve even if it's not the first one. #[arg(value_hint = clap::ValueHint::AnyPath)] paths: Vec, } #[instrument(skip_all)] pub(crate) fn cmd_resolve( ui: &mut Ui, command: &CommandHelper, args: &ResolveArgs, ) -> Result<(), CommandError> { let mut workspace_command = command.workspace_helper(ui)?; let matcher = workspace_command .parse_file_patterns(&args.paths)? .to_matcher(); let commit = workspace_command.resolve_single_rev(&args.revision)?; let tree = commit.tree()?; let conflicts = tree .conflicts() .filter(|path| matcher.matches(&path.0)) .collect_vec(); if conflicts.is_empty() { return Err(cli_error(if args.paths.is_empty() { "No conflicts found at this revision" } else { "No conflicts found at the given path(s)" })); } if args.list { return print_conflicted_paths( &conflicts, ui.stdout_formatter().as_mut(), &workspace_command, ); }; let (repo_path, _) = conflicts.first().unwrap(); workspace_command.check_rewritable([commit.id()])?; let merge_editor = workspace_command.merge_editor(ui, args.tool.as_deref())?; writeln!( ui.status(), "Resolving conflicts in: {}", workspace_command.format_file_path(repo_path) )?; let mut tx = workspace_command.start_transaction(); let new_tree_id = merge_editor.edit_file(&tree, repo_path)?; let new_commit = tx .mut_repo() .rewrite_commit(command.settings(), &commit) .set_tree_id(new_tree_id) .write()?; tx.finish( ui, format!("Resolve conflicts in commit {}", commit.id().hex()), )?; // Print conflicts that are still present after resolution if the workspace // working copy is not at the commit. Otherwise, the conflicting paths will // be printed by the `tx.finish()` instead. if workspace_command.get_wc_commit_id() != Some(new_commit.id()) { if let Some(mut formatter) = ui.status_formatter() { let new_tree = new_commit.tree()?; let new_conflicts = new_tree.conflicts().collect_vec(); if !new_conflicts.is_empty() { writeln!( formatter, "After this operation, some files at this revision still have conflicts:" )?; print_conflicted_paths(&new_conflicts, formatter.as_mut(), &workspace_command)?; } } } Ok(()) }