// Copyright 2020-2023 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::collections::HashSet;use std::rc::Rc; use clap_complete::ArgValueCandidates;use itertools::Itertools as _;use jj_lib::ref_name::RefName;use jj_lib::repo::Repo as _;use jj_lib::revset::RevsetExpression;use jj_lib::str_util::StringPattern; use crate::cli_util::CommandHelper;use crate::cli_util::RevisionArg;use crate::command_error::CommandError;use crate::commit_templater::CommitRef;use crate::commit_templater::CommitTemplateLanguage;use crate::complete;use crate::ui::Ui; /// List bookmarks and their targets////// By default, a tracking remote bookmark will be included only if its target/// is different from the local target. A non-tracking remote bookmark won't be/// listed. For a conflicted bookmark (both local and remote), old target/// revisions are preceded by a "-" and new target revisions are preceded by a/// "+".////// See [`jj help -k bookmarks`] for more information.////// [`jj help -k bookmarks`]:/// https://jj-vcs.github.io/jj/latest/bookmarks#[derive(clap::Args, Clone, Debug)]pub struct BookmarkListArgs { /// Show all tracking and non-tracking remote bookmarks including the ones /// whose targets are synchronized with the local bookmarks #[arg(long, short, alias = "all")] all_remotes: bool, /// Show all tracking and non-tracking remote bookmarks belonging /// to this remote /// /// Can be combined with `--tracked` or `--conflicted` to filter the /// bookmarks shown (can be repeated.) /// /// By default, the specified remote name matches exactly. Use `glob:` /// prefix to select remotes by [wildcard pattern]. /// /// [wildcard pattern]: /// https://jj-vcs.github.io/jj/latest/revsets/#string-patterns #[arg( long = "remote", value_name = "REMOTE", conflicts_with_all = ["all_remotes"], value_parser = StringPattern::parse, add = ArgValueCandidates::new(complete::git_remotes), )] remotes: Option<Vec<StringPattern>>, /// Show remote tracked bookmarks only. Omits local Git-tracking bookmarks /// by default #[arg(long, short, conflicts_with_all = ["all_remotes"])] tracked: bool, /// Show conflicted bookmarks only #[arg(long, short, conflicts_with_all = ["all_remotes"])] conflicted: bool, /// Show bookmarks whose local name matches /// /// By default, the specified name matches exactly. Use `glob:` prefix to /// select bookmarks by [wildcard pattern]. /// /// [wildcard pattern]: /// https://jj-vcs.github.io/jj/latest/revsets/#string-patterns #[arg(value_parser = StringPattern::parse, add = ArgValueCandidates::new(complete::bookmarks))] names: Option<Vec<StringPattern>>, /// Show bookmarks whose local targets are in the given revisions /// /// Note that `-r deleted_bookmark` will not work since `deleted_bookmark` /// wouldn't have a local target. #[arg(long, short, value_name = "REVSETS")] revisions: Option<Vec<RevisionArg>>, /// Render each bookmark using the given template /// /// All 0-argument methods of the [`CommitRef` type] are available as /// keywords in the template expression. See [`jj help -k templates`] /// for more information. /// /// [`CommitRef` type]: /// https://jj-vcs.github.io/jj/latest/templates/#commitref-type /// /// [`jj help -k templates`]: /// https://jj-vcs.github.io/jj/latest/templates/ #[arg(long, short = 'T', add = ArgValueCandidates::new(complete::template_aliases))] template: Option<String>,} pub fn cmd_bookmark_list( ui: &mut Ui, command: &CommandHelper, args: &BookmarkListArgs,) -> Result<(), CommandError> { let workspace_command = command.workspace_helper(ui)?; let repo = workspace_command.repo(); let view = repo.view(); // Like cmd_git_push(), names and revisions are OR-ed. let bookmark_names_to_list = if args.names.is_some() || args.revisions.is_some() { let mut bookmark_names: HashSet<&RefName> = HashSet::new(); if let Some(patterns) = &args.names { bookmark_names.extend( view.bookmarks() .filter(|(name, _)| { patterns .iter() .any(|pattern| pattern.matches(name.as_str())) }) .map(|(name, _)| name), ); } if let Some(revisions) = &args.revisions { // Match against local targets only, which is consistent with "jj git push". let mut expression = workspace_command.parse_union_revsets(ui, revisions)?; // Intersects with the set of local bookmark targets to minimize the lookup // space. expression.intersect_with(&RevsetExpression::bookmarks(StringPattern::everything())); let filtered_targets: HashSet<_> = expression.evaluate_to_commit_ids()?.try_collect()?; bookmark_names.extend( view.local_bookmarks() .filter(|(_, target)| { target.added_ids().any(|id| filtered_targets.contains(id)) }) .map(|(name, _)| name), ); } Some(bookmark_names) } else { None }; let template = { let language = workspace_command.commit_template_language(); let text = match &args.template { Some(value) => value.to_owned(), None => workspace_command .settings() .get("templates.bookmark_list")?, }; workspace_command .parse_template( ui, &language, &text, CommitTemplateLanguage::wrap_commit_ref, )? .labeled("bookmark_list") }; let mut bookmark_list_items: Vec<RefListItem> = Vec::new(); let bookmarks_to_list = view.bookmarks().filter(|(name, target)| { bookmark_names_to_list .as_ref() .is_none_or(|bookmark_names| bookmark_names.contains(name)) && (!args.conflicted || target.local_target.has_conflict()) }); for (name, bookmark_target) in bookmarks_to_list { let local_target = bookmark_target.local_target; let remote_refs = bookmark_target.remote_refs; let (mut tracked_remote_refs, untracked_remote_refs) = remote_refs .iter() .copied() .filter(|(remote_name, _)| { args.remotes.as_ref().is_none_or(|patterns| { patterns .iter() .any(|pattern| pattern.matches(remote_name.as_str())) }) }) .partition::<Vec<_>, _>(|&(_, remote_ref)| remote_ref.is_tracked()); if args.tracked { tracked_remote_refs.retain(|&(remote, _)| !jj_lib::git::is_special_git_remote(remote)); } else if !args.all_remotes && args.remotes.is_none() { tracked_remote_refs.retain(|&(_, remote_ref)| remote_ref.target != *local_target); } let include_local_only = !args.tracked && args.remotes.is_none(); if include_local_only && local_target.is_present() || !tracked_remote_refs.is_empty() { let primary = CommitRef::local( name, local_target.clone(), remote_refs.iter().map(|&(_, remote_ref)| remote_ref), ); let tracked = tracked_remote_refs .iter() .map(|&(remote, remote_ref)| { CommitRef::remote(name, remote, remote_ref.clone(), local_target) }) .collect(); bookmark_list_items.push(RefListItem { primary, tracked }); } if !args.tracked && (args.all_remotes || args.remotes.is_some()) { bookmark_list_items.extend(untracked_remote_refs.iter().map( |&(remote, remote_ref)| RefListItem { primary: CommitRef::remote_only(name, remote, remote_ref.target.clone()), tracked: vec![], }, )); } } ui.request_pager(); let mut formatter = ui.stdout_formatter(); bookmark_list_items .iter() .flat_map(|item| itertools::chain([&item.primary], &item.tracked)) .try_for_each(|commit_ref| template.format(commit_ref, formatter.as_mut()))?; drop(formatter); #[cfg(feature = "git")] if jj_lib::git::get_git_backend(repo.store()).is_ok() { // Print only one of these hints. It's not important to mention unexported // bookmarks, but user might wonder why deleted bookmarks are still listed. let deleted_tracking = bookmark_list_items .iter() .filter(|item| item.primary.is_local() && item.primary.is_absent()) .map(|item| { item.tracked.iter().any(|r| { let remote = r.remote_name().expect("tracked ref should be remote"); !jj_lib::git::is_special_git_remote(remote.as_ref()) }) }) .max(); match deleted_tracking { Some(true) => { writeln!( ui.hint_default(), "Bookmarks marked as deleted will be *deleted permanently* on the remote on \ the next `jj git push`. Use `jj bookmark forget` to prevent this." )?; } Some(false) => { writeln!( ui.hint_default(), "Bookmarks marked as deleted will be deleted from the underlying Git repo on \ the next `jj git export`." )?; } None => {} } } Ok(())} #[derive(Clone, Debug)]struct RefListItem { /// Local bookmark or untracked remote bookmark. primary: Rc<CommitRef>, /// Remote bookmarks tracked by the primary (or local) bookmark. tracked: Vec<Rc<CommitRef>>,}
// Copyright 2020-2023 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::collections::HashSet;
use std::rc::Rc;
use clap_complete::ArgValueCandidates;
use itertools::Itertools as _;
use jj_lib::ref_name::RefName;
use jj_lib::repo::Repo as _;
use jj_lib::revset::RevsetExpression;
use jj_lib::str_util::StringPattern;
use crate::cli_util::CommandHelper;
use crate::cli_util::RevisionArg;
use crate::command_error::CommandError;
use crate::commit_templater::CommitRef;
use crate::commit_templater::CommitTemplateLanguage;
use crate::complete;
use crate::ui::Ui;
/// List bookmarks and their targets
///
/// By default, a tracking remote bookmark will be included only if its target
/// is different from the local target. A non-tracking remote bookmark won't be
/// listed. For a conflicted bookmark (both local and remote), old target
/// revisions are preceded by a "-" and new target revisions are preceded by a
/// "+".
///
/// See [`jj help -k bookmarks`] for more information.
///
/// [`jj help -k bookmarks`]:
/// https://jj-vcs.github.io/jj/latest/bookmarks
#[derive(clap::Args, Clone, Debug)]
pub struct BookmarkListArgs {
/// Show all tracking and non-tracking remote bookmarks including the ones
/// whose targets are synchronized with the local bookmarks
#[arg(long, short, alias = "all")]
all_remotes: bool,
/// Show all tracking and non-tracking remote bookmarks belonging
/// to this remote
///
/// Can be combined with `--tracked` or `--conflicted` to filter the
/// bookmarks shown (can be repeated.)
///
/// By default, the specified remote name matches exactly. Use `glob:`
/// prefix to select remotes by [wildcard pattern].
///
/// [wildcard pattern]:
/// https://jj-vcs.github.io/jj/latest/revsets/#string-patterns
#[arg(
long = "remote",
value_name = "REMOTE",
conflicts_with_all = ["all_remotes"],
value_parser = StringPattern::parse,
add = ArgValueCandidates::new(complete::git_remotes),
)]
remotes: Option<Vec<StringPattern>>,
/// Show remote tracked bookmarks only. Omits local Git-tracking bookmarks
/// by default
#[arg(long, short, conflicts_with_all = ["all_remotes"])]
tracked: bool,
/// Show conflicted bookmarks only
#[arg(long, short, conflicts_with_all = ["all_remotes"])]
conflicted: bool,
/// Show bookmarks whose local name matches
///
/// By default, the specified name matches exactly. Use `glob:` prefix to
/// select bookmarks by [wildcard pattern].
///
/// [wildcard pattern]:
/// https://jj-vcs.github.io/jj/latest/revsets/#string-patterns
#[arg(value_parser = StringPattern::parse, add = ArgValueCandidates::new(complete::bookmarks))]
names: Option<Vec<StringPattern>>,
/// Show bookmarks whose local targets are in the given revisions
///
/// Note that `-r deleted_bookmark` will not work since `deleted_bookmark`
/// wouldn't have a local target.
#[arg(long, short, value_name = "REVSETS")]
revisions: Option<Vec<RevisionArg>>,
/// Render each bookmark using the given template
///
/// All 0-argument methods of the [`CommitRef` type] are available as
/// keywords in the template expression. See [`jj help -k templates`]
/// for more information.
///
/// [`CommitRef` type]:
/// https://jj-vcs.github.io/jj/latest/templates/#commitref-type
///
/// [`jj help -k templates`]:
/// https://jj-vcs.github.io/jj/latest/templates/
#[arg(long, short = 'T', add = ArgValueCandidates::new(complete::template_aliases))]
template: Option<String>,
}
pub fn cmd_bookmark_list(
ui: &mut Ui,
command: &CommandHelper,
args: &BookmarkListArgs,
) -> Result<(), CommandError> {
let workspace_command = command.workspace_helper(ui)?;
let repo = workspace_command.repo();
let view = repo.view();
// Like cmd_git_push(), names and revisions are OR-ed.
let bookmark_names_to_list = if args.names.is_some() || args.revisions.is_some() {
let mut bookmark_names: HashSet<&RefName> = HashSet::new();
if let Some(patterns) = &args.names {
bookmark_names.extend(
view.bookmarks()
.filter(|(name, _)| {
patterns
.iter()
.any(|pattern| pattern.matches(name.as_str()))
})
.map(|(name, _)| name),
);
}
if let Some(revisions) = &args.revisions {
// Match against local targets only, which is consistent with "jj git push".
let mut expression = workspace_command.parse_union_revsets(ui, revisions)?;
// Intersects with the set of local bookmark targets to minimize the lookup
// space.
expression.intersect_with(&RevsetExpression::bookmarks(StringPattern::everything()));
let filtered_targets: HashSet<_> =
expression.evaluate_to_commit_ids()?.try_collect()?;
bookmark_names.extend(
view.local_bookmarks()
.filter(|(_, target)| {
target.added_ids().any(|id| filtered_targets.contains(id))
})
.map(|(name, _)| name),
);
}
Some(bookmark_names)
} else {
None
};
let template = {
let language = workspace_command.commit_template_language();
let text = match &args.template {
Some(value) => value.to_owned(),
None => workspace_command
.settings()
.get("templates.bookmark_list")?,
};
workspace_command
.parse_template(
ui,
&language,
&text,
CommitTemplateLanguage::wrap_commit_ref,
)?
.labeled("bookmark_list")
};
let mut bookmark_list_items: Vec<RefListItem> = Vec::new();
let bookmarks_to_list = view.bookmarks().filter(|(name, target)| {
bookmark_names_to_list
.as_ref()
.is_none_or(|bookmark_names| bookmark_names.contains(name))
&& (!args.conflicted || target.local_target.has_conflict())
});
for (name, bookmark_target) in bookmarks_to_list {
let local_target = bookmark_target.local_target;
let remote_refs = bookmark_target.remote_refs;
let (mut tracked_remote_refs, untracked_remote_refs) = remote_refs
.iter()
.copied()
.filter(|(remote_name, _)| {
args.remotes.as_ref().is_none_or(|patterns| {
patterns
.iter()
.any(|pattern| pattern.matches(remote_name.as_str()))
})
})
.partition::<Vec<_>, _>(|&(_, remote_ref)| remote_ref.is_tracked());
if args.tracked {
tracked_remote_refs.retain(|&(remote, _)| !jj_lib::git::is_special_git_remote(remote));
} else if !args.all_remotes && args.remotes.is_none() {
tracked_remote_refs.retain(|&(_, remote_ref)| remote_ref.target != *local_target);
}
let include_local_only = !args.tracked && args.remotes.is_none();
if include_local_only && local_target.is_present() || !tracked_remote_refs.is_empty() {
let primary = CommitRef::local(
name,
local_target.clone(),
remote_refs.iter().map(|&(_, remote_ref)| remote_ref),
);
let tracked = tracked_remote_refs
.iter()
.map(|&(remote, remote_ref)| {
CommitRef::remote(name, remote, remote_ref.clone(), local_target)
})
.collect();
bookmark_list_items.push(RefListItem { primary, tracked });
}
if !args.tracked && (args.all_remotes || args.remotes.is_some()) {
bookmark_list_items.extend(untracked_remote_refs.iter().map(
|&(remote, remote_ref)| RefListItem {
primary: CommitRef::remote_only(name, remote, remote_ref.target.clone()),
tracked: vec![],
},
));
}
}
ui.request_pager();
let mut formatter = ui.stdout_formatter();
bookmark_list_items
.iter()
.flat_map(|item| itertools::chain([&item.primary], &item.tracked))
.try_for_each(|commit_ref| template.format(commit_ref, formatter.as_mut()))?;
drop(formatter);
#[cfg(feature = "git")]
if jj_lib::git::get_git_backend(repo.store()).is_ok() {
// Print only one of these hints. It's not important to mention unexported
// bookmarks, but user might wonder why deleted bookmarks are still listed.
let deleted_tracking = bookmark_list_items
.iter()
.filter(|item| item.primary.is_local() && item.primary.is_absent())
.map(|item| {
item.tracked.iter().any(|r| {
let remote = r.remote_name().expect("tracked ref should be remote");
!jj_lib::git::is_special_git_remote(remote.as_ref())
})
})
.max();
match deleted_tracking {
Some(true) => {
writeln!(
ui.hint_default(),
"Bookmarks marked as deleted will be *deleted permanently* on the remote on \
the next `jj git push`. Use `jj bookmark forget` to prevent this."
)?;
}
Some(false) => {
writeln!(
ui.hint_default(),
"Bookmarks marked as deleted will be deleted from the underlying Git repo on \
the next `jj git export`."
)?;
}
None => {}
}
}
Ok(())
}
#[derive(Clone, Debug)]
struct RefListItem {
/// Local bookmark or untracked remote bookmark.
primary: Rc<CommitRef>,
/// Remote bookmarks tracked by the primary (or local) bookmark.
tracked: Vec<Rc<CommitRef>>,
}