// 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 clap_complete::ArgValueCandidates;use clap_complete::ArgValueCompleter;use indoc::writedoc;use jj_lib::backend::Signature;use jj_lib::merge::Diff;use jj_lib::object_id::ObjectId as _;use jj_lib::repo::Repo as _;use tracing::instrument; use crate::cli_util::CommandHelper;use crate::command_error::CommandError;use crate::command_error::user_error;use crate::complete;use crate::description_util::add_trailers;use crate::description_util::description_template;use crate::description_util::edit_description;use crate::description_util::join_message_paragraphs;use crate::text_util::parse_author;use crate::ui::Ui; /// Update the description and create a new change on top [default alias: ci]////// When called without path arguments or `--interactive`, `jj commit` is/// equivalent to `jj describe` followed by `jj new`.////// When using `--interactive` or path arguments, the selected changes stay in/// the current commit while the remaining changes are moved to a new/// working-copy commit on top. This is very similar to `jj split`. Differences/// include:////// * `jj commit` is not interactive by default (it selects all changes).////// * `jj commit` doesn't have a `-r` option. It always acts on the working-copy/// commit (@).////// * `jj split` (without `-o`/`-A`/`-B`) will move bookmarks forward from the/// old change to the child change. `jj commit` doesn't move bookmarks/// forward.////// * `jj split` allows you to move the selected changes to a different/// destination with `-o`/`-A`/`-B`.#[derive(clap::Args, Clone, Debug)]pub(crate) struct CommitArgs { /// Interactively choose which changes to include in the current commit #[arg(short, long)] interactive: bool, /// Specify diff editor to be used (implies --interactive) #[arg(long, value_name = "NAME")] #[arg(add = ArgValueCandidates::new(complete::diff_editors))] tool: Option<String>, /// The change description to use (don't open editor) #[arg(long = "message", short, value_name = "MESSAGE")] message_paragraphs: Option<Vec<String>>, /// Open an editor to edit the change description /// /// Forces an editor to open when using `--message` to allow the /// message to be edited afterwards. #[arg(long)] editor: bool, /// Put these paths in the current commit #[arg(value_name = "FILESETS", value_hint = clap::ValueHint::AnyPath)] #[arg(add = ArgValueCompleter::new(complete::modified_files))] paths: Vec<String>, // TODO: Delete in jj 0.40.0+ /// Reset the author to the configured user /// /// This resets the author name, email, and timestamp. /// /// You can use it in combination with the JJ_USER and JJ_EMAIL /// environment variables to set a different author: /// /// $ JJ_USER='Foo Bar' JJ_EMAIL=foo@bar.com jj commit --reset-author #[arg(long, hide = true)] reset_author: bool, // TODO: Delete in jj 0.40.0+ /// Set author to the provided string /// /// This changes author name and email while retaining author /// timestamp for non-discardable commits. #[arg( long, hide = true, conflicts_with = "reset_author", value_parser = parse_author )] author: Option<(String, String)>,} #[instrument(skip_all)]pub(crate) async fn cmd_commit( ui: &mut Ui, command: &CommandHelper, args: &CommitArgs,) -> Result<(), CommandError> { if args.reset_author { writeln!( ui.warning_default(), "`jj commit --reset-author` is deprecated; use `jj metaedit --update-author` instead" )?; } if args.author.is_some() { writeln!( ui.warning_default(), "`jj commit --author` is deprecated; use `jj metaedit --author` instead" )?; } let mut workspace_command = command.workspace_helper(ui)?; let commit_id = workspace_command .get_wc_commit_id() .ok_or_else(|| user_error("This command requires a working copy"))?; let commit = workspace_command.repo().store().get_commit(commit_id)?; let matcher = workspace_command .parse_file_patterns(ui, &args.paths)? .to_matcher(); let advanceable_bookmarks = workspace_command.get_advanceable_bookmarks(ui, commit.parent_ids())?; let diff_selector = workspace_command.diff_selector(ui, args.tool.as_deref(), args.interactive)?; let text_editor = workspace_command.text_editor()?; let mut tx = workspace_command.start_transaction(); let base_tree = commit.parent_tree(tx.repo()).await?; let format_instructions = || { format!( "\You are splitting the working-copy commit: {} The diff initially shows all changes. Adjust the right side until it shows thecontents you want for the first commit. The remainder will be included in thenew working-copy commit.", tx.format_commit_summary(&commit) ) }; let tree = diff_selector.select( ui, Diff::new(&base_tree, &commit.tree()), Diff::new(commit.parents_conflict_label()?, commit.conflict_label()), matcher.as_ref(), format_instructions, )?; if !args.paths.is_empty() && tree.tree_ids() == base_tree.tree_ids() { writeln!( ui.warning_default(), "The given paths do not match any file: {}", args.paths.join(" ") )?; } let mut commit_builder = tx.repo_mut().rewrite_commit(&commit).detach(); commit_builder.set_tree(tree); if args.reset_author { commit_builder.set_author(commit_builder.committer().clone()); } if let Some((name, email)) = args.author.clone() { let new_author = Signature { name, email, timestamp: commit_builder.author().timestamp, }; commit_builder.set_author(new_author); } let use_editor = args.message_paragraphs.is_none() || args.editor; let description = match &args.message_paragraphs { Some(paragraphs) => join_message_paragraphs(paragraphs), None => commit_builder.description().to_owned(), }; // The first trailer would become the first line of the description. Also, a // commit with no description is treated in a special way in jujutsu: it can // be discarded as soon as it's no longer the working copy. Adding a trailer // to an empty description would break that logic. let description = if !description.is_empty() || use_editor { commit_builder.set_description(description); add_trailers(ui, &tx, &commit_builder)? } else { description }; let description = if use_editor { commit_builder.set_description(description); let temp_commit = commit_builder.write_hidden().await?; let intro = ""; let description = description_template(ui, &tx, intro, &temp_commit)?; let description = edit_description(&text_editor, &description)?; if description.is_empty() { writedoc!( ui.hint_default(), " The commit message was left empty. If this was not intentional, run `jj undo` to restore the previous state. Or run `jj desc @-` to add a description to the parent commit. " )?; } description } else { description }; commit_builder.set_description(description); let new_commit = commit_builder.write(tx.repo_mut()).await?; let workspace_names = tx.repo().view().workspaces_for_wc_commit_id(commit.id()); if !workspace_names.is_empty() { let new_wc_commit = tx .repo_mut() .new_commit(vec![new_commit.id().clone()], commit.tree()) .write() .await?; // Does nothing if there's no bookmarks to advance. tx.advance_bookmarks(advanceable_bookmarks, new_commit.id())?; for name in workspace_names { tx.repo_mut().edit(name, &new_wc_commit).await.unwrap(); } } tx.finish(ui, format!("commit {}", commit.id().hex()))?; Ok(())}
// 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 clap_complete::ArgValueCandidates;
use clap_complete::ArgValueCompleter;
use indoc::writedoc;
use jj_lib::backend::Signature;
use jj_lib::merge::Diff;
use jj_lib::object_id::ObjectId as _;
use jj_lib::repo::Repo as _;
use tracing::instrument;
use crate::cli_util::CommandHelper;
use crate::command_error::CommandError;
use crate::command_error::user_error;
use crate::complete;
use crate::description_util::add_trailers;
use crate::description_util::description_template;
use crate::description_util::edit_description;
use crate::description_util::join_message_paragraphs;
use crate::text_util::parse_author;
use crate::ui::Ui;
/// Update the description and create a new change on top [default alias: ci]
///
/// When called without path arguments or `--interactive`, `jj commit` is
/// equivalent to `jj describe` followed by `jj new`.
///
/// When using `--interactive` or path arguments, the selected changes stay in
/// the current commit while the remaining changes are moved to a new
/// working-copy commit on top. This is very similar to `jj split`. Differences
/// include:
///
/// * `jj commit` is not interactive by default (it selects all changes).
///
/// * `jj commit` doesn't have a `-r` option. It always acts on the working-copy
/// commit (@).
///
/// * `jj split` (without `-o`/`-A`/`-B`) will move bookmarks forward from the
/// old change to the child change. `jj commit` doesn't move bookmarks
/// forward.
///
/// * `jj split` allows you to move the selected changes to a different
/// destination with `-o`/`-A`/`-B`.
#[derive(clap::Args, Clone, Debug)]
pub(crate) struct CommitArgs {
/// Interactively choose which changes to include in the current commit
#[arg(short, long)]
interactive: bool,
/// Specify diff editor to be used (implies --interactive)
#[arg(long, value_name = "NAME")]
#[arg(add = ArgValueCandidates::new(complete::diff_editors))]
tool: Option<String>,
/// The change description to use (don't open editor)
#[arg(long = "message", short, value_name = "MESSAGE")]
message_paragraphs: Option<Vec<String>>,
/// Open an editor to edit the change description
///
/// Forces an editor to open when using `--message` to allow the
/// message to be edited afterwards.
#[arg(long)]
editor: bool,
/// Put these paths in the current commit
#[arg(value_name = "FILESETS", value_hint = clap::ValueHint::AnyPath)]
#[arg(add = ArgValueCompleter::new(complete::modified_files))]
paths: Vec<String>,
// TODO: Delete in jj 0.40.0+
/// Reset the author to the configured user
///
/// This resets the author name, email, and timestamp.
///
/// You can use it in combination with the JJ_USER and JJ_EMAIL
/// environment variables to set a different author:
///
/// $ JJ_USER='Foo Bar' JJ_EMAIL=foo@bar.com jj commit --reset-author
#[arg(long, hide = true)]
reset_author: bool,
// TODO: Delete in jj 0.40.0+
/// Set author to the provided string
///
/// This changes author name and email while retaining author
/// timestamp for non-discardable commits.
#[arg(
long,
hide = true,
conflicts_with = "reset_author",
value_parser = parse_author
)]
author: Option<(String, String)>,
}
#[instrument(skip_all)]
pub(crate) async fn cmd_commit(
ui: &mut Ui,
command: &CommandHelper,
args: &CommitArgs,
) -> Result<(), CommandError> {
if args.reset_author {
writeln!(
ui.warning_default(),
"`jj commit --reset-author` is deprecated; use `jj metaedit --update-author` instead"
)?;
}
if args.author.is_some() {
writeln!(
ui.warning_default(),
"`jj commit --author` is deprecated; use `jj metaedit --author` instead"
)?;
}
let mut workspace_command = command.workspace_helper(ui)?;
let commit_id = workspace_command
.get_wc_commit_id()
.ok_or_else(|| user_error("This command requires a working copy"))?;
let commit = workspace_command.repo().store().get_commit(commit_id)?;
let matcher = workspace_command
.parse_file_patterns(ui, &args.paths)?
.to_matcher();
let advanceable_bookmarks =
workspace_command.get_advanceable_bookmarks(ui, commit.parent_ids())?;
let diff_selector =
workspace_command.diff_selector(ui, args.tool.as_deref(), args.interactive)?;
let text_editor = workspace_command.text_editor()?;
let mut tx = workspace_command.start_transaction();
let base_tree = commit.parent_tree(tx.repo()).await?;
let format_instructions = || {
format!(
"\
You are splitting the working-copy commit: {}
The diff initially shows all changes. Adjust the right side until it shows the
contents you want for the first commit. The remainder will be included in the
new working-copy commit.
",
tx.format_commit_summary(&commit)
)
};
let tree = diff_selector.select(
ui,
Diff::new(&base_tree, &commit.tree()),
Diff::new(commit.parents_conflict_label()?, commit.conflict_label()),
matcher.as_ref(),
format_instructions,
)?;
if !args.paths.is_empty() && tree.tree_ids() == base_tree.tree_ids() {
writeln!(
ui.warning_default(),
"The given paths do not match any file: {}",
args.paths.join(" ")
)?;
}
let mut commit_builder = tx.repo_mut().rewrite_commit(&commit).detach();
commit_builder.set_tree(tree);
if args.reset_author {
commit_builder.set_author(commit_builder.committer().clone());
}
if let Some((name, email)) = args.author.clone() {
let new_author = Signature {
name,
email,
timestamp: commit_builder.author().timestamp,
};
commit_builder.set_author(new_author);
}
let use_editor = args.message_paragraphs.is_none() || args.editor;
let description = match &args.message_paragraphs {
Some(paragraphs) => join_message_paragraphs(paragraphs),
None => commit_builder.description().to_owned(),
};
// The first trailer would become the first line of the description. Also, a
// commit with no description is treated in a special way in jujutsu: it can
// be discarded as soon as it's no longer the working copy. Adding a trailer
// to an empty description would break that logic.
let description = if !description.is_empty() || use_editor {
commit_builder.set_description(description);
add_trailers(ui, &tx, &commit_builder)?
} else {
description
};
let description = if use_editor {
commit_builder.set_description(description);
let temp_commit = commit_builder.write_hidden().await?;
let intro = "";
let description = description_template(ui, &tx, intro, &temp_commit)?;
let description = edit_description(&text_editor, &description)?;
if description.is_empty() {
writedoc!(
ui.hint_default(),
"
The commit message was left empty.
If this was not intentional, run `jj undo` to restore the previous state.
Or run `jj desc @-` to add a description to the parent commit.
"
)?;
}
description
} else {
description
};
commit_builder.set_description(description);
let new_commit = commit_builder.write(tx.repo_mut()).await?;
let workspace_names = tx.repo().view().workspaces_for_wc_commit_id(commit.id());
if !workspace_names.is_empty() {
let new_wc_commit = tx
.repo_mut()
.new_commit(vec![new_commit.id().clone()], commit.tree())
.write()
.await?;
// Does nothing if there's no bookmarks to advance.
tx.advance_bookmarks(advanceable_bookmarks, new_commit.id())?;
for name in workspace_names {
tx.repo_mut().edit(name, &new_wc_commit).await.unwrap();
}
}
tx.finish(ui, format!("commit {}", commit.id().hex()))?;
Ok(())
}