Skip to content

Commit

Permalink
describe: warn user of limitations when describing multiple commits
Browse files Browse the repository at this point in the history
I think it might be nice to have this in the upcoming release, but I'd
like to warn people that their changes will be lost if they aren't
careful, and to not rely on the syntax being fixed just yet.
  • Loading branch information
ilyagr committed Aug 6, 2024
1 parent 38478bc commit 77b6bd2
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
7 changes: 5 additions & 2 deletions cli/src/description_util.rs
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,11 @@ pub fn edit_multiple_descriptions(
let mut bulk_message = String::new();

bulk_message.push_str(indoc! {r#"
JJ: Enter or edit commit descriptions after the `JJ: describe` lines.
JJ: Enter or edit commit descriptions after the `JJ: describe` lines.
JJ: Warning:
JJ: - The text you enter will be lost on a syntax error.
JJ: - The syntax of separate lines may change in the future.
"#});
for (commit_id, temp_commit) in commits.iter() {
let commit_hash = short_commit_hash(commit_id);
Expand Down
7 changes: 7 additions & 0 deletions cli/tests/test_describe_command.rs
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,9 @@ fn test_describe_multiple_commits() {
insta::assert_snapshot!(
std::fs::read_to_string(test_env.env_root().join("editor0")).unwrap(), @r###"
JJ: Enter or edit commit descriptions after the `JJ: describe` lines.
JJ: Warning:
JJ: - The text you enter will be lost on a syntax error.
JJ: - The syntax of separate lines may change in the future.
JJ: describe 8d650510daad -------
Expand All @@ -238,6 +241,10 @@ fn test_describe_multiple_commits() {
&edit_script,
indoc! {"
write
JJ: Enter or edit commit descriptions after the `JJ: describe` lines.
JJ: More header tests. Library tests verify parsing in other situations.
JJ: describe 8d650510daad -------
description from editor of @-
Expand Down

0 comments on commit 77b6bd2

Please sign in to comment.