zed/crates/git_ui/src/git_panel.rs
Sathwik Chirivelli 5d3b9e467e
git_ui: Open file diffs from git panel (#56152)
Self-Review Checklist:
- [x] I've reviewed my own diff for quality, security, and reliability
- [x] Unsafe blocks (if any) have justifying comments
- [x] The content is consistent with the [UI/UX
checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist)
- [x] Tests cover the new/changed behavior
- [x] Performance impact has been considered and is acceptable

Addresses https://github.com/zed-industries/zed/discussions/33773.

This changes git panel file activation so double-clicking or
secondary-opening a changed file opens a dedicated full-file diff tab
backed by a `SplittableEditor`.

The per-file diff reuses the project diff staging and restore controls,
respects the configured diff view style, and focuses an existing
per-file diff tab when one is already open instead of creating
duplicates.

Verified with `cargo run`.

Release Notes:

- Improved git panel file diff opening.

---------

Co-authored-by: Christopher Biscardi <chris@christopherbiscardi.com>
2026-05-29 19:43:26 +00:00

9164 lines
332 KiB
Rust

use crate::askpass_modal::AskPassModal;
use crate::commit_modal::CommitModal;
use crate::commit_tooltip::{CommitAvatar, CommitTooltip};
use crate::commit_view::CommitView;
use crate::git_panel_settings::GitPanelScrollbarAccessor;
use crate::project_diff::{self, BranchDiff, Diff, ProjectDiff};
use crate::remote_output::{self, RemoteAction, SuccessMessage};
use crate::solo_diff_view::SoloDiffView;
use crate::{branch_picker, picker_prompt, render_remote_button};
use crate::{
git_panel_settings::GitPanelSettings, git_status_icon, repository_selector::RepositorySelector,
};
use agent_settings::{AgentSettings, UserAgentsMd};
use alacritty_terminal::vte::ansi;
use anyhow::Context as _;
use askpass::AskPassDelegate;
use collections::{BTreeMap, HashMap, HashSet};
use db::kvp::KeyValueStore;
use editor::{Editor, EditorElement, EditorMode, MultiBuffer, MultiBufferOffset, SizingBehavior};
use editor::{EditorStyle, RewrapOptions};
use file_icons::FileIcons;
use futures::StreamExt as _;
use futures::channel::oneshot::Canceled;
use git::Oid;
use git::commit::ParsedCommitMessage;
use git::repository::{
Branch, CommitData, CommitDetails, CommitOptions, CommitSummary, DiffType, FetchOptions,
GitCommitTemplate, GitCommitter, LogOrder, LogSource, PushOptions, Remote, RemoteCommandOutput,
ResetMode, Upstream, UpstreamTracking, UpstreamTrackingStatus, get_git_committer,
};
use git::stash::GitStash;
use git::status::{DiffStat, StageStatus};
use git::{Amend, Commit, Signoff, ToggleStaged, repository::RepoPath, status::FileStatus};
use git::{
ExpandCommitEditor, GitHostingProviderRegistry, GitRemote, RestoreTrackedFiles, StageAll,
StashAll, StashApply, StashPop, ToggleFillCommitEditor, TrashUntrackedFiles, UnstageAll,
parse_git_remote_url,
};
use gpui::{
AbsoluteLength, Action, Anchor, AsyncApp, AsyncWindowContext, Bounds, ClickEvent, DismissEvent,
Empty, Entity, EventEmitter, FocusHandle, Focusable, KeyContext, MouseButton, MouseDownEvent,
Point, PromptLevel, ScrollStrategy, Subscription, Task, TaskExt, TextStyle,
UniformListScrollHandle, WeakEntity, actions, anchored, deferred, point, size, uniform_list,
};
use itertools::Itertools;
use language::{Buffer, File};
use language_model::{
CompletionIntent, ConfiguredModel, LanguageModelRegistry, LanguageModelRequest,
LanguageModelRequestMessage, Role,
};
use menu;
use multi_buffer::ExcerptBoundaryInfo;
use notifications::status_toast::StatusToast;
use panel::PanelHeader;
use project::git_store::GitAccess;
use project::{
Fs, Project, ProjectPath,
git_store::{
CommitDataState, GitStoreEvent, Repository, RepositoryEvent, RepositoryId, pending_op,
},
project_settings::{GitPathStyle, ProjectSettings},
};
use prompt_store::RULES_FILE_NAMES;
use proto::RpcError;
use serde::{Deserialize, Serialize};
use settings::{Settings, SettingsStore, StatusStyle, update_settings_file};
use smallvec::SmallVec;
use std::future::Future;
use std::ops::Range;
use std::path::Path;
use std::{sync::Arc, time::Duration, usize};
use strum::{IntoEnumIterator, VariantNames};
use theme_settings::ThemeSettings;
use time::OffsetDateTime;
use ui::{
ButtonLike, Checkbox, ContextMenu, Divider, ElevationIndex, IndentGuideColors, KeyBinding,
PopoverMenu, ProjectEmptyState, RenderedIndentGuide, ScrollAxes, Scrollbars, SplitButton, Tab,
TintColor, Tooltip, WithScrollbar, prelude::*,
};
use util::paths::PathStyle;
use util::{ResultExt, TryFutureExt, markdown::MarkdownInlineCode, maybe, rel_path::RelPath};
use workspace::SERIALIZATION_THROTTLE_TIME;
use workspace::{
Item, Workspace,
dock::{DockPosition, Panel, PanelEvent},
notifications::{DetachAndPromptErr, ErrorMessagePrompt, NotificationId, NotifyTaskExt},
};
use zed_actions::{DecreaseBufferFontSize, IncreaseBufferFontSize, ResetBufferFontSize};
actions!(
git_panel,
[
/// Closes the git panel.
Close,
/// Toggles the git panel.
Toggle,
/// Toggles focus on the git panel.
ToggleFocus,
/// Opens the git panel menu.
OpenMenu,
/// Focuses on the commit message editor.
FocusEditor,
/// Focuses on the changes list.
FocusChanges,
/// Select next git panel menu item, and show it in the diff view
NextEntry,
/// Select previous git panel menu item, and show it in the diff view
PreviousEntry,
/// Select first git panel menu item, and show it in the diff view
FirstEntry,
/// Select last git panel menu item, and show it in the diff view
LastEntry,
/// Toggles automatic co-author suggestions.
ToggleFillCoAuthors,
/// Toggles sorting entries by path vs status.
ToggleSortByPath,
/// Toggles showing entries in tree vs flat view.
ToggleTreeView,
/// Expands the selected entry to show its children.
ExpandSelectedEntry,
/// Collapses the selected entry to hide its children.
CollapseSelectedEntry,
/// Activates the Changes tab.
ActivateChangesTab,
/// Activates the History tab.
ActivateHistoryTab,
]
);
actions!(
dev,
[
/// Shows the current git job queue debug state for the active repository.
ShowGitJobQueue,
]
);
actions!(
git_graph,
[
/// Opens the Git Graph Tab.
Open,
]
);
/// Opens the Git Graph Tab at a specific commit.
#[derive(Clone, PartialEq, serde::Deserialize, schemars::JsonSchema, gpui::Action)]
#[action(namespace = git_graph)]
pub struct OpenAtCommit {
pub sha: String,
}
fn prompt<T>(
msg: &str,
detail: Option<&str>,
window: &mut Window,
cx: &mut App,
) -> Task<anyhow::Result<T>>
where
T: IntoEnumIterator + VariantNames + 'static,
{
let rx = window.prompt(PromptLevel::Info, msg, detail, T::VARIANTS, cx);
cx.spawn(async move |_| Ok(T::iter().nth(rx.await?).unwrap()))
}
#[derive(strum::EnumIter, strum::VariantNames)]
#[strum(serialize_all = "title_case")]
enum TrashCancel {
Trash,
Cancel,
}
struct GitMenuState {
has_tracked_changes: bool,
has_staged_changes: bool,
has_unstaged_changes: bool,
has_new_changes: bool,
sort_by_path: bool,
has_stash_items: bool,
tree_view: bool,
}
fn git_panel_context_menu(
focus_handle: FocusHandle,
state: GitMenuState,
window: &mut Window,
cx: &mut App,
) -> Entity<ContextMenu> {
ContextMenu::build(window, cx, move |context_menu, _, _| {
context_menu
.context(focus_handle)
.action_disabled_when(
!state.has_unstaged_changes,
"Stage All",
StageAll.boxed_clone(),
)
.action_disabled_when(
!state.has_staged_changes,
"Unstage All",
UnstageAll.boxed_clone(),
)
.separator()
.action_disabled_when(
!(state.has_new_changes || state.has_tracked_changes),
"Stash All",
StashAll.boxed_clone(),
)
.action_disabled_when(!state.has_stash_items, "Stash Pop", StashPop.boxed_clone())
.action("View Stash", zed_actions::git::ViewStash.boxed_clone())
.separator()
.action("Open Diff", project_diff::Diff.boxed_clone())
.separator()
.action_disabled_when(
!state.has_tracked_changes,
"Discard Tracked Changes",
RestoreTrackedFiles.boxed_clone(),
)
.action_disabled_when(
!state.has_new_changes,
"Trash Untracked Files",
TrashUntrackedFiles.boxed_clone(),
)
.separator()
.entry(
if state.tree_view {
"Flat View"
} else {
"Tree View"
},
Some(Box::new(ToggleTreeView)),
move |window, cx| window.dispatch_action(Box::new(ToggleTreeView), cx),
)
.when(!state.tree_view, |this| {
this.entry(
if state.sort_by_path {
"Sort by Status"
} else {
"Sort by Path"
},
Some(Box::new(ToggleSortByPath)),
move |window, cx| window.dispatch_action(Box::new(ToggleSortByPath), cx),
)
})
})
}
const GIT_PANEL_KEY: &str = "GitPanel";
const UPDATE_DEBOUNCE: Duration = Duration::from_millis(50);
// TODO: We should revise this part. It seems the indentation width is not aligned with the one in project panel
const TREE_INDENT: f32 = 16.0;
pub fn register(workspace: &mut Workspace) {
workspace.register_action(|workspace, _: &ToggleFocus, window, cx| {
workspace.toggle_panel_focus::<GitPanel>(window, cx);
});
workspace.register_action(|workspace, _: &Toggle, window, cx| {
if !workspace.toggle_panel_focus::<GitPanel>(window, cx) {
workspace.close_panel::<GitPanel>(window, cx);
}
});
workspace.register_action(|workspace, _: &ExpandCommitEditor, window, cx| {
CommitModal::toggle(workspace, None, window, cx)
});
workspace.register_action(|workspace, _: &ToggleFillCommitEditor, window, cx| {
if let Some(panel) = workspace.panel::<GitPanel>(cx) {
panel.update(cx, |panel, cx| {
panel.toggle_fill_commit_editor(&Default::default(), window, cx)
});
}
});
workspace.register_action(|workspace, _: &git::Init, window, cx| {
if let Some(panel) = workspace.panel::<GitPanel>(cx) {
panel.update(cx, |panel, cx| panel.git_init(window, cx));
}
});
workspace.register_action(|workspace, _: &ShowGitJobQueue, window, cx| {
if let Some(panel) = workspace.panel::<GitPanel>(cx) {
panel.update(cx, |panel, cx| {
panel.show_git_job_queue(window, cx);
});
}
});
}
#[derive(Debug, Clone)]
pub enum Event {
Focus,
}
#[derive(Serialize, Deserialize)]
struct SerializedGitPanel {
#[serde(default)]
amend_pending: bool,
#[serde(default)]
signoff_enabled: bool,
}
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
enum GitPanelTab {
Changes,
History,
}
#[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
enum Section {
Conflict,
Tracked,
New,
}
#[derive(Debug, PartialEq, Eq, Clone)]
struct GitHeaderEntry {
header: Section,
}
impl GitHeaderEntry {
pub fn contains(&self, status_entry: &GitStatusEntry, repo: &Repository) -> bool {
let this = &self.header;
let status = status_entry.status;
match this {
Section::Conflict => {
repo.had_conflict_on_last_merge_head_change(&status_entry.repo_path)
}
Section::Tracked => !status.is_created(),
Section::New => status.is_created(),
}
}
pub fn title(&self) -> &'static str {
match self.header {
Section::Conflict => "Conflicts",
Section::Tracked => "Tracked",
Section::New => "Untracked",
}
}
}
#[derive(Debug, PartialEq, Eq, Clone)]
enum GitListEntry {
Status(GitStatusEntry),
TreeStatus(GitTreeStatusEntry),
Directory(GitTreeDirEntry),
Header(GitHeaderEntry),
}
impl GitListEntry {
fn status_entry(&self) -> Option<&GitStatusEntry> {
match self {
GitListEntry::Status(entry) => Some(entry),
GitListEntry::TreeStatus(entry) => Some(&entry.entry),
_ => None,
}
}
fn directory_entry(&self) -> Option<&GitTreeDirEntry> {
match self {
GitListEntry::Directory(entry) => Some(entry),
_ => None,
}
}
/// Returns the tree indentation depth for this entry.
fn depth(&self) -> usize {
match self {
GitListEntry::Directory(dir) => dir.depth,
GitListEntry::TreeStatus(status) => status.depth,
_ => 0,
}
}
}
enum GitPanelViewMode {
Flat,
Tree(TreeViewState),
}
impl GitPanelViewMode {
fn from_settings(cx: &App) -> Self {
if GitPanelSettings::get_global(cx).tree_view {
GitPanelViewMode::Tree(TreeViewState::default())
} else {
GitPanelViewMode::Flat
}
}
fn tree_state(&self) -> Option<&TreeViewState> {
match self {
GitPanelViewMode::Tree(state) => Some(state),
GitPanelViewMode::Flat => None,
}
}
fn tree_state_mut(&mut self) -> Option<&mut TreeViewState> {
match self {
GitPanelViewMode::Tree(state) => Some(state),
GitPanelViewMode::Flat => None,
}
}
}
#[derive(Default)]
struct TreeViewState {
// Maps visible index to actual entry index.
// Length equals the number of visible entries.
// This is needed because some entries (like collapsed directories) may be hidden.
logical_indices: Vec<usize>,
expanded_dirs: HashMap<TreeKey, bool>,
directory_descendants: HashMap<TreeKey, Vec<GitStatusEntry>>,
}
impl TreeViewState {
fn build_tree_entries(
&mut self,
section: Section,
mut entries: Vec<GitStatusEntry>,
seen_directories: &mut HashSet<TreeKey>,
) -> Vec<(GitListEntry, bool)> {
if entries.is_empty() {
return Vec::new();
}
entries.sort_by(|a, b| a.repo_path.cmp(&b.repo_path));
let mut root = TreeNode::default();
for entry in entries {
let components: Vec<&str> = entry.repo_path.components().collect();
if components.is_empty() {
root.files.push(entry);
continue;
}
let mut current = &mut root;
let mut current_path = String::new();
for (ix, component) in components.iter().enumerate() {
if ix == components.len() - 1 {
current.files.push(entry.clone());
} else {
if !current_path.is_empty() {
current_path.push('/');
}
current_path.push_str(component);
let dir_path = RepoPath::new(&current_path)
.expect("repo path from status entry component");
let component = SharedString::from(component.to_string());
current = current
.children
.entry(component.clone())
.or_insert_with(|| TreeNode {
name: component,
path: Some(dir_path),
..Default::default()
});
}
}
}
let (flattened, _) = self.flatten_tree(&root, section, 0, seen_directories);
flattened
}
fn flatten_tree(
&mut self,
node: &TreeNode,
section: Section,
depth: usize,
seen_directories: &mut HashSet<TreeKey>,
) -> (Vec<(GitListEntry, bool)>, Vec<GitStatusEntry>) {
let mut all_statuses = Vec::new();
let mut flattened = Vec::new();
for child in node.children.values() {
let (terminal, name) = Self::compact_directory_chain(child);
let Some(path) = terminal.path.clone().or_else(|| child.path.clone()) else {
continue;
};
let (child_flattened, mut child_statuses) =
self.flatten_tree(terminal, section, depth + 1, seen_directories);
let key = TreeKey { section, path };
let expanded = *self.expanded_dirs.get(&key).unwrap_or(&true);
self.expanded_dirs.entry(key.clone()).or_insert(true);
seen_directories.insert(key.clone());
self.directory_descendants
.insert(key.clone(), child_statuses.clone());
flattened.push((
GitListEntry::Directory(GitTreeDirEntry {
key,
name,
depth,
expanded,
}),
true,
));
if expanded {
flattened.extend(child_flattened);
} else {
flattened.extend(child_flattened.into_iter().map(|(child, _)| (child, false)));
}
all_statuses.append(&mut child_statuses);
}
for file in &node.files {
all_statuses.push(file.clone());
flattened.push((
GitListEntry::TreeStatus(GitTreeStatusEntry {
entry: file.clone(),
depth,
}),
true,
));
}
(flattened, all_statuses)
}
fn compact_directory_chain(mut node: &TreeNode) -> (&TreeNode, SharedString) {
let mut parts = vec![node.name.clone()];
while node.files.is_empty() && node.children.len() == 1 {
let Some(child) = node.children.values().next() else {
continue;
};
if child.path.is_none() {
break;
}
parts.push(child.name.clone());
node = child;
}
let name = parts.join("/");
(node, SharedString::from(name))
}
}
#[derive(Debug, PartialEq, Eq, Clone)]
struct GitTreeStatusEntry {
entry: GitStatusEntry,
depth: usize,
}
#[derive(Debug, PartialEq, Eq, Clone, Hash)]
struct TreeKey {
section: Section,
path: RepoPath,
}
#[derive(Debug, PartialEq, Eq, Clone)]
struct GitTreeDirEntry {
key: TreeKey,
name: SharedString,
depth: usize,
// staged_state: ToggleState,
expanded: bool,
}
#[derive(Default)]
struct TreeNode {
name: SharedString,
path: Option<RepoPath>,
children: BTreeMap<SharedString, TreeNode>,
files: Vec<GitStatusEntry>,
}
#[derive(Debug, PartialEq, Eq, Clone)]
pub struct GitStatusEntry {
pub(crate) repo_path: RepoPath,
pub(crate) status: FileStatus,
pub(crate) staging: StageStatus,
pub(crate) diff_stat: Option<DiffStat>,
}
impl GitStatusEntry {
fn display_name(&self, path_style: PathStyle) -> String {
self.repo_path
.file_name()
.map(|name| name.to_owned())
.unwrap_or_else(|| self.repo_path.display(path_style).to_string())
}
fn parent_dir(&self, path_style: PathStyle) -> Option<String> {
self.repo_path
.parent()
.map(|parent| parent.display(path_style).to_string())
}
}
struct TruncatedPatch {
header: String,
hunks: Vec<String>,
hunks_to_keep: usize,
}
impl TruncatedPatch {
fn from_unified_diff(patch_str: &str) -> Option<Self> {
let lines: Vec<&str> = patch_str.lines().collect();
if lines.len() < 2 {
return None;
}
let header = format!("{}\n{}\n", lines[0], lines[1]);
let mut hunks = Vec::new();
let mut current_hunk = String::new();
for line in &lines[2..] {
if line.starts_with("@@") {
if !current_hunk.is_empty() {
hunks.push(current_hunk);
}
current_hunk = format!("{}\n", line);
} else if !current_hunk.is_empty() {
current_hunk.push_str(line);
current_hunk.push('\n');
}
}
if !current_hunk.is_empty() {
hunks.push(current_hunk);
}
if hunks.is_empty() {
return None;
}
let hunks_to_keep = hunks.len();
Some(TruncatedPatch {
header,
hunks,
hunks_to_keep,
})
}
fn calculate_size(&self) -> usize {
let mut size = self.header.len();
for (i, hunk) in self.hunks.iter().enumerate() {
if i < self.hunks_to_keep {
size += hunk.len();
}
}
size
}
fn to_string(&self) -> String {
let mut out = self.header.clone();
for (i, hunk) in self.hunks.iter().enumerate() {
if i < self.hunks_to_keep {
out.push_str(hunk);
}
}
let skipped_hunks = self.hunks.len() - self.hunks_to_keep;
if skipped_hunks > 0 {
out.push_str(&format!("[...skipped {} hunks...]\n", skipped_hunks));
}
out
}
}
pub struct GitPanel {
pub(crate) active_repository: Option<Entity<Repository>>,
pub(crate) commit_editor: Entity<Editor>,
/// Whether the commit editor should fill the vertical height of the panel.
commit_editor_expanded: bool,
conflicted_count: usize,
conflicted_staged_count: usize,
add_coauthors: bool,
generate_commit_message_task: Option<Task<Option<()>>>,
entries: Vec<GitListEntry>,
view_mode: GitPanelViewMode,
entries_indices: HashMap<RepoPath, usize>,
single_staged_entry: Option<GitStatusEntry>,
single_tracked_entry: Option<GitStatusEntry>,
focus_handle: FocusHandle,
fs: Arc<dyn Fs>,
new_count: usize,
entry_count: usize,
changes_count: usize,
new_staged_count: usize,
pending_commit: Option<Task<()>>,
amend_pending: bool,
original_commit_message: Option<String>,
signoff_enabled: bool,
pending_serialization: Task<()>,
pub(crate) project: Entity<Project>,
scroll_handle: UniformListScrollHandle,
max_width_item_index: Option<usize>,
selected_entry: Option<usize>,
marked_entries: Vec<usize>,
tracked_count: usize,
tracked_staged_count: usize,
update_visible_entries_task: Task<()>,
pub(crate) workspace: WeakEntity<Workspace>,
context_menu: Option<(Entity<ContextMenu>, Point<Pixels>, Subscription)>,
modal_open: bool,
show_placeholders: bool,
local_committer: Option<GitCommitter>,
local_committer_task: Option<Task<()>>,
commit_template: Option<GitCommitTemplate>,
bulk_staging: Option<BulkStaging>,
stash_entries: GitStash,
active_tab: GitPanelTab,
commit_history_scroll_handle: UniformListScrollHandle,
commit_history_shas: Vec<Oid>,
focused_history_entry: Option<usize>,
history_keyboard_nav: bool,
_repo_subscriptions: Vec<Subscription>,
_settings_subscription: Subscription,
git_access: GitAccess,
}
#[derive(Clone, Debug, PartialEq, Eq)]
struct BulkStaging {
repo_id: RepositoryId,
anchor: RepoPath,
}
const MAX_PANEL_EDITOR_LINES: usize = 6;
pub(crate) fn commit_message_editor(
commit_message_buffer: Entity<Buffer>,
placeholder: Option<SharedString>,
project: Entity<Project>,
in_panel: bool,
window: &mut Window,
cx: &mut Context<Editor>,
) -> Editor {
let buffer = cx.new(|cx| MultiBuffer::singleton(commit_message_buffer, cx));
let max_lines = if in_panel { MAX_PANEL_EDITOR_LINES } else { 18 };
let mut commit_editor = Editor::new(
EditorMode::AutoHeight {
min_lines: max_lines,
max_lines: Some(max_lines),
},
buffer,
None,
window,
cx,
);
commit_editor.set_collaboration_hub(Box::new(project));
commit_editor.set_use_autoclose(false);
commit_editor.set_show_gutter(false, cx);
commit_editor.set_use_modal_editing(true);
commit_editor.set_show_wrap_guides(false, cx);
commit_editor.set_show_indent_guides(false, cx);
let placeholder = placeholder.unwrap_or("Enter commit message".into());
commit_editor.set_placeholder_text(&placeholder, window, cx);
commit_editor
}
impl GitPanel {
fn new(
workspace: &mut Workspace,
window: &mut Window,
cx: &mut Context<Workspace>,
) -> Entity<Self> {
let project = workspace.project().clone();
let app_state = workspace.app_state().clone();
let fs = app_state.fs.clone();
let git_store = project.read(cx).git_store().clone();
let active_repository = project.read(cx).active_repository(cx);
cx.new(|cx| {
let focus_handle = cx.focus_handle();
cx.on_focus(&focus_handle, window, Self::focus_in).detach();
let mut was_sort_by_path = GitPanelSettings::get_global(cx).sort_by_path;
let mut was_tree_view = GitPanelSettings::get_global(cx).tree_view;
let mut was_file_icons = GitPanelSettings::get_global(cx).file_icons;
let mut was_folder_icons = GitPanelSettings::get_global(cx).folder_icons;
let mut was_diff_stats = GitPanelSettings::get_global(cx).diff_stats;
cx.observe_global_in::<SettingsStore>(window, move |this, window, cx| {
let settings = GitPanelSettings::get_global(cx);
let sort_by_path = settings.sort_by_path;
let tree_view = settings.tree_view;
let file_icons = settings.file_icons;
let folder_icons = settings.folder_icons;
let diff_stats = settings.diff_stats;
if tree_view != was_tree_view {
this.view_mode = GitPanelViewMode::from_settings(cx);
}
let mut update_entries = false;
if sort_by_path != was_sort_by_path || tree_view != was_tree_view {
this.bulk_staging.take();
update_entries = true;
}
if (diff_stats != was_diff_stats) || update_entries {
this.update_visible_entries(window, cx);
}
if file_icons != was_file_icons || folder_icons != was_folder_icons {
cx.notify();
}
was_sort_by_path = sort_by_path;
was_tree_view = tree_view;
was_file_icons = file_icons;
was_folder_icons = folder_icons;
was_diff_stats = diff_stats;
})
.detach();
cx.observe_global::<FileIcons>(|_, cx| {
cx.notify();
})
.detach();
// just to let us render a placeholder editor.
// Once the active git repo is set, this buffer will be replaced.
let temporary_buffer = cx.new(|cx| Buffer::local("", cx));
let commit_editor = cx.new(|cx| {
commit_message_editor(temporary_buffer, None, project.clone(), true, window, cx)
});
commit_editor.update(cx, |editor, cx| {
editor.clear(window, cx);
});
let scroll_handle = UniformListScrollHandle::new();
let mut was_ai_enabled = AgentSettings::get_global(cx).enabled(cx);
let _settings_subscription = cx.observe_global::<SettingsStore>(move |_, cx| {
let is_ai_enabled = AgentSettings::get_global(cx).enabled(cx);
if was_ai_enabled != is_ai_enabled {
was_ai_enabled = is_ai_enabled;
cx.notify();
}
});
cx.subscribe_in(
&git_store,
window,
move |this, _git_store, event, window, cx| match event {
GitStoreEvent::RepositoryUpdated(
_,
RepositoryEvent::StatusesChanged | RepositoryEvent::HeadChanged,
true,
)
| GitStoreEvent::RepositoryAdded
| GitStoreEvent::RepositoryRemoved(_)
| GitStoreEvent::GlobalConfigurationUpdated
| GitStoreEvent::ActiveRepositoryChanged(_) => {
this.schedule_update(window, cx);
}
GitStoreEvent::IndexWriteError(error) => {
this.workspace
.update(cx, |workspace, cx| {
workspace.show_error(error, cx);
})
.ok();
}
GitStoreEvent::RepositoryUpdated(_, _, _) => {}
GitStoreEvent::JobsUpdated | GitStoreEvent::ConflictsUpdated => {}
},
)
.detach();
let mut this = Self {
active_repository,
commit_editor,
commit_editor_expanded: false,
conflicted_count: 0,
conflicted_staged_count: 0,
add_coauthors: true,
generate_commit_message_task: None,
entries: Vec::new(),
view_mode: GitPanelViewMode::from_settings(cx),
entries_indices: HashMap::default(),
focus_handle: cx.focus_handle(),
fs,
new_count: 0,
new_staged_count: 0,
changes_count: 0,
pending_commit: None,
amend_pending: false,
original_commit_message: None,
signoff_enabled: false,
pending_serialization: Task::ready(()),
single_staged_entry: None,
single_tracked_entry: None,
project,
scroll_handle,
max_width_item_index: None,
selected_entry: None,
marked_entries: Vec::new(),
tracked_count: 0,
tracked_staged_count: 0,
update_visible_entries_task: Task::ready(()),
show_placeholders: false,
local_committer: None,
local_committer_task: None,
commit_template: None,
context_menu: None,
workspace: workspace.weak_handle(),
modal_open: false,
entry_count: 0,
bulk_staging: None,
stash_entries: Default::default(),
active_tab: GitPanelTab::Changes,
commit_history_scroll_handle: UniformListScrollHandle::new(),
commit_history_shas: Vec::new(),
focused_history_entry: None,
history_keyboard_nav: false,
_repo_subscriptions: Vec::new(),
_settings_subscription,
git_access: GitAccess::Yes,
};
this.schedule_update(window, cx);
this
})
}
pub fn entry_by_path(&self, path: &RepoPath) -> Option<usize> {
self.entries_indices.get(path).copied()
}
pub fn select_entry_by_path(
&mut self,
path: ProjectPath,
window: &mut Window,
cx: &mut Context<Self>,
) {
let Some(git_repo) = self.active_repository.as_ref() else {
return;
};
let (repo_path, section) = {
let repo = git_repo.read(cx);
let Some(repo_path) = repo.project_path_to_repo_path(&path, cx) else {
return;
};
let section = repo
.status_for_path(&repo_path)
.map(|status| status.status)
.map(|status| {
if repo.had_conflict_on_last_merge_head_change(&repo_path) {
Section::Conflict
} else if status.is_created() {
Section::New
} else {
Section::Tracked
}
});
(repo_path, section)
};
let mut needs_rebuild = false;
if let (Some(section), Some(tree_state)) = (section, self.view_mode.tree_state_mut()) {
let mut current_dir = repo_path.parent();
while let Some(dir) = current_dir {
let key = TreeKey {
section,
path: RepoPath::from_rel_path(dir),
};
if tree_state.expanded_dirs.get(&key) == Some(&false) {
tree_state.expanded_dirs.insert(key, true);
needs_rebuild = true;
}
current_dir = dir.parent();
}
}
if needs_rebuild {
self.update_visible_entries(window, cx);
}
let Some(ix) = self.entry_by_path(&repo_path) else {
return;
};
self.selected_entry = Some(ix);
self.scroll_to_selected_entry(cx);
}
fn serialization_key(workspace: &Workspace) -> Option<String> {
workspace
.database_id()
.map(|id| i64::from(id).to_string())
.or(workspace.session_id())
.map(|id| format!("{}-{:?}", GIT_PANEL_KEY, id))
}
fn serialize(&mut self, cx: &mut Context<Self>) {
let amend_pending = self.amend_pending;
let signoff_enabled = self.signoff_enabled;
let kvp = KeyValueStore::global(cx);
self.pending_serialization = cx.spawn(async move |git_panel, cx| {
cx.background_executor()
.timer(SERIALIZATION_THROTTLE_TIME)
.await;
let Some(serialization_key) = git_panel
.update(cx, |git_panel, cx| {
git_panel
.workspace
.read_with(cx, |workspace, _| Self::serialization_key(workspace))
.ok()
.flatten()
})
.ok()
.flatten()
else {
return;
};
cx.background_spawn(
async move {
kvp.write_kvp(
serialization_key,
serde_json::to_string(&SerializedGitPanel {
amend_pending,
signoff_enabled,
})?,
)
.await?;
anyhow::Ok(())
}
.log_err(),
)
.await;
});
}
pub(crate) fn set_modal_open(&mut self, open: bool, cx: &mut Context<Self>) {
self.modal_open = open;
cx.notify();
}
fn dispatch_context(&self, window: &mut Window, cx: &Context<Self>) -> KeyContext {
let mut dispatch_context = KeyContext::new_with_defaults();
dispatch_context.add("GitPanel");
if self.commit_editor.read(cx).is_focused(window) {
dispatch_context.add("CommitEditor");
} else if self.focus_handle.contains_focused(window, cx) {
dispatch_context.add("menu");
dispatch_context.add("ChangesList");
}
dispatch_context
}
fn close_panel(&mut self, _: &Close, _window: &mut Window, cx: &mut Context<Self>) {
cx.emit(PanelEvent::Close);
}
fn focus_in(&mut self, window: &mut Window, cx: &mut Context<Self>) {
if !self.focus_handle.contains_focused(window, cx) {
cx.emit(Event::Focus);
}
if self.active_tab == GitPanelTab::History && self.focused_history_entry.is_some() {
self.history_keyboard_nav = true;
cx.notify();
}
}
fn scroll_to_selected_entry(&mut self, cx: &mut Context<Self>) {
let Some(selected_entry) = self.selected_entry else {
cx.notify();
return;
};
let visible_index = match &self.view_mode {
GitPanelViewMode::Flat => Some(selected_entry),
GitPanelViewMode::Tree(state) => state
.logical_indices
.iter()
.position(|&ix| ix == selected_entry),
};
if let Some(visible_index) = visible_index {
self.scroll_handle
.scroll_to_item(visible_index, ScrollStrategy::Center);
}
cx.notify();
}
fn expand_selected_entry(
&mut self,
_: &ExpandSelectedEntry,
window: &mut Window,
cx: &mut Context<Self>,
) {
let Some(entry) = self.get_selected_entry().cloned() else {
return;
};
if let GitListEntry::Directory(dir_entry) = entry {
if dir_entry.expanded {
self.select_next(&menu::SelectNext, window, cx);
} else {
self.toggle_directory(&dir_entry.key, window, cx);
}
} else {
self.select_next(&menu::SelectNext, window, cx);
}
}
fn collapse_selected_entry(
&mut self,
_: &CollapseSelectedEntry,
window: &mut Window,
cx: &mut Context<Self>,
) {
let Some(entry) = self.get_selected_entry().cloned() else {
return;
};
if let GitListEntry::Directory(dir_entry) = entry {
if dir_entry.expanded {
self.toggle_directory(&dir_entry.key, window, cx);
} else {
self.select_previous(&menu::SelectPrevious, window, cx);
}
} else {
self.select_previous(&menu::SelectPrevious, window, cx);
}
}
fn select_first(
&mut self,
_: &menu::SelectFirst,
_window: &mut Window,
cx: &mut Context<Self>,
) {
let first_entry = match &self.view_mode {
GitPanelViewMode::Flat => self
.entries
.iter()
.position(|entry| entry.status_entry().is_some()),
GitPanelViewMode::Tree(state) => {
let index = self.entries.iter().position(|entry| {
entry.status_entry().is_some() || entry.directory_entry().is_some()
});
index.map(|index| state.logical_indices[index])
}
};
if let Some(first_entry) = first_entry {
self.selected_entry = Some(first_entry);
self.scroll_to_selected_entry(cx);
}
}
fn select_previous(
&mut self,
_: &menu::SelectPrevious,
_window: &mut Window,
cx: &mut Context<Self>,
) {
if self.active_tab == GitPanelTab::History {
self.select_previous_history_entry(cx);
return;
}
let item_count = self.entries.len();
if item_count == 0 {
return;
}
let Some(selected_entry) = self.selected_entry else {
return;
};
let new_index = match &self.view_mode {
GitPanelViewMode::Flat => selected_entry.saturating_sub(1),
GitPanelViewMode::Tree(state) => {
let Some(current_logical_index) = state
.logical_indices
.iter()
.position(|&i| i == selected_entry)
else {
return;
};
state.logical_indices[current_logical_index.saturating_sub(1)]
}
};
if selected_entry == 0 && new_index == 0 {
return;
}
if matches!(
self.entries.get(new_index.saturating_sub(1)),
Some(GitListEntry::Header(..))
) && new_index == 0
{
return;
}
if matches!(self.entries.get(new_index), Some(GitListEntry::Header(..))) {
self.selected_entry = match &self.view_mode {
GitPanelViewMode::Flat => Some(new_index.saturating_sub(1)),
GitPanelViewMode::Tree(tree_view_state) => {
maybe!({
let current_logical_index = tree_view_state
.logical_indices
.iter()
.position(|&i| i == new_index)?;
tree_view_state
.logical_indices
.get(current_logical_index.saturating_sub(1))
.copied()
})
}
};
} else {
self.selected_entry = Some(new_index);
}
self.scroll_to_selected_entry(cx);
}
fn select_next(&mut self, _: &menu::SelectNext, _window: &mut Window, cx: &mut Context<Self>) {
if self.active_tab == GitPanelTab::History {
self.select_next_history_entry(cx);
return;
}
let item_count = self.entries.len();
if item_count == 0 {
return;
}
let Some(selected_entry) = self.selected_entry else {
return;
};
let new_index = match &self.view_mode {
GitPanelViewMode::Flat => {
if selected_entry >= item_count.saturating_sub(1) {
return;
}
selected_entry.saturating_add(1)
}
GitPanelViewMode::Tree(state) => {
let Some(current_logical_index) = state
.logical_indices
.iter()
.position(|&i| i == selected_entry)
else {
return;
};
let Some(new_index) = state
.logical_indices
.get(current_logical_index.saturating_add(1))
.copied()
else {
return;
};
new_index
}
};
if matches!(self.entries.get(new_index), Some(GitListEntry::Header(..))) {
self.selected_entry = Some(new_index.saturating_add(1));
} else {
self.selected_entry = Some(new_index);
}
self.scroll_to_selected_entry(cx);
}
fn select_last(&mut self, _: &menu::SelectLast, _window: &mut Window, cx: &mut Context<Self>) {
if self.entries.last().is_some() {
self.selected_entry = Some(self.entries.len() - 1);
self.scroll_to_selected_entry(cx);
}
}
/// Show diff view at selected entry, only if the diff view is open
fn move_diff_to_entry(&mut self, window: &mut Window, cx: &mut Context<Self>) {
maybe!({
let workspace = self.workspace.upgrade()?;
if let Some(project_diff) = workspace.read(cx).item_of_type::<ProjectDiff>(cx) {
let entry = self.entries.get(self.selected_entry?)?.status_entry()?;
project_diff.update(cx, |project_diff, cx| {
project_diff.move_to_entry(entry.clone(), window, cx);
});
}
Some(())
});
}
fn first_entry(&mut self, _: &FirstEntry, window: &mut Window, cx: &mut Context<Self>) {
self.select_first(&menu::SelectFirst, window, cx);
self.move_diff_to_entry(window, cx);
}
fn last_entry(&mut self, _: &LastEntry, window: &mut Window, cx: &mut Context<Self>) {
self.select_last(&menu::SelectLast, window, cx);
self.move_diff_to_entry(window, cx);
}
fn next_entry(&mut self, _: &NextEntry, window: &mut Window, cx: &mut Context<Self>) {
self.select_next(&menu::SelectNext, window, cx);
self.move_diff_to_entry(window, cx);
}
fn previous_entry(&mut self, _: &PreviousEntry, window: &mut Window, cx: &mut Context<Self>) {
self.select_previous(&menu::SelectPrevious, window, cx);
self.move_diff_to_entry(window, cx);
}
fn focus_editor(&mut self, _: &FocusEditor, window: &mut Window, cx: &mut Context<Self>) {
self.commit_editor.update(cx, |editor, cx| {
window.focus(&editor.focus_handle(cx), cx);
});
cx.notify();
}
fn select_first_entry_if_none(&mut self, window: &mut Window, cx: &mut Context<Self>) {
let have_entries = self
.active_repository
.as_ref()
.is_some_and(|active_repository| active_repository.read(cx).status_summary().count > 0);
if have_entries && self.selected_entry.is_none() {
self.select_first(&menu::SelectFirst, window, cx);
}
}
fn focus_changes_list(
&mut self,
_: &FocusChanges,
window: &mut Window,
cx: &mut Context<Self>,
) {
self.focus_handle.focus(window, cx);
self.select_first_entry_if_none(window, cx);
}
fn get_selected_entry(&self) -> Option<&GitListEntry> {
self.selected_entry.and_then(|i| self.entries.get(i))
}
fn open_diff(&mut self, _: &menu::Confirm, window: &mut Window, cx: &mut Context<Self>) {
if self.active_tab == GitPanelTab::History {
self.open_selected_history_commit(window, cx);
return;
}
if let Some(GitListEntry::Directory(dir_entry)) = self
.selected_entry
.and_then(|i| self.entries.get(i))
.cloned()
{
self.toggle_directory(&dir_entry.key, window, cx);
return;
}
maybe!({
let entry = self.entries.get(self.selected_entry?)?.status_entry()?;
let workspace = self.workspace.upgrade()?;
let git_repo = self.active_repository.as_ref()?;
if let Some(project_diff) = workspace.read(cx).active_item_as::<ProjectDiff>(cx)
&& let Some(project_path) = project_diff.read(cx).active_project_path(cx)
&& Some(&entry.repo_path)
== git_repo
.read(cx)
.project_path_to_repo_path(&project_path, cx)
.as_ref()
{
project_diff.focus_handle(cx).focus(window, cx);
project_diff.update(cx, |project_diff, cx| project_diff.autoscroll(cx));
return None;
};
self.workspace
.update(cx, |workspace, cx| {
ProjectDiff::deploy_at(workspace, Some(entry.clone()), window, cx);
})
.ok();
self.focus_handle.focus(window, cx);
Some(())
});
}
fn open_solo_diff(
&mut self,
_: &menu::SecondaryConfirm,
window: &mut Window,
cx: &mut Context<Self>,
) {
maybe!({
let entry = self
.entries
.get(self.selected_entry?)?
.status_entry()?
.clone();
let repository = self.active_repository.clone()?;
SoloDiffView::open_or_focus(entry, repository, self.workspace.clone(), window, cx)
.detach_and_notify_err(self.workspace.clone(), window, cx);
Some(())
});
}
fn revert_selected(
&mut self,
action: &git::RestoreFile,
window: &mut Window,
cx: &mut Context<Self>,
) {
let path_style = self.project.read(cx).path_style(cx);
maybe!({
let list_entry = self.entries.get(self.selected_entry?)?.clone();
let entry = list_entry.status_entry()?.to_owned();
let skip_prompt = action.skip_prompt || entry.status.is_created();
let prompt = if skip_prompt {
Task::ready(Ok(0))
} else {
let prompt = window.prompt(
PromptLevel::Warning,
&format!(
"Are you sure you want to discard changes to {}?",
MarkdownInlineCode(
entry
.repo_path
.file_name()
.unwrap_or(entry.repo_path.display(path_style).as_ref())
),
),
None,
&["Discard Changes", "Cancel"],
cx,
);
cx.background_spawn(prompt)
};
let this = cx.weak_entity();
window
.spawn(cx, async move |cx| {
if prompt.await? != 0 {
return anyhow::Ok(());
}
this.update_in(cx, |this, window, cx| {
this.revert_entry(&entry, window, cx);
})?;
Ok(())
})
.detach();
Some(())
});
}
fn add_to_gitignore(
&mut self,
_: &git::AddToGitignore,
_window: &mut Window,
cx: &mut Context<Self>,
) {
maybe!({
let list_entry = self.entries.get(self.selected_entry?)?.clone();
let entry = list_entry.status_entry()?.to_owned();
if !entry.status.is_created() {
return Some(());
}
let active_repository = self.active_repository.clone()?;
let workspace = self.workspace.clone();
let repo_path = entry.repo_path;
let receiver = active_repository
.update(cx, |repo, _| repo.add_path_to_gitignore(&repo_path, false));
cx.spawn(async move |_, cx| {
if let Err(e) = receiver.await? {
if let Some(workspace) = workspace.upgrade() {
cx.update(|cx| {
show_error_toast(workspace, "add to .gitignore", e, cx);
});
}
}
anyhow::Ok(())
})
.detach_and_log_err(cx);
Some(())
});
}
fn revert_entry(
&mut self,
entry: &GitStatusEntry,
window: &mut Window,
cx: &mut Context<Self>,
) {
maybe!({
let active_repo = self.active_repository.clone()?;
let path = active_repo
.read(cx)
.repo_path_to_project_path(&entry.repo_path, cx)?;
let workspace = self.workspace.clone();
if entry.status.staging().has_staged() {
self.change_file_stage(false, vec![entry.clone()], cx);
}
let filename = path.path.file_name()?.to_string();
if !entry.status.is_created() {
self.perform_checkout(vec![entry.clone()], window, cx);
} else {
let prompt = prompt(&format!("Trash {}?", filename), None, window, cx);
cx.spawn_in(window, async move |_, cx| {
match prompt.await? {
TrashCancel::Trash => {}
TrashCancel::Cancel => return Ok(()),
}
let task = workspace.update(cx, |workspace, cx| {
workspace
.project()
.update(cx, |project, cx| project.delete_file(path, true, cx))
})?;
if let Some(task) = task {
task.await?;
}
Ok(())
})
.detach_and_prompt_err(
"Failed to trash file",
window,
cx,
|e, _, _| Some(format!("{e}")),
);
}
Some(())
});
}
fn perform_checkout(
&mut self,
entries: Vec<GitStatusEntry>,
window: &mut Window,
cx: &mut Context<Self>,
) {
let workspace = self.workspace.clone();
let Some(active_repository) = self.active_repository.clone() else {
return;
};
let task = cx.spawn_in(window, async move |this, cx| {
let tasks: Vec<_> = workspace.update(cx, |workspace, cx| {
workspace.project().update(cx, |project, cx| {
entries
.iter()
.filter_map(|entry| {
let path = active_repository
.read(cx)
.repo_path_to_project_path(&entry.repo_path, cx)?;
Some(project.open_buffer(path, cx))
})
.collect()
})
})?;
let buffers = futures::future::join_all(tasks).await;
this.update_in(cx, |this, window, cx| {
let task = active_repository.update(cx, |repo, cx| {
repo.checkout_files(
"HEAD",
entries
.into_iter()
.map(|entries| entries.repo_path)
.collect(),
cx,
)
});
this.update_visible_entries(window, cx);
cx.notify();
task
})?
.await?;
let tasks: Vec<_> = cx.update(|_, cx| {
buffers
.iter()
.filter_map(|buffer| {
buffer.as_ref().ok()?.update(cx, |buffer, cx| {
buffer.is_dirty().then(|| buffer.reload(cx))
})
})
.collect()
})?;
futures::future::join_all(tasks).await;
Ok(())
});
cx.spawn_in(window, async move |this, cx| {
let result = task.await;
this.update_in(cx, |this, window, cx| {
if let Err(err) = result {
this.update_visible_entries(window, cx);
this.show_error_toast("checkout", err, cx);
}
})
.ok();
})
.detach();
}
fn restore_tracked_files(
&mut self,
_: &RestoreTrackedFiles,
window: &mut Window,
cx: &mut Context<Self>,
) {
let entries = self
.entries
.iter()
.filter_map(|entry| entry.status_entry().cloned())
.filter(|status_entry| !status_entry.status.is_created())
.collect::<Vec<_>>();
match entries.len() {
0 => return,
1 => return self.revert_entry(&entries[0], window, cx),
_ => {}
}
let mut details = entries
.iter()
.filter_map(|entry| entry.repo_path.as_ref().file_name())
.map(|filename| filename.to_string())
.take(5)
.join("\n");
if entries.len() > 5 {
details.push_str(&format!("\nand {} more…", entries.len() - 5))
}
#[derive(strum::EnumIter, strum::VariantNames)]
#[strum(serialize_all = "title_case")]
enum RestoreCancel {
RestoreTrackedFiles,
Cancel,
}
let prompt = prompt(
"Discard changes to these files?",
Some(&details),
window,
cx,
);
cx.spawn_in(window, async move |this, cx| {
if let Ok(RestoreCancel::RestoreTrackedFiles) = prompt.await {
this.update_in(cx, |this, window, cx| {
this.perform_checkout(entries, window, cx);
})
.ok();
}
})
.detach();
}
fn clean_all(&mut self, _: &TrashUntrackedFiles, window: &mut Window, cx: &mut Context<Self>) {
let workspace = self.workspace.clone();
let Some(active_repo) = self.active_repository.clone() else {
return;
};
let to_delete = self
.entries
.iter()
.filter_map(|entry| entry.status_entry())
.filter(|status_entry| status_entry.status.is_created())
.cloned()
.collect::<Vec<_>>();
match to_delete.len() {
0 => return,
1 => return self.revert_entry(&to_delete[0], window, cx),
_ => {}
};
let mut details = to_delete
.iter()
.map(|entry| {
entry
.repo_path
.as_ref()
.file_name()
.map(|f| f.to_string())
.unwrap_or_default()
})
.take(5)
.join("\n");
if to_delete.len() > 5 {
details.push_str(&format!("\nand {} more…", to_delete.len() - 5))
}
let prompt = prompt("Trash these files?", Some(&details), window, cx);
cx.spawn_in(window, async move |this, cx| {
match prompt.await? {
TrashCancel::Trash => {}
TrashCancel::Cancel => return Ok(()),
}
let tasks = workspace.update(cx, |workspace, cx| {
to_delete
.iter()
.filter_map(|entry| {
workspace.project().update(cx, |project, cx| {
let project_path = active_repo
.read(cx)
.repo_path_to_project_path(&entry.repo_path, cx)?;
project.delete_file(project_path, true, cx)
})
})
.collect::<Vec<_>>()
})?;
let to_unstage = to_delete
.into_iter()
.filter(|entry| !entry.status.staging().is_fully_unstaged())
.collect();
this.update(cx, |this, cx| this.change_file_stage(false, to_unstage, cx))?;
for task in tasks {
task.await?;
}
Ok(())
})
.detach_and_prompt_err("Failed to trash files", window, cx, |e, _, _| {
Some(format!("{e}"))
});
}
fn change_all_files_stage(&mut self, stage: bool, cx: &mut Context<Self>) {
let Some(active_repository) = self.active_repository.clone() else {
return;
};
cx.spawn({
async move |this, cx| {
let result = this
.update(cx, |this, cx| {
let task = active_repository.update(cx, |repo, cx| {
if stage {
repo.stage_all(cx)
} else {
repo.unstage_all(cx)
}
});
this.update_counts(active_repository.read(cx));
cx.notify();
task
})?
.await;
this.update(cx, |this, cx| {
if let Err(err) = result {
this.show_error_toast(if stage { "add" } else { "reset" }, err, cx);
}
cx.notify()
})
}
})
.detach();
}
fn stage_status_for_entry(entry: &GitStatusEntry, repo: &Repository) -> StageStatus {
// Checking for current staged/unstaged file status is a chained operation:
// 1. first, we check for any pending operation recorded in repository
// 2. if there are no pending ops either running or finished, we then ask the repository
// for the most up-to-date file status read from disk - we do this since `entry` arg to this function `render_entry`
// is likely to be staled, and may lead to weird artifacts in the form of subsecond auto-uncheck/check on
// the checkbox's state (or flickering) which is undesirable.
// 3. finally, if there is no info about this `entry` in the repo, we fall back to whatever status is encoded
// in `entry` arg.
repo.pending_ops_for_path(&entry.repo_path)
.and_then(|ops| {
// In case the last operation in the list of pending operations
// failed, we can't assume the stage status for this entry and
// need to fallback to the actual state in the repo.
if ops.last_op_errored() {
return None;
}
if ops.staging() || ops.staged() {
Some(StageStatus::Staged)
} else {
Some(StageStatus::Unstaged)
}
})
.or_else(|| {
repo.status_for_path(&entry.repo_path)
.map(|status| status.status.staging())
})
.unwrap_or(entry.staging)
}
fn stage_status_for_directory(
&self,
entry: &GitTreeDirEntry,
repo: &Repository,
) -> StageStatus {
let GitPanelViewMode::Tree(tree_state) = &self.view_mode else {
util::debug_panic!("We should never render a directory entry while in flat view mode");
return StageStatus::Unstaged;
};
let Some(descendants) = tree_state.directory_descendants.get(&entry.key) else {
return StageStatus::Unstaged;
};
let show_placeholders = self.show_placeholders && !self.has_staged_changes();
let mut fully_staged_count = 0usize;
let mut any_staged_or_partially_staged = false;
for descendant in descendants {
if show_placeholders && !descendant.status.is_created() {
fully_staged_count += 1;
any_staged_or_partially_staged = true;
} else {
match GitPanel::stage_status_for_entry(descendant, repo) {
StageStatus::Staged => {
fully_staged_count += 1;
any_staged_or_partially_staged = true;
}
StageStatus::PartiallyStaged => {
any_staged_or_partially_staged = true;
}
StageStatus::Unstaged => {}
}
}
}
if descendants.is_empty() {
StageStatus::Unstaged
} else if fully_staged_count == descendants.len() {
StageStatus::Staged
} else if any_staged_or_partially_staged {
StageStatus::PartiallyStaged
} else {
StageStatus::Unstaged
}
}
pub fn stage_all(&mut self, _: &StageAll, _window: &mut Window, cx: &mut Context<Self>) {
self.change_all_files_stage(true, cx);
}
pub fn unstage_all(&mut self, _: &UnstageAll, _window: &mut Window, cx: &mut Context<Self>) {
self.change_all_files_stage(false, cx);
}
fn toggle_staged_for_entry(
&mut self,
entry: &GitListEntry,
_window: &mut Window,
cx: &mut Context<Self>,
) {
let Some(active_repository) = self.active_repository.clone() else {
return;
};
let mut set_anchor: Option<RepoPath> = None;
let mut clear_anchor = None;
let (stage, repo_paths) = {
let repo = active_repository.read(cx);
match entry {
GitListEntry::Status(status_entry) => {
let repo_paths = vec![status_entry.clone()];
let stage = match GitPanel::stage_status_for_entry(status_entry, &repo) {
StageStatus::Staged => {
if let Some(op) = self.bulk_staging.clone()
&& op.anchor == status_entry.repo_path
{
clear_anchor = Some(op.anchor);
}
false
}
StageStatus::Unstaged | StageStatus::PartiallyStaged => {
set_anchor = Some(status_entry.repo_path.clone());
true
}
};
(stage, repo_paths)
}
GitListEntry::TreeStatus(status_entry) => {
let repo_paths = vec![status_entry.entry.clone()];
let stage = match GitPanel::stage_status_for_entry(&status_entry.entry, &repo) {
StageStatus::Staged => {
if let Some(op) = self.bulk_staging.clone()
&& op.anchor == status_entry.entry.repo_path
{
clear_anchor = Some(op.anchor);
}
false
}
StageStatus::Unstaged | StageStatus::PartiallyStaged => {
set_anchor = Some(status_entry.entry.repo_path.clone());
true
}
};
(stage, repo_paths)
}
GitListEntry::Header(section) => {
let goal_staged_state = !self.header_state(section.header).selected();
let entries = self
.entries
.iter()
.filter_map(|entry| entry.status_entry())
.filter(|status_entry| {
section.contains(status_entry, &repo)
&& GitPanel::stage_status_for_entry(status_entry, &repo).as_bool()
!= Some(goal_staged_state)
})
.cloned()
.collect::<Vec<_>>();
(goal_staged_state, entries)
}
GitListEntry::Directory(entry) => {
let goal_staged_state = match self.stage_status_for_directory(entry, repo) {
StageStatus::Staged => StageStatus::Unstaged,
StageStatus::Unstaged | StageStatus::PartiallyStaged => StageStatus::Staged,
};
let goal_stage = goal_staged_state == StageStatus::Staged;
let entries = self
.view_mode
.tree_state()
.and_then(|state| state.directory_descendants.get(&entry.key))
.cloned()
.unwrap_or_default()
.into_iter()
.filter(|status_entry| {
GitPanel::stage_status_for_entry(status_entry, &repo)
!= goal_staged_state
})
.collect::<Vec<_>>();
(goal_stage, entries)
}
}
};
if let Some(anchor) = clear_anchor {
if let Some(op) = self.bulk_staging.clone()
&& op.anchor == anchor
{
self.bulk_staging = None;
}
}
if let Some(anchor) = set_anchor {
self.set_bulk_staging_anchor(anchor, cx);
}
self.change_file_stage(stage, repo_paths, cx);
}
fn change_file_stage(
&mut self,
stage: bool,
entries: Vec<GitStatusEntry>,
cx: &mut Context<Self>,
) {
let Some(active_repository) = self.active_repository.clone() else {
return;
};
cx.spawn({
async move |this, cx| {
let result = this
.update(cx, |this, cx| {
let task = active_repository.update(cx, |repo, cx| {
let repo_paths = entries
.iter()
.map(|entry| entry.repo_path.clone())
.collect();
if stage {
repo.stage_entries(repo_paths, cx)
} else {
repo.unstage_entries(repo_paths, cx)
}
});
this.update_counts(active_repository.read(cx));
cx.notify();
task
})?
.await;
this.update(cx, |this, cx| {
if let Err(err) = result {
this.show_error_toast(if stage { "add" } else { "reset" }, err, cx);
this.update_counts(active_repository.read(cx));
}
cx.notify();
})
}
})
.detach();
}
pub fn total_staged_count(&self) -> usize {
self.tracked_staged_count + self.new_staged_count + self.conflicted_staged_count
}
pub fn stash_pop(&mut self, _: &StashPop, _window: &mut Window, cx: &mut Context<Self>) {
let Some(active_repository) = self.active_repository.clone() else {
return;
};
cx.spawn({
async move |this, cx| {
let stash_task = active_repository
.update(cx, |repo, cx| repo.stash_pop(None, cx))
.await;
this.update(cx, |this, cx| {
stash_task
.map_err(|e| {
this.show_error_toast("stash pop", e, cx);
})
.ok();
cx.notify();
})
}
})
.detach();
}
pub fn stash_apply(&mut self, _: &StashApply, _window: &mut Window, cx: &mut Context<Self>) {
let Some(active_repository) = self.active_repository.clone() else {
return;
};
cx.spawn({
async move |this, cx| {
let stash_task = active_repository
.update(cx, |repo, cx| repo.stash_apply(None, cx))
.await;
this.update(cx, |this, cx| {
stash_task
.map_err(|e| {
this.show_error_toast("stash apply", e, cx);
})
.ok();
cx.notify();
})
}
})
.detach();
}
pub fn stash_all(&mut self, _: &StashAll, _window: &mut Window, cx: &mut Context<Self>) {
let Some(active_repository) = self.active_repository.clone() else {
return;
};
cx.spawn({
async move |this, cx| {
let stash_task = active_repository
.update(cx, |repo, cx| repo.stash_all(cx))
.await;
this.update(cx, |this, cx| {
stash_task
.map_err(|e| {
this.show_error_toast("stash", e, cx);
})
.ok();
cx.notify();
})
}
})
.detach();
}
pub fn commit_message_buffer(&self, cx: &App) -> Entity<Buffer> {
self.commit_editor
.read(cx)
.buffer()
.read(cx)
.as_singleton()
.unwrap()
}
fn toggle_staged_for_selected(
&mut self,
_: &git::ToggleStaged,
window: &mut Window,
cx: &mut Context<Self>,
) {
if let Some(selected_entry) = self.get_selected_entry().cloned() {
self.toggle_staged_for_entry(&selected_entry, window, cx);
}
}
fn stage_range(&mut self, _: &git::StageRange, _window: &mut Window, cx: &mut Context<Self>) {
let Some(index) = self.selected_entry else {
return;
};
self.stage_bulk(index, cx);
}
fn stage_selected(&mut self, _: &git::StageFile, _window: &mut Window, cx: &mut Context<Self>) {
let Some(selected_entry) = self.get_selected_entry() else {
return;
};
let Some(status_entry) = selected_entry.status_entry() else {
return;
};
if status_entry.staging != StageStatus::Staged {
self.change_file_stage(true, vec![status_entry.clone()], cx);
}
}
fn unstage_selected(
&mut self,
_: &git::UnstageFile,
_window: &mut Window,
cx: &mut Context<Self>,
) {
let Some(selected_entry) = self.get_selected_entry() else {
return;
};
let Some(status_entry) = selected_entry.status_entry() else {
return;
};
if status_entry.staging != StageStatus::Unstaged {
self.change_file_stage(false, vec![status_entry.clone()], cx);
}
}
fn on_commit(&mut self, _: &Commit, window: &mut Window, cx: &mut Context<Self>) {
let is_amend = self.amend_pending;
if self.commit(&self.commit_editor.focus_handle(cx), window, cx) {
if is_amend {
telemetry::event!("Git Amended", source = "Git Panel");
} else {
telemetry::event!("Git Committed", source = "Git Panel");
}
}
}
/// Commits staged changes with the current commit message.
/// When `amend_pending` is true, performs an amend commit instead.
///
/// Returns `true` if the commit was executed, `false` otherwise.
pub(crate) fn commit(
&mut self,
commit_editor_focus_handle: &FocusHandle,
window: &mut Window,
cx: &mut Context<Self>,
) -> bool {
if commit_editor_focus_handle.contains_focused(window, cx) {
self.commit_changes(
CommitOptions {
amend: self.amend_pending,
signoff: self.signoff_enabled,
allow_empty: false,
},
window,
cx,
);
true
} else {
cx.propagate();
false
}
}
fn on_amend(&mut self, _: &Amend, window: &mut Window, cx: &mut Context<Self>) {
if self.amend(&self.commit_editor.focus_handle(cx), window, cx) {
telemetry::event!("Git Amended", source = "Git Panel");
}
}
/// Enters the amend state on first invocation, loading the last commit
/// message for editing. On second invocation, performs the amend commit
/// by delegating to [`Self::commit`]. Returns `true` if a commit was
/// executed.
pub(crate) fn amend(
&mut self,
commit_editor_focus_handle: &FocusHandle,
window: &mut Window,
cx: &mut Context<Self>,
) -> bool {
if commit_editor_focus_handle.contains_focused(window, cx) {
if self.head_commit(cx).is_some() {
if !self.amend_pending {
self.toggle_amend_pending(cx);
} else {
return self.commit(commit_editor_focus_handle, window, cx);
}
}
false
} else {
cx.propagate();
false
}
}
pub fn head_commit(&self, cx: &App) -> Option<CommitDetails> {
self.active_repository
.as_ref()
.and_then(|repo| repo.read(cx).head_commit.as_ref())
.cloned()
}
pub fn load_last_commit_message(&mut self, cx: &mut Context<Self>) {
let Some(head_commit) = self.head_commit(cx) else {
return;
};
let recent_sha = head_commit.sha.to_string();
let detail_task = self.load_commit_details(recent_sha, cx);
cx.spawn(async move |this, cx| {
if let Ok(message) = detail_task.await.map(|detail| detail.message) {
this.update(cx, |this, cx| {
this.commit_message_buffer(cx).update(cx, |buffer, cx| {
let start = buffer.anchor_before(0);
let end = buffer.anchor_after(buffer.len());
buffer.edit([(start..end, message)], None, cx);
});
})
.log_err();
}
})
.detach();
}
fn custom_or_suggested_commit_message(
&self,
window: &mut Window,
cx: &mut Context<Self>,
) -> Option<String> {
let git_commit_language = self
.commit_editor
.read(cx)
.language_at(MultiBufferOffset(0), cx);
let message = self.commit_editor.read(cx).text(cx);
if message.is_empty() {
return self
.suggest_commit_message(cx)
.filter(|message| !message.trim().is_empty());
} else if message.trim().is_empty() {
return None;
}
let buffer = cx.new(|cx| {
let mut buffer = Buffer::local(message, cx);
buffer.set_language(git_commit_language, cx);
buffer
});
let editor = cx.new(|cx| Editor::for_buffer(buffer, None, window, cx));
let wrapped_message = editor.update(cx, |editor, cx| {
editor.select_all(&Default::default(), window, cx);
editor.rewrap(
RewrapOptions {
override_language_settings: false,
preserve_existing_whitespace: true,
line_length: None,
},
cx,
);
editor.text(cx)
});
if wrapped_message.trim().is_empty() {
return None;
}
Some(wrapped_message)
}
fn has_commit_message(&self, cx: &mut Context<Self>) -> bool {
let text = self.commit_editor.read(cx).text(cx);
if !text.trim().is_empty() {
true
} else if text.is_empty() {
self.suggest_commit_message(cx)
.is_some_and(|text| !text.trim().is_empty())
} else {
false
}
}
pub(crate) fn commit_changes(
&mut self,
options: CommitOptions,
window: &mut Window,
cx: &mut Context<Self>,
) {
let Some(active_repository) = self.active_repository.clone() else {
return;
};
let error_spawn = |message, window: &mut Window, cx: &mut App| {
let prompt = window.prompt(PromptLevel::Warning, message, None, &["Ok"], cx);
cx.spawn(async move |_| {
prompt.await.ok();
})
.detach();
};
if self.has_unstaged_conflicts() {
error_spawn(
"There are still conflicts. You must stage these before committing",
window,
cx,
);
return;
}
let askpass = self.askpass_delegate("git commit", window, cx);
let commit_message = self.custom_or_suggested_commit_message(window, cx);
let Some(mut message) = commit_message else {
self.commit_editor
.read(cx)
.focus_handle(cx)
.focus(window, cx);
return;
};
if self.add_coauthors {
self.fill_co_authors(&mut message, cx);
}
let task = if self.has_staged_changes() {
// Repository serializes all git operations, so we can just send a commit immediately
let commit_task = active_repository.update(cx, |repo, cx| {
repo.commit(message.into(), None, options, askpass, cx)
});
cx.background_spawn(async move { commit_task.await? })
} else {
let changed_files = self
.entries
.iter()
.filter_map(|entry| entry.status_entry())
.filter(|status_entry| !status_entry.status.is_created())
.map(|status_entry| status_entry.repo_path.clone())
.collect::<Vec<_>>();
if changed_files.is_empty() && !options.amend {
error_spawn("No changes to commit", window, cx);
return;
}
let stage_task =
active_repository.update(cx, |repo, cx| repo.stage_entries(changed_files, cx));
cx.spawn(async move |_, cx| {
stage_task.await?;
let commit_task = active_repository.update(cx, |repo, cx| {
repo.commit(message.into(), None, options, askpass, cx)
});
commit_task.await?
})
};
let task = cx.spawn_in(window, async move |this, cx| {
let result = task.await;
this.update_in(cx, |this, window, cx| {
this.pending_commit.take();
match result {
Ok(()) => {
if options.amend {
this.set_amend_pending(false, cx);
} else {
this.commit_editor
.update(cx, |editor, cx| editor.clear(window, cx));
this.original_commit_message = None;
}
}
Err(e) => this.show_error_toast("commit", e, cx),
}
})
.ok();
});
self.pending_commit = Some(task);
}
pub(crate) fn uncommit(&mut self, window: &mut Window, cx: &mut Context<Self>) {
let Some(repo) = self.active_repository.clone() else {
return;
};
telemetry::event!("Git Uncommitted");
let confirmation = self.check_for_pushed_commits(window, cx);
let prior_head = self.load_commit_details("HEAD".to_string(), cx);
let task = cx.spawn_in(window, async move |this, cx| {
let result = maybe!(async {
if let Ok(true) = confirmation.await {
let prior_head = prior_head.await?;
repo.update(cx, |repo, cx| {
repo.reset("HEAD^".to_string(), ResetMode::Soft, cx)
})
.await??;
Ok(Some(prior_head))
} else {
Ok(None)
}
})
.await;
this.update_in(cx, |this, window, cx| {
this.pending_commit.take();
match result {
Ok(None) => {}
Ok(Some(prior_commit)) => {
this.commit_editor.update(cx, |editor, cx| {
editor.set_text(prior_commit.message, window, cx)
});
}
Err(e) => this.show_error_toast("reset", e, cx),
}
})
.ok();
});
self.pending_commit = Some(task);
}
fn check_for_pushed_commits(
&mut self,
window: &mut Window,
cx: &mut Context<Self>,
) -> impl Future<Output = anyhow::Result<bool>> + use<> {
let repo = self.active_repository.clone();
let mut cx = window.to_async(cx);
async move {
let repo = repo.context("No active repository")?;
let pushed_to: Vec<SharedString> = repo
.update(&mut cx, |repo, _| repo.check_for_pushed_commits())
.await??;
if pushed_to.is_empty() {
Ok(true)
} else {
#[derive(strum::EnumIter, strum::VariantNames)]
#[strum(serialize_all = "title_case")]
enum CancelUncommit {
Uncommit,
Cancel,
}
let detail = format!(
"This commit was already pushed to {}.",
pushed_to.into_iter().join(", ")
);
let result = cx
.update(|window, cx| prompt("Are you sure?", Some(&detail), window, cx))?
.await?;
match result {
CancelUncommit::Cancel => Ok(false),
CancelUncommit::Uncommit => Ok(true),
}
}
}
}
/// Suggests a commit message based on the changed files and their statuses
pub fn suggest_commit_message(&self, cx: &App) -> Option<String> {
if let Some(merge_message) = self
.active_repository
.as_ref()
.and_then(|repo| repo.read(cx).merge.message.as_ref())
{
return Some(merge_message.to_string());
}
let git_status_entry = if let Some(staged_entry) = &self.single_staged_entry {
Some(staged_entry)
} else if self.total_staged_count() == 0
&& let Some(single_tracked_entry) = &self.single_tracked_entry
{
Some(single_tracked_entry)
} else {
None
}?;
let action_text = if git_status_entry.status.is_deleted() {
Some("Delete")
} else if git_status_entry.status.is_created() {
Some("Create")
} else if git_status_entry.status.is_modified() {
Some("Update")
} else {
None
}?;
let file_name = git_status_entry
.repo_path
.file_name()
.unwrap_or_default()
.to_string();
Some(format!("{} {}", action_text, file_name))
}
fn generate_commit_message_action(
&mut self,
_: &git::GenerateCommitMessage,
_window: &mut Window,
cx: &mut Context<Self>,
) {
self.generate_commit_message(cx);
}
fn split_patch(patch: &str) -> Vec<String> {
let mut result = Vec::new();
let mut current_patch = String::new();
for line in patch.lines() {
if line.starts_with("---") && !current_patch.is_empty() {
result.push(current_patch.trim_end_matches('\n').into());
current_patch = String::new();
}
current_patch.push_str(line);
current_patch.push('\n');
}
if !current_patch.is_empty() {
result.push(current_patch.trim_end_matches('\n').into());
}
result
}
fn truncate_iteratively(patch: &str, max_bytes: usize) -> String {
let mut current_size = patch.len();
if current_size <= max_bytes {
return patch.to_string();
}
let file_patches = Self::split_patch(patch);
let mut file_infos: Vec<TruncatedPatch> = file_patches
.iter()
.filter_map(|patch| TruncatedPatch::from_unified_diff(patch))
.collect();
if file_infos.is_empty() {
return patch.to_string();
}
current_size = file_infos.iter().map(|f| f.calculate_size()).sum::<usize>();
while current_size > max_bytes {
let file_idx = file_infos
.iter()
.enumerate()
.filter(|(_, f)| f.hunks_to_keep > 1)
.max_by_key(|(_, f)| f.hunks_to_keep)
.map(|(idx, _)| idx);
match file_idx {
Some(idx) => {
let file = &mut file_infos[idx];
let size_before = file.calculate_size();
file.hunks_to_keep -= 1;
let size_after = file.calculate_size();
let saved = size_before.saturating_sub(size_after);
current_size = current_size.saturating_sub(saved);
}
None => {
break;
}
}
}
file_infos
.iter()
.map(|info| info.to_string())
.collect::<Vec<_>>()
.join("\n")
}
pub fn compress_commit_diff(diff_text: &str, max_bytes: usize) -> String {
if diff_text.len() <= max_bytes {
return diff_text.to_string();
}
let mut compressed = diff_text
.lines()
.map(|line| {
if line.len() > 256 {
format!("{}...[truncated]\n", &line[..line.floor_char_boundary(256)])
} else {
format!("{}\n", line)
}
})
.collect::<Vec<_>>()
.join("");
if compressed.len() <= max_bytes {
return compressed;
}
compressed = Self::truncate_iteratively(&compressed, max_bytes);
compressed
}
async fn load_project_rules(
project: &Entity<Project>,
repo_work_dir: &Arc<Path>,
cx: &mut AsyncApp,
) -> Option<String> {
let rules_path = cx.update(|cx| {
for worktree in project.read(cx).worktrees(cx) {
let worktree_abs_path = worktree.read(cx).abs_path();
if !worktree_abs_path.starts_with(&repo_work_dir) {
continue;
}
let worktree_snapshot = worktree.read(cx).snapshot();
for rules_name in RULES_FILE_NAMES {
if let Ok(rel_path) = RelPath::unix(rules_name) {
if let Some(entry) = worktree_snapshot.entry_for_path(rel_path) {
if entry.is_file() {
return Some(ProjectPath {
worktree_id: worktree.read(cx).id(),
path: entry.path.clone(),
});
}
}
}
}
}
None
})?;
let buffer = project
.update(cx, |project, cx| project.open_buffer(rules_path, cx))
.await
.ok()?;
let content = buffer
.read_with(cx, |buffer, _| buffer.text())
.trim()
.to_string();
if content.is_empty() {
None
} else {
Some(content)
}
}
fn build_commit_message_prompt(
prompt: &str,
user_agents_md: Option<&str>,
rules_content: Option<&str>,
subject: &str,
diff_text: &str,
) -> String {
let user_agents_md_section = match user_agents_md {
Some(user_agents_md) => format!(
"\n\nThe user has provided the following rules that you should follow when writing the commit message. Project-specific rules may override these instructions when they conflict:\n\
<rules>\n{user_agents_md}\n</rules>\n"
),
None => String::new(),
};
let rules_section = match rules_content {
Some(rules) => format!(
"\n\nThe user has provided the following rules specific to this project that you should follow when writing the commit message:\n\
<project_rules>\n{rules}\n</project_rules>\n"
),
None => String::new(),
};
let subject_section = if subject.trim().is_empty() {
String::new()
} else {
format!("\nHere is the user's subject line:\n{subject}")
};
format!(
"{prompt}{user_agents_md_section}{rules_section}{subject_section}\nHere are the changes in this commit:\n{diff_text}"
)
}
/// Generates a commit message using an LLM.
pub fn generate_commit_message(&mut self, cx: &mut Context<Self>) {
if !self.can_commit() || !AgentSettings::get_global(cx).enabled(cx) {
return;
}
let Some(ConfiguredModel { provider, model }) =
LanguageModelRegistry::read_global(cx).commit_message_model(cx)
else {
return;
};
let Some(repo) = self.active_repository.as_ref() else {
return;
};
telemetry::event!("Git Commit Message Generated");
let diff = repo.update(cx, |repo, cx| {
if self.has_staged_changes() {
repo.diff(DiffType::HeadToIndex, cx)
} else {
repo.diff(DiffType::HeadToWorktree, cx)
}
});
let temperature = AgentSettings::temperature_for_model(&model, cx);
let project = self.project.clone();
let repo_work_dir = repo.read(cx).work_directory_abs_path.clone();
self.generate_commit_message_task = Some(cx.spawn(async move |this, mut cx| {
async move {
let _defer = cx.on_drop(&this, |this, _cx| {
this.generate_commit_message_task.take();
});
if let Some(task) = cx.update(|cx| {
if !provider.is_authenticated(cx) {
Some(provider.authenticate(cx))
} else {
None
}
}) {
task.await.log_err();
}
let mut diff_text = match diff.await {
Ok(result) => match result {
Ok(text) => text,
Err(e) => {
Self::show_commit_message_error(&this, &e, cx);
return anyhow::Ok(());
}
},
Err(e) => {
Self::show_commit_message_error(&this, &e, cx);
return anyhow::Ok(());
}
};
const MAX_DIFF_BYTES: usize = 20_000;
diff_text = Self::compress_commit_diff(&diff_text, MAX_DIFF_BYTES);
let rules_content =
Self::load_project_rules(&project, &repo_work_dir, &mut cx).await;
let user_agents_md = cx.update(|cx| {
UserAgentsMd::global(cx)
.and_then(|user_agents_md| user_agents_md.content().cloned())
});
let prompt = include_str!("../src/commit_message_prompt.txt");
let subject = this.update(cx, |this, cx| {
this.commit_editor
.read(cx)
.text(cx)
.lines()
.next()
.map(ToOwned::to_owned)
.unwrap_or_default()
})?;
let text_empty = subject.trim().is_empty();
let content = Self::build_commit_message_prompt(
&prompt,
user_agents_md.as_deref(),
rules_content.as_deref(),
&subject,
&diff_text,
);
let request = LanguageModelRequest {
thread_id: None,
prompt_id: None,
intent: Some(CompletionIntent::GenerateGitCommitMessage),
messages: vec![LanguageModelRequestMessage {
role: Role::User,
content: vec![content.into()],
cache: false,
reasoning_details: None,
}],
tools: Vec::new(),
tool_choice: None,
stop: Vec::new(),
temperature,
thinking_allowed: false,
thinking_effort: None,
speed: None,
};
let stream = model.stream_completion_text(request, cx);
match stream.await {
Ok(mut messages) => {
if !text_empty {
this.update(cx, |this, cx| {
this.commit_message_buffer(cx).update(cx, |buffer, cx| {
let insert_position = buffer.anchor_before(buffer.len());
buffer.edit(
[(insert_position..insert_position, "\n")],
None,
cx,
)
});
})?;
}
while let Some(message) = messages.stream.next().await {
match message {
Ok(text) => {
this.update(cx, |this, cx| {
this.commit_message_buffer(cx).update(cx, |buffer, cx| {
let insert_position =
buffer.anchor_before(buffer.len());
buffer.edit(
[(insert_position..insert_position, text)],
None,
cx,
);
});
})?;
}
Err(e) => {
Self::show_commit_message_error(&this, &e, cx);
break;
}
}
}
}
Err(e) => {
Self::show_commit_message_error(&this, &e, cx);
}
}
anyhow::Ok(())
}
.log_err()
.await
}));
}
fn get_fetch_options(
&self,
window: &mut Window,
cx: &mut Context<Self>,
) -> Task<Option<FetchOptions>> {
let repo = self.active_repository.clone();
let workspace = self.workspace.clone();
cx.spawn_in(window, async move |_, cx| {
let repo = repo?;
let remotes = repo
.update(cx, |repo, _| repo.get_remotes(None, false))
.await
.ok()?
.log_err()?;
let mut remotes: Vec<_> = remotes.into_iter().map(FetchOptions::Remote).collect();
if remotes.len() > 1 {
remotes.push(FetchOptions::All);
}
let selection = cx
.update(|window, cx| {
picker_prompt::prompt(
"Pick which remote to fetch",
remotes.iter().map(|r| r.name()).collect(),
workspace,
window,
cx,
)
})
.ok()?
.await?;
remotes.get(selection).cloned()
})
}
pub(crate) fn fetch(
&mut self,
is_fetch_all: bool,
window: &mut Window,
cx: &mut Context<Self>,
) {
if !self.can_push_and_pull(cx) {
return;
}
let Some(repo) = self.active_repository.clone() else {
return;
};
telemetry::event!("Git Fetched");
let askpass = self.askpass_delegate("git fetch", window, cx);
let this = cx.weak_entity();
let fetch_options = if is_fetch_all {
Task::ready(Some(FetchOptions::All))
} else {
self.get_fetch_options(window, cx)
};
window
.spawn(cx, async move |cx| {
let Some(fetch_options) = fetch_options.await else {
return Ok(());
};
let fetch = repo.update(cx, |repo, cx| {
repo.fetch(fetch_options.clone(), askpass, cx)
});
let remote_message = fetch.await?;
this.update(cx, |this, cx| {
let action = match fetch_options {
FetchOptions::All => RemoteAction::Fetch(None),
FetchOptions::Remote(remote) => RemoteAction::Fetch(Some(remote)),
};
match remote_message {
Ok(remote_message) => this.show_remote_output(action, remote_message, cx),
Err(e) => {
log::error!("Error while fetching {:?}", e);
this.show_error_toast(action.name(), e, cx)
}
}
anyhow::Ok(())
})
.ok();
anyhow::Ok(())
})
.detach_and_log_err(cx);
}
pub(crate) fn git_clone(&mut self, repo: String, window: &mut Window, cx: &mut Context<Self>) {
let workspace = self.workspace.clone();
crate::clone::clone_and_open(
repo.into(),
workspace,
window,
cx,
Arc::new(|_workspace: &mut workspace::Workspace, _window, _cx| {}),
);
}
pub(crate) fn git_init(&mut self, window: &mut Window, cx: &mut Context<Self>) {
let worktrees = self
.project
.read(cx)
.visible_worktrees(cx)
.collect::<Vec<_>>();
let worktree = if worktrees.len() == 1 {
Task::ready(Some(worktrees.first().unwrap().clone()))
} else if worktrees.is_empty() {
let result = window.prompt(
PromptLevel::Warning,
"Unable to initialize a git repository",
Some("Open a directory first"),
&["Ok"],
cx,
);
cx.background_executor()
.spawn(async move {
result.await.ok();
})
.detach();
return;
} else {
let worktree_directories = worktrees
.iter()
.map(|worktree| worktree.read(cx).abs_path())
.map(|worktree_abs_path| {
if let Ok(path) = worktree_abs_path.strip_prefix(util::paths::home_dir()) {
Path::new("~")
.join(path)
.to_string_lossy()
.to_string()
.into()
} else {
worktree_abs_path.to_string_lossy().into_owned().into()
}
})
.collect_vec();
let prompt = picker_prompt::prompt(
"Where would you like to initialize this git repository?",
worktree_directories,
self.workspace.clone(),
window,
cx,
);
cx.spawn(async move |_, _| prompt.await.map(|ix| worktrees[ix].clone()))
};
cx.spawn_in(window, async move |this, cx| {
let worktree = match worktree.await {
Some(worktree) => worktree,
None => {
return;
}
};
let Ok(result) = this.update(cx, |this, cx| {
let fallback_branch_name = GitPanelSettings::get_global(cx)
.fallback_branch_name
.clone();
this.project.read(cx).git_init(
worktree.read(cx).abs_path(),
fallback_branch_name,
cx,
)
}) else {
return;
};
let result = result.await;
this.update_in(cx, |this, _, cx| match result {
Ok(()) => {}
Err(e) => this.show_error_toast("init", e, cx),
})
.ok();
})
.detach();
}
pub(crate) fn pull(&mut self, rebase: bool, window: &mut Window, cx: &mut Context<Self>) {
if !self.can_push_and_pull(cx) {
return;
}
let Some(repo) = self.active_repository.clone() else {
return;
};
let Some(branch) = repo.read(cx).branch.as_ref() else {
return;
};
telemetry::event!("Git Pulled");
let branch = branch.clone();
let remote = self.get_remote(false, false, window, cx);
cx.spawn_in(window, async move |this, cx| {
let remote = match remote.await {
Ok(Some(remote)) => remote,
Ok(None) => {
return Ok(());
}
Err(e) => {
log::error!("Failed to get current remote: {}", e);
this.update(cx, |this, cx| this.show_error_toast("pull", e, cx))
.ok();
return Ok(());
}
};
let askpass = this.update_in(cx, |this, window, cx| {
this.askpass_delegate(format!("git pull {}", remote.name), window, cx)
})?;
let branch_name = branch
.upstream
.is_none()
.then(|| branch.name().to_owned().into());
let pull = repo.update(cx, |repo, cx| {
repo.pull(branch_name, remote.name.clone(), rebase, askpass, cx)
});
let remote_message = pull.await?;
let action = RemoteAction::Pull(remote);
this.update(cx, |this, cx| match remote_message {
Ok(remote_message) => this.show_remote_output(action, remote_message, cx),
Err(e) => {
log::error!("Error while pulling {:?}", e);
this.show_error_toast(action.name(), e, cx)
}
})
.ok();
anyhow::Ok(())
})
.detach_and_log_err(cx);
}
pub(crate) fn push(
&mut self,
force_push: bool,
select_remote: bool,
window: &mut Window,
cx: &mut Context<Self>,
) {
if !self.can_push_and_pull(cx) {
return;
}
let Some(repo) = self.active_repository.clone() else {
return;
};
let Some(branch) = repo.read(cx).branch.as_ref() else {
return;
};
telemetry::event!("Git Pushed");
let branch = branch.clone();
let options = if force_push {
Some(PushOptions::Force)
} else {
match branch.upstream {
Some(Upstream {
tracking: UpstreamTracking::Gone,
..
})
| None => Some(PushOptions::SetUpstream),
_ => None,
}
};
let remote = self.get_remote(select_remote, true, window, cx);
cx.spawn_in(window, async move |this, cx| {
let remote = match remote.await {
Ok(Some(remote)) => remote,
Ok(None) => {
this.update(cx, |this, cx| {
this.show_error_toast(
"push",
anyhow::anyhow!("No remote available to push to. Add a remote to be able to publish changes."),
cx,
)
})
.ok();
return Ok(());
}
Err(e) => {
log::error!("Failed to get current remote: {}", e);
this.update(cx, |this, cx| this.show_error_toast("push", e, cx))
.ok();
return Ok(());
}
};
let askpass_delegate = this.update_in(cx, |this, window, cx| {
this.askpass_delegate(format!("git push {}", remote.name), window, cx)
})?;
let push = repo.update(cx, |repo, cx| {
repo.push(
branch.name().to_owned().into(),
branch
.upstream
.as_ref()
.filter(|u| matches!(u.tracking, UpstreamTracking::Tracked(_)))
.and_then(|u| u.branch_name())
.unwrap_or_else(|| branch.name())
.to_owned()
.into(),
remote.name.clone(),
options,
askpass_delegate,
cx,
)
});
let remote_output = push.await?;
let action = RemoteAction::Push(branch.name().to_owned().into(), remote);
this.update(cx, |this, cx| match remote_output {
Ok(remote_message) => this.show_remote_output(action, remote_message, cx),
Err(e) => {
log::error!("Error while pushing {:?}", e);
this.show_error_toast(action.name(), e, cx)
}
})?;
anyhow::Ok(())
})
.detach_and_log_err(cx);
}
/// Updates git's configuration, adding the directory of the current
/// worktree to the `safe.directory` config, ensuring that, even if the user
/// that's running the application is not the owner of `.git/`, it can still
/// read the repository's contents.
fn add_safe_directory(&mut self, window: &mut Window, cx: &mut Context<Self>) {
let Some(active_repository) = &self.active_repository else {
return;
};
let path = active_repository.update(cx, |repository, _cx| {
repository.snapshot().work_directory_abs_path
});
if let Some(path_str) = path.to_str() {
let path_arg = String::from(path_str);
let args = vec![
String::from("--global"),
String::from("--add"),
String::from("safe.directory"),
path_arg,
];
cx.spawn_in(window, async move |git_panel, cx| {
git_panel.update(cx, |git_panel, cx| {
git_panel.project.read(cx).git_config(path, args, cx)
})
})
.detach();
}
}
pub fn create_pull_request(&self, window: &mut Window, cx: &mut Context<Self>) {
let result = (|| -> anyhow::Result<()> {
let repo = self
.active_repository
.clone()
.ok_or_else(|| anyhow::anyhow!("No active repository"))?;
let (branch, remote_origin, remote_upstream) = {
let repository = repo.read(cx);
(
repository.branch.clone(),
repository.remote_origin_url.clone(),
repository.remote_upstream_url.clone(),
)
};
let branch = branch.ok_or_else(|| anyhow::anyhow!("No active branch"))?;
let source_branch = branch
.upstream
.as_ref()
.filter(|upstream| matches!(upstream.tracking, UpstreamTracking::Tracked(_)))
.and_then(|upstream| upstream.branch_name())
.ok_or_else(|| anyhow::anyhow!("No remote configured for repository"))?;
let source_branch = source_branch.to_string();
let remote_url = branch
.upstream
.as_ref()
.and_then(|upstream| match upstream.remote_name() {
Some("upstream") => remote_upstream.as_deref(),
Some(_) => remote_origin.as_deref(),
None => None,
})
.or(remote_origin.as_deref())
.or(remote_upstream.as_deref())
.ok_or_else(|| anyhow::anyhow!("No remote configured for repository"))?;
let remote_url = remote_url.to_string();
let provider_registry = GitHostingProviderRegistry::global(cx);
let Some((provider, parsed_remote)) =
git::parse_git_remote_url(provider_registry, &remote_url)
else {
return Err(anyhow::anyhow!("Unsupported remote URL: {}", remote_url));
};
let Some(url) = provider.build_create_pull_request_url(&parsed_remote, &source_branch)
else {
return Err(anyhow::anyhow!("Unable to construct pull request URL"));
};
cx.open_url(url.as_str());
Ok(())
})();
if let Err(err) = result {
log::error!("Error while creating pull request {:?}", err);
cx.defer_in(window, |panel, _window, cx| {
panel.show_error_toast("create pull request", err, cx);
});
}
}
fn askpass_delegate(
&self,
operation: impl Into<SharedString>,
window: &mut Window,
cx: &mut Context<Self>,
) -> AskPassDelegate {
let workspace = self.workspace.clone();
let operation = operation.into();
let window = window.window_handle();
AskPassDelegate::new(&mut cx.to_async(), move |prompt, tx, cx| {
window
.update(cx, |_, window, cx| {
workspace.update(cx, |workspace, cx| {
workspace.toggle_modal(window, cx, |window, cx| {
AskPassModal::new(operation.clone(), prompt.into(), tx, window, cx)
});
})
})
.ok();
})
}
fn can_push_and_pull(&self, cx: &App) -> bool {
!self.project.read(cx).is_via_collab()
}
fn get_remote(
&mut self,
always_select: bool,
is_push: bool,
window: &mut Window,
cx: &mut Context<Self>,
) -> impl Future<Output = anyhow::Result<Option<Remote>>> + use<> {
let repo = self.active_repository.clone();
let workspace = self.workspace.clone();
let mut cx = window.to_async(cx);
async move {
let repo = repo.context("No active repository")?;
let current_remotes: Vec<Remote> = repo
.update(&mut cx, |repo, _| {
let current_branch = if always_select {
None
} else {
let current_branch = repo.branch.as_ref().context("No active branch")?;
Some(current_branch.name().to_string())
};
anyhow::Ok(repo.get_remotes(current_branch, is_push))
})?
.await??;
let current_remotes: Vec<_> = current_remotes
.into_iter()
.map(|remotes| remotes.name)
.collect();
let selection = cx
.update(|window, cx| {
picker_prompt::prompt(
"Pick which remote to push to",
current_remotes.clone(),
workspace,
window,
cx,
)
})?
.await;
Ok(selection.map(|selection| Remote {
name: current_remotes[selection].clone(),
}))
}
}
pub fn load_local_committer(&mut self, cx: &Context<Self>) {
if self.local_committer_task.is_none() {
self.local_committer_task = Some(cx.spawn(async move |this, cx| {
let committer = get_git_committer(cx).await;
this.update(cx, |this, cx| {
this.local_committer = Some(committer);
cx.notify()
})
.ok();
}));
}
}
fn potential_co_authors(&self, cx: &App) -> Vec<(String, String)> {
let mut new_co_authors = Vec::new();
let project = self.project.read(cx);
let Some(room) =
call::ActiveCall::try_global(cx).and_then(|call| call.read(cx).room().cloned())
else {
return Vec::default();
};
let room = room.read(cx);
for (peer_id, collaborator) in project.collaborators() {
if collaborator.is_host {
continue;
}
let Some(participant) = room.remote_participant_for_peer_id(*peer_id) else {
continue;
};
if !participant.can_write() {
continue;
}
if let Some(email) = &collaborator.committer_email {
let name = collaborator
.committer_name
.clone()
.or_else(|| participant.user.name.clone())
.unwrap_or_else(|| participant.user.github_login.clone().to_string());
new_co_authors.push((name.clone(), email.clone()))
}
}
if !project.is_local()
&& !project.is_read_only(cx)
&& let Some(local_committer) = self.local_committer(room, cx)
{
new_co_authors.push(local_committer);
}
new_co_authors
}
fn local_committer(&self, room: &call::Room, cx: &App) -> Option<(String, String)> {
let user = room.local_participant_user(cx)?;
let committer = self.local_committer.as_ref()?;
let email = committer.email.clone()?;
let name = committer
.name
.clone()
.or_else(|| user.name.clone())
.unwrap_or_else(|| user.github_login.clone().to_string());
Some((name, email))
}
fn toggle_fill_co_authors(
&mut self,
_: &ToggleFillCoAuthors,
_: &mut Window,
cx: &mut Context<Self>,
) {
self.add_coauthors = !self.add_coauthors;
cx.notify();
}
fn toggle_sort_by_path(
&mut self,
_: &ToggleSortByPath,
_: &mut Window,
cx: &mut Context<Self>,
) {
let current_setting = GitPanelSettings::get_global(cx).sort_by_path;
if let Some(workspace) = self.workspace.upgrade() {
let workspace = workspace.read(cx);
let fs = workspace.app_state().fs.clone();
cx.update_global::<SettingsStore, _>(|store, _cx| {
store.update_settings_file(fs, move |settings, _cx| {
settings.git_panel.get_or_insert_default().sort_by_path =
Some(!current_setting);
});
});
}
}
fn toggle_tree_view(&mut self, _: &ToggleTreeView, _: &mut Window, cx: &mut Context<Self>) {
let current_setting = GitPanelSettings::get_global(cx).tree_view;
if let Some(workspace) = self.workspace.upgrade() {
let workspace = workspace.read(cx);
let fs = workspace.app_state().fs.clone();
cx.update_global::<SettingsStore, _>(|store, _cx| {
store.update_settings_file(fs, move |settings, _cx| {
settings.git_panel.get_or_insert_default().tree_view = Some(!current_setting);
});
})
}
}
pub(crate) fn increase_font_size(
&mut self,
action: &IncreaseBufferFontSize,
_: &mut Window,
cx: &mut Context<Self>,
) {
self.handle_font_size_action(action.persist, px(1.0), cx);
}
pub(crate) fn decrease_font_size(
&mut self,
action: &DecreaseBufferFontSize,
_: &mut Window,
cx: &mut Context<Self>,
) {
self.handle_font_size_action(action.persist, px(-1.0), cx);
}
fn handle_font_size_action(&mut self, persist: bool, delta: Pixels, cx: &mut Context<Self>) {
if persist {
update_settings_file(self.fs.clone(), cx, move |settings, cx| {
let git_commit_buffer_font_size =
ThemeSettings::get_global(cx).git_commit_buffer_font_size(cx) + delta;
let _ = settings.theme.git_commit_buffer_font_size.insert(
f32::from(theme_settings::clamp_font_size(git_commit_buffer_font_size)).into(),
);
});
} else {
theme_settings::adjust_git_commit_buffer_font_size(cx, |size| size + delta);
}
}
pub(crate) fn reset_font_size(
&mut self,
action: &ResetBufferFontSize,
_: &mut Window,
cx: &mut Context<Self>,
) {
if action.persist {
update_settings_file(self.fs.clone(), cx, move |settings, _| {
settings.theme.git_commit_buffer_font_size = None;
});
} else {
theme_settings::reset_git_commit_buffer_font_size(cx);
}
}
fn toggle_directory(&mut self, key: &TreeKey, window: &mut Window, cx: &mut Context<Self>) {
if let Some(state) = self.view_mode.tree_state_mut() {
let expanded = state.expanded_dirs.entry(key.clone()).or_insert(true);
*expanded = !*expanded;
self.update_visible_entries(window, cx);
} else {
util::debug_panic!("Attempted to toggle directory in flat Git Panel state");
}
}
fn fill_co_authors(&mut self, message: &mut String, cx: &mut Context<Self>) {
const CO_AUTHOR_PREFIX: &str = "Co-authored-by: ";
let existing_text = message.to_ascii_lowercase();
let lowercase_co_author_prefix = CO_AUTHOR_PREFIX.to_lowercase();
let mut ends_with_co_authors = false;
let existing_co_authors = existing_text
.lines()
.filter_map(|line| {
let line = line.trim();
if line.starts_with(&lowercase_co_author_prefix) {
ends_with_co_authors = true;
Some(line)
} else {
ends_with_co_authors = false;
None
}
})
.collect::<HashSet<_>>();
let new_co_authors = self
.potential_co_authors(cx)
.into_iter()
.filter(|(_, email)| {
!existing_co_authors
.iter()
.any(|existing| existing.contains(email.as_str()))
})
.collect::<Vec<_>>();
if new_co_authors.is_empty() {
return;
}
if !ends_with_co_authors {
message.push('\n');
}
for (name, email) in new_co_authors {
message.push('\n');
message.push_str(CO_AUTHOR_PREFIX);
message.push_str(&name);
message.push_str(" <");
message.push_str(&email);
message.push('>');
}
message.push('\n');
}
fn schedule_update(&mut self, window: &mut Window, cx: &mut Context<Self>) {
let handle = cx.entity().downgrade();
self.reopen_commit_buffer(window, cx);
self.preload_commit_history(cx);
if self.active_tab == GitPanelTab::History {
self.load_commit_history(cx);
}
self.update_visible_entries_task = cx.spawn_in(window, async move |_, cx| {
cx.background_executor().timer(UPDATE_DEBOUNCE).await;
if let Some(git_panel) = handle.upgrade() {
git_panel
.update_in(cx, |git_panel, window, cx| {
git_panel.update_visible_entries(window, cx);
})
.ok();
}
});
}
fn reopen_commit_buffer(&mut self, window: &mut Window, cx: &mut Context<Self>) {
let Some(active_repo) = self.active_repository.as_ref() else {
return;
};
let load_buffer = active_repo.update(cx, |active_repo, cx| {
let project = self.project.read(cx);
active_repo.open_commit_buffer(
Some(project.languages().clone()),
project.buffer_store().clone(),
cx,
)
});
let load_template = self.load_commit_template(cx);
cx.spawn_in(window, async move |git_panel, cx| {
let buffer = load_buffer.await?;
let template = load_template.await?;
git_panel.update_in(cx, |git_panel, window, cx| {
git_panel.commit_template = template;
if buffer.read(cx).text().trim().is_empty() {
let template_text = git_panel
.commit_template
.as_ref()
.map(|t| t.template.clone())
.unwrap_or_default();
if !template_text.is_empty() {
buffer.update(cx, |buffer, cx| {
let start = buffer.anchor_before(0);
let end = buffer.anchor_after(buffer.len());
buffer.edit([(start..end, template_text)], None, cx);
});
}
}
if git_panel
.commit_editor
.read(cx)
.buffer()
.read(cx)
.as_singleton()
.as_ref()
!= Some(&buffer)
{
git_panel.commit_editor = cx.new(|cx| {
commit_message_editor(
buffer,
git_panel.suggest_commit_message(cx).map(SharedString::from),
git_panel.project.clone(),
true,
window,
cx,
)
});
}
})
})
.detach_and_log_err(cx);
}
fn update_visible_entries(&mut self, window: &mut Window, cx: &mut Context<Self>) {
let path_style = self.project.read(cx).path_style(cx);
let bulk_staging = self.bulk_staging.take();
let last_staged_path_prev_index = bulk_staging
.as_ref()
.and_then(|op| self.entry_by_path(&op.anchor));
self.active_repository = self.project.read(cx).active_repository(cx);
self.entries.clear();
self.entries_indices.clear();
self.single_staged_entry.take();
self.single_tracked_entry.take();
self.conflicted_count = 0;
self.conflicted_staged_count = 0;
self.changes_count = 0;
self.new_count = 0;
self.tracked_count = 0;
self.new_staged_count = 0;
self.tracked_staged_count = 0;
self.entry_count = 0;
self.max_width_item_index = None;
self.git_access = GitAccess::Yes;
let sort_by_path = GitPanelSettings::get_global(cx).sort_by_path;
let is_tree_view = matches!(self.view_mode, GitPanelViewMode::Tree(_));
let group_by_status = is_tree_view || !sort_by_path;
if let Some(active_repo) = self.active_repository.as_ref() {
let access = active_repo.update(cx, |active_repo, cx| active_repo.access(cx));
cx.spawn_in(window, async move |git_panel, cx| {
// When the user does not own the `.git` folder, the
// `GitStore.spawn_local_git_worker` will fail to create the
// receiver for Git jobs, so this access check will be
// cancelled.
//
// We assume `GitAccess::No` on cancellation. I believe this is
// imprecise, other failures could also cause cancellation, but
// the consequence is just showing the "unsafe repo" UI, which
// seems acceptable for this edge case.
let access = match access.await {
Ok(access) => access,
Err(Canceled) => GitAccess::No,
};
git_panel.update(cx, |this, _cx| {
this.git_access = access;
})
})
.detach_and_log_err(cx);
}
let mut changed_entries = Vec::new();
let mut new_entries = Vec::new();
let mut conflict_entries = Vec::new();
let mut single_staged_entry = None;
let mut staged_count = 0;
let mut seen_directories = HashSet::default();
let mut max_width_estimate = 0usize;
let mut max_width_item_index = None;
let Some(repo) = self.active_repository.as_ref() else {
// Just clear entries if no repository is active.
cx.notify();
return;
};
let repo = repo.read(cx);
self.stash_entries = repo.cached_stash();
for entry in repo.cached_status() {
self.changes_count += 1;
let is_conflict = repo.had_conflict_on_last_merge_head_change(&entry.repo_path);
let is_new = entry.status.is_created();
let staging = entry.status.staging();
if let Some(pending) = repo.pending_ops_for_path(&entry.repo_path)
&& pending
.ops
.iter()
.any(|op| op.git_status == pending_op::GitStatus::Reverted && op.finished())
{
continue;
}
let entry = GitStatusEntry {
repo_path: entry.repo_path.clone(),
status: entry.status,
staging,
diff_stat: entry.diff_stat,
};
if staging.has_staged() {
staged_count += 1;
single_staged_entry = Some(entry.clone());
}
if group_by_status && is_conflict {
conflict_entries.push(entry);
} else if group_by_status && is_new {
new_entries.push(entry);
} else {
changed_entries.push(entry);
}
}
if conflict_entries.is_empty() {
if staged_count == 1
&& let Some(entry) = single_staged_entry.as_ref()
{
if let Some(ops) = repo.pending_ops_for_path(&entry.repo_path) {
if ops.staged() {
self.single_staged_entry = single_staged_entry;
}
} else {
self.single_staged_entry = single_staged_entry;
}
} else if repo.pending_ops_summary().item_summary.staging_count == 1
&& let Some(ops) = repo.pending_ops().find(|ops| ops.staging())
{
self.single_staged_entry =
repo.status_for_path(&ops.repo_path)
.map(|status| GitStatusEntry {
repo_path: ops.repo_path.clone(),
status: status.status,
staging: StageStatus::Staged,
diff_stat: status.diff_stat,
});
}
}
if conflict_entries.is_empty() && changed_entries.len() == 1 {
self.single_tracked_entry = changed_entries.first().cloned();
}
let mut push_entry =
|this: &mut Self,
entry: GitListEntry,
is_visible: bool,
logical_indices: Option<&mut Vec<usize>>| {
if let Some(estimate) =
this.width_estimate_for_list_entry(is_tree_view, &entry, path_style)
{
if estimate > max_width_estimate {
max_width_estimate = estimate;
max_width_item_index = Some(this.entries.len());
}
}
if let Some(repo_path) = entry.status_entry().map(|status| status.repo_path.clone())
{
this.entries_indices.insert(repo_path, this.entries.len());
}
if let (Some(indices), true) = (logical_indices, is_visible) {
indices.push(this.entries.len());
}
this.entries.push(entry);
};
macro_rules! take_section_entries {
() => {
[
(Section::Conflict, std::mem::take(&mut conflict_entries)),
(Section::Tracked, std::mem::take(&mut changed_entries)),
(Section::New, std::mem::take(&mut new_entries)),
]
};
}
match &mut self.view_mode {
GitPanelViewMode::Tree(tree_state) => {
tree_state.logical_indices.clear();
tree_state.directory_descendants.clear();
// This is just to get around the borrow checker
// because push_entry mutably borrows self
let mut tree_state = std::mem::take(tree_state);
for (section, entries) in take_section_entries!() {
if entries.is_empty() {
continue;
}
push_entry(
self,
GitListEntry::Header(GitHeaderEntry { header: section }),
true,
Some(&mut tree_state.logical_indices),
);
for (entry, is_visible) in
tree_state.build_tree_entries(section, entries, &mut seen_directories)
{
push_entry(
self,
entry,
is_visible,
Some(&mut tree_state.logical_indices),
);
}
}
tree_state
.expanded_dirs
.retain(|key, _| seen_directories.contains(key));
self.view_mode = GitPanelViewMode::Tree(tree_state);
}
GitPanelViewMode::Flat => {
for (section, entries) in take_section_entries!() {
if entries.is_empty() {
continue;
}
if section != Section::Tracked || !sort_by_path {
push_entry(
self,
GitListEntry::Header(GitHeaderEntry { header: section }),
true,
None,
);
}
for entry in entries {
push_entry(self, GitListEntry::Status(entry), true, None);
}
}
}
}
self.max_width_item_index = max_width_item_index;
self.update_counts(repo);
let bulk_staging_anchor_new_index = bulk_staging
.as_ref()
.filter(|op| op.repo_id == repo.id)
.and_then(|op| self.entry_by_path(&op.anchor));
if bulk_staging_anchor_new_index == last_staged_path_prev_index
&& let Some(index) = bulk_staging_anchor_new_index
&& let Some(entry) = self.entries.get(index)
&& let Some(entry) = entry.status_entry()
&& GitPanel::stage_status_for_entry(entry, &repo)
.as_bool()
.unwrap_or(false)
{
self.bulk_staging = bulk_staging;
}
self.select_first_entry_if_none(window, cx);
let suggested_commit_message = self.suggest_commit_message(cx);
let placeholder_text = suggested_commit_message.unwrap_or("Enter commit message".into());
self.commit_editor.update(cx, |editor, cx| {
editor.set_placeholder_text(&placeholder_text, window, cx)
});
cx.notify();
}
fn header_state(&self, header_type: Section) -> ToggleState {
let (staged_count, count) = match header_type {
Section::New => (self.new_staged_count, self.new_count),
Section::Tracked => (self.tracked_staged_count, self.tracked_count),
Section::Conflict => (self.conflicted_staged_count, self.conflicted_count),
};
if staged_count == 0 {
ToggleState::Unselected
} else if count == staged_count {
ToggleState::Selected
} else {
ToggleState::Indeterminate
}
}
fn update_counts(&mut self, repo: &Repository) {
self.show_placeholders = false;
self.conflicted_count = 0;
self.conflicted_staged_count = 0;
self.new_count = 0;
self.tracked_count = 0;
self.new_staged_count = 0;
self.tracked_staged_count = 0;
self.entry_count = 0;
for status_entry in self.entries.iter().filter_map(|entry| entry.status_entry()) {
self.entry_count += 1;
let is_staging_or_staged = GitPanel::stage_status_for_entry(status_entry, repo)
.as_bool()
.unwrap_or(true);
if repo.had_conflict_on_last_merge_head_change(&status_entry.repo_path) {
self.conflicted_count += 1;
if is_staging_or_staged {
self.conflicted_staged_count += 1;
}
} else if status_entry.status.is_created() {
self.new_count += 1;
if is_staging_or_staged {
self.new_staged_count += 1;
}
} else {
self.tracked_count += 1;
if is_staging_or_staged {
self.tracked_staged_count += 1;
}
}
}
}
pub(crate) fn has_staged_changes(&self) -> bool {
self.tracked_staged_count > 0
|| self.new_staged_count > 0
|| self.conflicted_staged_count > 0
}
pub(crate) fn has_unstaged_changes(&self) -> bool {
self.tracked_count > self.tracked_staged_count
|| self.new_count > self.new_staged_count
|| self.conflicted_count > self.conflicted_staged_count
}
fn has_tracked_changes(&self) -> bool {
self.tracked_count > 0
}
pub fn has_unstaged_conflicts(&self) -> bool {
self.conflicted_count > 0 && self.conflicted_count != self.conflicted_staged_count
}
fn show_error_toast(&self, action: impl Into<SharedString>, e: anyhow::Error, cx: &mut App) {
let Some(workspace) = self.workspace.upgrade() else {
return;
};
show_error_toast(workspace, action, e, cx)
}
fn show_git_job_queue(&mut self, window: &mut Window, cx: &mut Context<Self>) {
let Some(repo) = self.active_repository.as_ref() else {
let workspace = self.workspace.clone();
cx.defer(move |cx| {
if let Some(workspace) = workspace.upgrade() {
workspace.update(cx, |workspace, cx| {
struct GitJobQueueToast;
workspace.show_toast(
workspace::Toast::new(
NotificationId::unique::<GitJobQueueToast>(),
"No active repository",
)
.autohide(),
cx,
);
});
}
});
return;
};
let repo_path = repo.read(cx).work_directory_abs_path.display().to_string();
let queue_value = repo.read(cx).job_debug_queue().to_debug_value();
let title = format!("Git Job Queue: {repo_path}");
let json_language = self.project.read(cx).languages().language_for_name("JSON");
let project = self.project.clone();
let workspace = self.workspace.clone();
window
.spawn(cx, async move |cx| {
let json_language = json_language.await.ok();
// Best-effort: gather runtime diagnostics off the main thread.
// Any failure inside `gather` is logged and produces an empty
// section; this `.await` itself cannot meaningfully fail and
// must never prevent us from showing the queue dump.
let diagnostics = cx
.background_spawn(crate::git_runtime_diagnostics::gather())
.await;
let mut combined = queue_value;
if let serde_json::Value::Object(ref mut map) = combined
&& let serde_json::Value::Object(diag_map) = diagnostics
&& !diag_map.is_empty()
{
map.insert(
"runtime_diagnostics".into(),
serde_json::Value::Object(diag_map),
);
}
let text = serde_json::to_string_pretty(&combined).unwrap_or_default();
let buffer = project
.update(cx, |project, cx| {
project.create_buffer(json_language, false, cx)
})
.await?;
buffer.update(cx, |buffer, cx| {
buffer.set_text(text, cx);
buffer.set_capability(language::Capability::ReadWrite, cx);
});
workspace.update_in(cx, |workspace, window, cx| {
let buffer =
cx.new(|cx| MultiBuffer::singleton(buffer, cx).with_title(title.clone()));
workspace.add_item_to_active_pane(
Box::new(cx.new(|cx| {
let mut editor =
Editor::for_multibuffer(buffer, Some(project.clone()), window, cx);
editor.set_breadcrumb_header(title);
editor.disable_mouse_wheel_zoom();
editor
})),
None,
true,
window,
cx,
);
})?;
anyhow::Ok(())
})
.detach_and_log_err(cx);
}
fn show_commit_message_error<E>(weak_this: &WeakEntity<Self>, err: &E, cx: &mut AsyncApp)
where
E: std::fmt::Debug + std::fmt::Display,
{
if let Ok(Some(workspace)) = weak_this.update(cx, |this, _cx| this.workspace.upgrade()) {
let _ = workspace.update(cx, |workspace, cx| {
struct CommitMessageError;
let notification_id = NotificationId::unique::<CommitMessageError>();
workspace.show_notification(notification_id, cx, |cx| {
cx.new(|cx| {
ErrorMessagePrompt::new(
format!("Failed to generate commit message: {err}"),
cx,
)
})
});
});
}
}
fn show_remote_output(
&mut self,
action: RemoteAction,
info: RemoteCommandOutput,
cx: &mut Context<Self>,
) {
let Some(workspace) = self.workspace.upgrade() else {
return;
};
workspace.update(cx, |workspace, cx| {
let SuccessMessage { message, style } = remote_output::format_output(&action, info);
let workspace_weak = cx.weak_entity();
let operation = action.name();
let status_toast = StatusToast::new(message, cx, move |this, _cx| {
use remote_output::SuccessStyle::*;
match style {
Toast => this.icon(
Icon::new(IconName::GitBranch)
.size(IconSize::Small)
.color(Color::Muted),
),
ToastWithLog { output } => this
.icon(
Icon::new(IconName::GitBranch)
.size(IconSize::Small)
.color(Color::Muted),
)
.action("View Log", move |window, cx| {
let output = output.clone();
let output =
format!("stdout:\n{}\nstderr:\n{}", output.stdout, output.stderr);
workspace_weak
.update(cx, move |workspace, cx| {
open_output(operation, workspace, &output, window, cx)
})
.ok();
}),
PushPrLink { text, link } => this
.icon(
Icon::new(IconName::GitBranch)
.size(IconSize::Small)
.color(Color::Muted),
)
.action(text, move |_, cx| cx.open_url(&link)),
}
.dismiss_button(true)
});
workspace.toggle_status_toast(status_toast, cx)
});
}
pub fn can_commit(&self) -> bool {
(self.has_staged_changes() || self.has_tracked_changes()) && !self.has_unstaged_conflicts()
}
pub fn can_stage_all(&self) -> bool {
self.has_unstaged_changes()
}
pub fn can_unstage_all(&self) -> bool {
self.has_staged_changes()
}
/// Computes tree indentation depths for visible entries in the given range.
/// Used by indent guides to render vertical connector lines in tree view.
fn compute_visible_depths(&self, range: Range<usize>) -> SmallVec<[usize; 64]> {
let GitPanelViewMode::Tree(state) = &self.view_mode else {
return SmallVec::new();
};
range
.map(|ix| {
state
.logical_indices
.get(ix)
.and_then(|&entry_ix| self.entries.get(entry_ix))
.map_or(0, |entry| entry.depth())
})
.collect()
}
fn status_width_estimate(
tree_view: bool,
entry: &GitStatusEntry,
path_style: PathStyle,
depth: usize,
) -> usize {
if tree_view {
Self::item_width_estimate(0, entry.display_name(path_style).len(), depth)
} else {
Self::item_width_estimate(
entry.parent_dir(path_style).map(|s| s.len()).unwrap_or(0),
entry.display_name(path_style).len(),
0,
)
}
}
fn width_estimate_for_list_entry(
&self,
tree_view: bool,
entry: &GitListEntry,
path_style: PathStyle,
) -> Option<usize> {
match entry {
GitListEntry::Status(status) => Some(Self::status_width_estimate(
tree_view, status, path_style, 0,
)),
GitListEntry::TreeStatus(status) => Some(Self::status_width_estimate(
tree_view,
&status.entry,
path_style,
status.depth,
)),
GitListEntry::Directory(dir) => {
Some(Self::item_width_estimate(0, dir.name.len(), dir.depth))
}
GitListEntry::Header(_) => None,
}
}
fn item_width_estimate(path: usize, file_name: usize, depth: usize) -> usize {
path + file_name + depth * 2
}
fn render_ellipsis_menu(&self, id: impl Into<ElementId>) -> impl IntoElement {
let focus_handle = self.focus_handle.clone();
let has_tracked_changes = self.has_tracked_changes();
let has_staged_changes = self.has_staged_changes();
let has_unstaged_changes = self.has_unstaged_changes();
let has_new_changes = self.new_count > 0;
let has_stash_items = self.stash_entries.entries.len() > 0;
PopoverMenu::new(id.into())
.trigger(
IconButton::new("overflow-menu-trigger", IconName::Ellipsis)
.icon_size(IconSize::Small),
)
.menu(move |window, cx| {
Some(git_panel_context_menu(
focus_handle.clone(),
GitMenuState {
has_tracked_changes,
has_staged_changes,
has_unstaged_changes,
has_new_changes,
sort_by_path: GitPanelSettings::get_global(cx).sort_by_path,
has_stash_items,
tree_view: GitPanelSettings::get_global(cx).tree_view,
},
window,
cx,
))
})
.anchor(Anchor::TopRight)
}
pub(crate) fn render_generate_commit_message_button(
&self,
cx: &Context<Self>,
) -> Option<AnyElement> {
if !agent_settings::AgentSettings::get_global(cx).enabled(cx) {
return None;
}
if self.generate_commit_message_task.is_some() {
return Some(
h_flex()
.gap_1()
.child(
IconButton::new("cancel-generate-commit-message", IconName::Stop)
.icon_color(Color::Error)
.icon_size(IconSize::Small)
.style(ButtonStyle::Tinted(TintColor::Error))
.tooltip(Tooltip::text("Cancel Commit Message Generation"))
.on_click(cx.listener(|this, _event, _window, cx| {
this.generate_commit_message_task.take();
cx.notify();
})),
)
.child(
Label::new("Generating Commit…")
.size(LabelSize::Small)
.color(Color::Muted),
)
.into_any_element(),
);
}
let model_registry = LanguageModelRegistry::read_global(cx);
let has_commit_model_configuration_error = model_registry
.configuration_error(model_registry.commit_message_model(cx), cx)
.is_some();
let can_commit = self.can_commit();
let editor_focus_handle = self.commit_editor.focus_handle(cx);
Some(
IconButton::new("generate-commit-message", IconName::AiEdit)
.shape(ui::IconButtonShape::Square)
.icon_color(if has_commit_model_configuration_error {
Color::Disabled
} else {
Color::Muted
})
.tooltip(move |_window, cx| {
if !can_commit {
Tooltip::simple("No Changes to Commit", cx)
} else if has_commit_model_configuration_error {
Tooltip::simple("Configure an LLM provider to generate commit messages", cx)
} else {
Tooltip::for_action_in(
"Generate Commit Message",
&git::GenerateCommitMessage,
&editor_focus_handle,
cx,
)
}
})
.disabled(!can_commit || has_commit_model_configuration_error)
.on_click(cx.listener(move |this, _event, _window, cx| {
this.generate_commit_message(cx);
}))
.into_any_element(),
)
}
pub(crate) fn render_co_authors(&self, cx: &Context<Self>) -> Option<AnyElement> {
let potential_co_authors = self.potential_co_authors(cx);
let (tooltip_label, icon) = if self.add_coauthors {
("Remove co-authored-by", IconName::Person)
} else {
("Add co-authored-by", IconName::UserCheck)
};
if potential_co_authors.is_empty() {
None
} else {
Some(
IconButton::new("co-authors", icon)
.shape(ui::IconButtonShape::Square)
.icon_color(Color::Disabled)
.selected_icon_color(Color::Selected)
.toggle_state(self.add_coauthors)
.tooltip(move |_, cx| {
let title = format!(
"{}:{}{}",
tooltip_label,
if potential_co_authors.len() == 1 {
""
} else {
"\n"
},
potential_co_authors
.iter()
.map(|(name, email)| format!(" {} <{}>", name, email))
.join("\n")
);
Tooltip::simple(title, cx)
})
.on_click(cx.listener(|this, _, _, cx| {
this.add_coauthors = !this.add_coauthors;
cx.notify();
}))
.into_any_element(),
)
}
}
fn render_git_commit_menu(
&self,
id: impl Into<ElementId>,
keybinding_target: Option<FocusHandle>,
cx: &mut Context<Self>,
) -> impl IntoElement {
PopoverMenu::new(id.into())
.trigger(
ui::ButtonLike::new_rounded_right("commit-split-button-right")
.layer(ui::ElevationIndex::ModalSurface)
.size(ButtonSize::None)
.child(
h_flex()
.px_1()
.h_full()
.justify_center()
.border_l_1()
.border_color(cx.theme().colors().border)
.child(Icon::new(IconName::ChevronDown).size(IconSize::XSmall)),
),
)
.menu({
let git_panel = cx.entity();
let has_previous_commit = self.head_commit(cx).is_some();
let amend = self.amend_pending();
let signoff = self.signoff_enabled;
move |window, cx| {
Some(ContextMenu::build(window, cx, |context_menu, _, _| {
context_menu
.when_some(keybinding_target.clone(), |el, keybinding_target| {
el.context(keybinding_target)
})
.when(has_previous_commit, |this| {
this.toggleable_entry(
"Amend",
amend,
IconPosition::Start,
Some(Box::new(Amend)),
{
let git_panel = git_panel.downgrade();
move |_, cx| {
git_panel
.update(cx, |git_panel, cx| {
git_panel.toggle_amend_pending(cx);
})
.ok();
}
},
)
})
.toggleable_entry(
"Signoff",
signoff,
IconPosition::Start,
Some(Box::new(Signoff)),
move |window, cx| window.dispatch_action(Box::new(Signoff), cx),
)
}))
}
})
.anchor(Anchor::TopRight)
}
pub fn configure_commit_button(&self, cx: &mut Context<Self>) -> (bool, &'static str) {
if self.has_unstaged_conflicts() {
(false, "You must resolve conflicts before committing")
} else if !self.has_staged_changes() && !self.has_tracked_changes() && !self.amend_pending {
(false, "No changes to commit")
} else if self.pending_commit.is_some() {
(false, "Commit in progress")
} else if !self.has_commit_message(cx) {
(false, "No commit message")
} else if !self.has_write_access(cx) {
(false, "You do not have write access to this project")
} else {
(true, self.commit_button_title())
}
}
pub fn commit_button_title(&self) -> &'static str {
if self.amend_pending {
if self.has_staged_changes() {
"Amend"
} else if self.has_tracked_changes() {
"Amend Tracked"
} else {
"Amend"
}
} else if self.has_staged_changes() {
"Commit"
} else {
"Commit Tracked"
}
}
fn toggle_fill_commit_editor(
&mut self,
_: &ToggleFillCommitEditor,
_window: &mut Window,
cx: &mut Context<Self>,
) {
self.commit_editor_expanded = !self.commit_editor_expanded;
self.commit_editor.update(cx, |editor, _cx| {
if self.commit_editor_expanded {
editor.set_mode(EditorMode::Full {
scale_ui_elements_with_buffer_font_size: false,
show_active_line_background: false,
sizing_behavior: SizingBehavior::ExcludeOverscrollMargin,
})
} else {
editor.set_mode(EditorMode::AutoHeight {
min_lines: MAX_PANEL_EDITOR_LINES,
max_lines: Some(MAX_PANEL_EDITOR_LINES),
})
}
});
cx.notify();
}
fn expand_commit_editor(
&mut self,
_: &ExpandCommitEditor,
window: &mut Window,
cx: &mut Context<Self>,
) {
let workspace = self.workspace.clone();
window.defer(cx, move |window, cx| {
workspace
.update(cx, |workspace, cx| {
CommitModal::toggle(workspace, None, window, cx)
})
.ok();
})
}
fn render_changes_header(
&self,
_window: &mut Window,
cx: &mut Context<Self>,
) -> Option<impl IntoElement> {
if matches!(self.git_access, GitAccess::No) {
return None;
}
self.active_repository.as_ref()?;
let (text, action, stage, tooltip) =
if self.total_staged_count() == self.entry_count && self.entry_count > 0 {
("Unstage All", UnstageAll.boxed_clone(), false, "git reset")
} else {
("Stage All", StageAll.boxed_clone(), true, "git add --all")
};
Some(
h_flex()
.h(Tab::container_height(cx))
.w_full()
.px_1()
.flex_none()
.justify_between()
.child(
Button::new("changes", "View Diff")
.label_size(LabelSize::Small)
.color(Color::Muted)
.start_icon(
Icon::new(IconName::Diff)
.size(IconSize::Small)
.color(Color::Muted),
)
.tooltip(Tooltip::for_action_title_in(
"View Diff",
&Diff,
&self.focus_handle,
))
.on_click(|_, _, cx| {
cx.defer(|cx| {
cx.dispatch_action(&Diff);
})
}),
)
.child(
h_flex()
.gap_1()
.child(self.render_ellipsis_menu("overflow_menu"))
.child(
Button::new("stage_unstage_all", text)
.label_size(LabelSize::Small)
.layer(ElevationIndex::ModalSurface)
.style(ButtonStyle::Filled)
.tooltip(Tooltip::for_action_title_in(
tooltip,
action.as_ref(),
&self.focus_handle,
))
.disabled(self.entry_count == 0)
.on_click({
let git_panel = cx.weak_entity();
move |_, _, cx| {
git_panel
.update(cx, |git_panel, cx| {
git_panel.change_all_files_stage(stage, cx);
})
.ok();
}
}),
),
),
)
}
pub(crate) fn render_remote_button(&self, cx: &mut Context<Self>) -> Option<AnyElement> {
let branch = self.active_repository.as_ref()?.read(cx).branch.clone();
if !self.can_push_and_pull(cx) {
return None;
}
Some(
h_flex()
.gap_1()
.flex_shrink_0()
.when_some(branch, |this, branch| {
let focus_handle = Some(self.focus_handle(cx));
this.children(render_remote_button(
"remote-button",
&branch,
focus_handle,
true,
))
})
.into_any_element(),
)
}
pub fn render_footer(
&self,
window: &mut Window,
cx: &mut Context<Self>,
) -> Option<impl IntoElement> {
let active_repository = self.active_repository.clone()?;
let settings = ThemeSettings::get_global(cx);
let panel_editor_style =
git_commit_editor_style(settings.git_commit_buffer_font_size(cx), cx);
let enable_coauthors = self.render_co_authors(cx);
let editor_focus_handle = self.commit_editor.focus_handle(cx);
let branch = active_repository.read(cx).branch.clone();
let head_commit = active_repository.read(cx).head_commit.clone();
let footer_size = px(32.);
let gap = px(9.0);
let max_height = panel_editor_style
.text
.line_height_in_pixels(window.rem_size())
* MAX_PANEL_EDITOR_LINES
+ gap;
let git_panel = cx.entity();
let display_name = SharedString::from(Arc::from(
active_repository
.read(cx)
.display_name()
.trim_end_matches("/"),
));
let editor_is_long = self.commit_editor.update(cx, |editor, cx| {
editor.max_point(cx).row().0 >= MAX_PANEL_EDITOR_LINES as u32
});
let max_title_length = GitPanelSettings::get_global(cx).commit_title_max_length;
let title_exceeds_limit = if max_title_length > 0 {
self.commit_editor
.read(cx)
.text(cx)
.lines()
.next()
.is_some_and(|title| commit_title_exceeds_limit(title, max_title_length))
} else {
false
};
let footer = v_flex()
.when(self.commit_editor_expanded, |this| this.flex_1().min_h_0())
.child(PanelRepoFooter::new(
display_name,
branch,
head_commit,
Some(git_panel),
))
.when(title_exceeds_limit, |this| {
this.child(
h_flex()
.px_2()
.py_1()
.gap_1()
.border_t_1()
.border_color(cx.theme().status().warning_border)
.bg(cx.theme().status().warning_background.opacity(0.5))
.child(
Icon::new(IconName::Warning)
.size(IconSize::XSmall)
.color(Color::Warning),
)
.child(
Label::new(format!(
"Commit message title exceeds {max_title_length}-character limit."
))
.size(LabelSize::Small),
),
)
})
.child(
panel_editor_container(window, cx)
.id("commit-editor-container")
.cursor_text()
.relative()
.w_full()
.when(self.commit_editor_expanded, |this| this.flex_1().min_h_0())
.when(!self.commit_editor_expanded, |this| {
this.h(max_height + footer_size)
})
.border_t_1()
.border_color(if title_exceeds_limit {
cx.theme().status().warning_border
} else {
cx.theme().colors().border
})
.on_click(cx.listener(move |this, _: &ClickEvent, window, cx| {
window.focus(&this.commit_editor.focus_handle(cx), cx);
}))
.child(
h_flex()
.id("commit-footer")
.border_t_1()
.when(editor_is_long, |el| {
el.border_color(cx.theme().colors().border_variant)
})
.absolute()
.bottom_0()
.left_0()
.w_full()
.px_2()
.h(footer_size)
.flex_none()
.justify_between()
.child(
self.render_generate_commit_message_button(cx)
.unwrap_or_else(|| div().into_any_element()),
)
.child(
h_flex()
.gap_0p5()
.children(enable_coauthors)
.child(self.render_commit_button(cx)),
),
)
.child(
div()
.when(self.commit_editor_expanded, |this| {
this.flex_1().min_h_0().pb(footer_size)
})
.pr_2p5()
.on_action(|&zed_actions::editor::MoveUp, _, cx| {
cx.stop_propagation();
})
.on_action(|&zed_actions::editor::MoveDown, _, cx| {
cx.stop_propagation();
})
.child(EditorElement::new(&self.commit_editor, panel_editor_style)),
)
.child(
v_flex()
.absolute()
.top_2()
.right_2()
.gap_px()
.opacity(0.6)
.hover(|s| s.opacity(1.0))
.child(
IconButton::new("expand-commit-editor", IconName::MaximizeAlt)
.icon_size(IconSize::Small)
.tooltip({
move |_window, cx| {
Tooltip::for_action_in(
"Open Commit Modal",
&git::ExpandCommitEditor,
&editor_focus_handle,
cx,
)
}
})
.on_click(cx.listener({
move |_, _, window, cx| {
window.dispatch_action(
git::ExpandCommitEditor.boxed_clone(),
cx,
)
}
})),
)
.child({
let (icon, label) = if self.commit_editor_expanded {
(IconName::Minimize, "Collapse Commit Editor")
} else {
(IconName::Maximize, "Expand Commit Editor")
};
let focus_handle = self.focus_handle.clone();
IconButton::new("fill-commit-editor", icon)
.icon_size(IconSize::Small)
.tooltip({
move |_window, cx| {
Tooltip::for_action_in(
label,
&git::ToggleFillCommitEditor,
&focus_handle,
cx,
)
}
})
.on_click(cx.listener({
move |_, _, window, cx| {
window.dispatch_action(
git::ToggleFillCommitEditor.boxed_clone(),
cx,
)
}
}))
}),
),
);
Some(footer)
}
fn render_commit_button(&self, cx: &mut Context<Self>) -> impl IntoElement {
let (can_commit, tooltip) = self.configure_commit_button(cx);
let title = self.commit_button_title();
let commit_tooltip_focus_handle = self.commit_editor.focus_handle(cx);
let amend = self.amend_pending();
let signoff = self.signoff_enabled;
let label_color = if self.pending_commit.is_some() {
Color::Disabled
} else {
Color::Default
};
div()
.id("commit-wrapper")
.on_hover(cx.listener(move |this, hovered, _, cx| {
this.show_placeholders =
*hovered && !this.has_staged_changes() && !this.has_unstaged_conflicts();
cx.notify()
}))
.child(SplitButton::new(
ButtonLike::new_rounded_left(ElementId::Name(
format!("split-button-left-{}", title).into(),
))
.layer(ElevationIndex::ModalSurface)
.size(ButtonSize::Compact)
.child(
Label::new(title)
.size(LabelSize::Small)
.color(label_color)
.mr_0p5(),
)
.on_click({
let git_panel = cx.weak_entity();
move |_, window, cx| {
telemetry::event!("Git Committed", source = "Git Panel");
git_panel
.update(cx, |git_panel, cx| {
git_panel.commit_changes(
CommitOptions {
amend,
signoff,
allow_empty: false,
},
window,
cx,
);
})
.ok();
}
})
.disabled(!can_commit || self.modal_open)
.tooltip({
let handle = commit_tooltip_focus_handle.clone();
move |_window, cx| {
if can_commit {
Tooltip::with_meta_in(
tooltip,
Some(&git::Commit),
format!(
"git commit{}{}",
if amend { " --amend" } else { "" },
if signoff { " --signoff" } else { "" }
),
&handle.clone(),
cx,
)
} else {
Tooltip::simple(tooltip, cx)
}
}
}),
self.render_git_commit_menu(
ElementId::Name(format!("split-button-right-{}", title).into()),
Some(commit_tooltip_focus_handle),
cx,
)
.into_any_element(),
))
}
fn render_pending_amend(&self, cx: &mut Context<Self>) -> impl IntoElement {
h_flex()
.py_1p5()
.px_2()
.gap_1p5()
.justify_between()
.border_t_1()
.border_color(cx.theme().colors().border.opacity(0.8))
.child(
div()
.flex_grow()
.overflow_hidden()
.max_w(relative(0.85))
.child(
Label::new("This will update your most recent commit.")
.size(LabelSize::Small)
.truncate(),
),
)
.child(
Button::new("cancel", "Cancel")
.label_size(LabelSize::Small)
.layer(ElevationIndex::ModalSurface)
.on_click(cx.listener(|this, _, _, cx| this.set_amend_pending(false, cx))),
)
}
fn render_previous_commit(
&self,
_window: &mut Window,
cx: &mut Context<Self>,
) -> Option<impl IntoElement> {
let active_repository = self.active_repository.as_ref()?;
let branch = active_repository.read(cx).branch.as_ref()?;
let commit = branch.most_recent_commit.as_ref()?.clone();
let workspace = self.workspace.clone();
let this = cx.entity();
Some(
h_flex()
.p_1p5()
.gap_1p5()
.justify_between()
.border_t_1()
.border_color(cx.theme().colors().border.opacity(0.8))
.child(
div()
.id("commit-msg-hover")
.cursor_pointer()
.px_1()
.rounded_sm()
.line_clamp(1)
.hover(|s| s.bg(cx.theme().colors().element_hover))
.child(
Label::new(commit.subject.clone())
.size(LabelSize::Small)
.truncate(),
)
.on_click({
let commit = commit.clone();
let repo = active_repository.downgrade();
move |_, window, cx| {
CommitView::open(
commit.sha.to_string(),
repo.clone(),
workspace.clone(),
None,
None,
window,
cx,
);
}
})
.hoverable_tooltip({
let repo = active_repository.clone();
move |window, cx| {
GitPanelMessageTooltip::new(
this.clone(),
commit.sha.clone(),
repo.clone(),
window,
cx,
)
.into()
}
}),
)
.child(
h_flex()
.gap_0p5()
.when(commit.has_parent, |this| {
let has_unstaged = self.has_unstaged_changes();
this.child(
IconButton::new("undo", IconName::Undo)
.icon_size(IconSize::Small)
.tooltip(move |_window, cx| {
Tooltip::with_meta(
"Uncommit",
Some(&git::Uncommit),
if has_unstaged {
"git reset HEAD^ --soft"
} else {
"git reset HEAD^"
},
cx,
)
})
.on_click(
cx.listener(|this, _, window, cx| {
this.uncommit(window, cx)
}),
),
)
})
.child(
IconButton::new("git-graph-button", IconName::GitGraph)
.icon_size(IconSize::Small)
.tooltip(|_window, cx| {
Tooltip::for_action("Open Git Graph", &Open, cx)
})
.on_click(|_, window, cx| {
window.dispatch_action(Open.boxed_clone(), cx)
}),
),
),
)
}
fn render_tab_bar(&self, cx: &mut Context<Self>) -> impl IntoElement {
let active_tab = self.active_tab;
let focus_handle = self.focus_handle.clone();
let tab = |id: ElementId,
active: bool,
show_changes: bool,
label: SharedString,
set_active_tab: GitPanelTab,
tooltip_action: Box<dyn Action>| {
let focus_handle = focus_handle.clone();
h_flex()
.cursor_pointer()
.id(id)
.h_full()
.py_1()
.gap_1()
.flex_1()
.justify_center()
.hover(|s| s.bg(cx.theme().colors().element_hover))
.border_b_1()
.when(!active, |s| {
s.bg(cx.theme().colors().editor_background.opacity(0.6))
.border_color(cx.theme().colors().border.opacity(0.6))
})
.child(Label::new(label.clone()).when(!active, |this| this.color(Color::Muted)))
.when(show_changes && self.changes_count > 0, |this| {
this.child(
Label::new(format!("({})", self.changes_count))
.size(LabelSize::Small)
.color(Color::Muted),
)
})
.tooltip(Tooltip::for_action_title_in(
format!("Toggle {} Tab", label),
tooltip_action.as_ref(),
&focus_handle,
))
.on_click(cx.listener(move |this, _, window, cx| {
this.set_active_tab(set_active_tab, window, cx)
}))
};
h_flex()
.relative()
.h(Tab::container_height(cx))
.w_full()
.child(tab(
ElementId::Name("changes-tab".into()),
active_tab == GitPanelTab::Changes,
true,
"Changes".into(),
GitPanelTab::Changes,
ActivateChangesTab.boxed_clone(),
))
.child(Divider::vertical().color(ui::DividerColor::BorderFaded))
.child(tab(
ElementId::Name("history-tab".into()),
active_tab != GitPanelTab::Changes,
false,
"History".into(),
GitPanelTab::History,
ActivateHistoryTab.boxed_clone(),
))
}
fn render_history_tab(&self, window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
v_flex().flex_1().size_full().overflow_hidden().map(|this| {
if let Some(history) = self.render_commit_history(window, cx) {
this.child(history)
} else {
this.child(
h_flex()
.flex_1()
.justify_center()
.child(Label::new("Loading Commit History…").color(Color::Muted)),
)
}
})
}
fn select_next_history_entry(&mut self, cx: &mut Context<Self>) {
let count = self.commit_history_shas.len();
if count == 0 {
return;
}
let new_index = match self.focused_history_entry {
None => 0,
Some(i) => (i + 1).min(count - 1),
};
self.focused_history_entry = Some(new_index);
self.history_keyboard_nav = true;
self.commit_history_scroll_handle
.scroll_to_item(new_index, ScrollStrategy::Top);
cx.notify();
}
fn select_previous_history_entry(&mut self, cx: &mut Context<Self>) {
let count = self.commit_history_shas.len();
if count == 0 {
return;
}
let new_index = match self.focused_history_entry {
None => 0,
Some(i) => i.saturating_sub(1),
};
self.focused_history_entry = Some(new_index);
self.history_keyboard_nav = true;
self.commit_history_scroll_handle
.scroll_to_item(new_index, ScrollStrategy::Top);
cx.notify();
}
fn open_selected_history_commit(&self, window: &mut Window, cx: &mut App) {
let Some(index) = self.focused_history_entry else {
return;
};
let Some(sha) = self.commit_history_shas.get(index) else {
return;
};
let Some(active_repository) = self.active_repository.as_ref() else {
return;
};
CommitView::open(
sha.to_string(),
active_repository.downgrade(),
self.workspace.clone(),
None,
None,
window,
cx,
);
}
fn activate_changes_tab(
&mut self,
_: &ActivateChangesTab,
window: &mut Window,
cx: &mut Context<Self>,
) {
self.set_active_tab(GitPanelTab::Changes, window, cx);
}
fn activate_history_tab(
&mut self,
_: &ActivateHistoryTab,
window: &mut Window,
cx: &mut Context<Self>,
) {
self.set_active_tab(GitPanelTab::History, window, cx);
}
fn set_active_tab(&mut self, tab: GitPanelTab, window: &mut Window, cx: &mut Context<Self>) {
if self.active_tab == tab {
return;
}
self.active_tab = tab;
match tab {
GitPanelTab::History => {
self.focus_handle.focus(window, cx);
self.load_commit_history(cx);
self.focused_history_entry = Some(0);
}
GitPanelTab::Changes => {
self.focus_handle.focus(window, cx);
self.commit_history_shas.clear();
self.focused_history_entry = None;
self._repo_subscriptions.clear();
}
}
cx.notify();
}
fn preload_commit_history(&mut self, cx: &mut Context<Self>) {
let Some(active_repository) = self.active_repository.as_ref() else {
return;
};
let Some(branch) = active_repository.read(cx).branch.as_ref() else {
return;
};
let branch_name = branch.name().to_string();
let log_source = LogSource::Branch(branch_name.into());
let log_order = LogOrder::DateOrder;
// Kick off the git log fetch so data is ready when the user switches to History.
// graph_data() is idempotent — if already loading/loaded, this is a no-op.
active_repository.update(cx, |repository, cx| {
repository.graph_data(log_source, log_order, 0..0, cx);
});
}
fn load_commit_history(&mut self, cx: &mut Context<Self>) {
let Some(active_repository) = self.active_repository.as_ref() else {
return;
};
if self._repo_subscriptions.is_empty() {
self._repo_subscriptions.push(cx.subscribe(
active_repository,
|this, _repo, event, cx| {
if let RepositoryEvent::GraphEvent(_, _) = event {
if this.active_tab == GitPanelTab::History {
this.fetch_commit_history_shas(cx);
}
}
},
));
self._repo_subscriptions
.push(cx.observe(active_repository, |_this, _repo, cx| {
cx.notify();
}));
}
self.fetch_commit_history_shas(cx);
}
fn fetch_commit_history_shas(&mut self, cx: &mut Context<Self>) {
let Some(active_repository) = self.active_repository.as_ref() else {
return;
};
let Some(branch) = active_repository.read(cx).branch.as_ref() else {
return;
};
let branch_name = branch.name().to_string();
let log_source = LogSource::Branch(branch_name.into());
let log_order = LogOrder::DateOrder;
self.commit_history_shas = active_repository.update(cx, |repository, cx| {
let response = repository.graph_data(log_source, log_order, 0..usize::MAX, cx);
response.commits.iter().map(|commit| commit.sha).collect()
});
}
fn git_remote(&self, cx: &mut App) -> Option<GitRemote> {
let repo = self.active_repository.as_ref()?;
let remote_url = repo.read(cx).default_remote_url()?;
let provider_registry = GitHostingProviderRegistry::default_global(cx);
let (provider, parsed) = parse_git_remote_url(provider_registry, &remote_url)?;
Some(GitRemote {
host: provider,
owner: parsed.owner.into(),
repo: parsed.repo.into(),
})
}
fn render_commit_history(
&self,
window: &mut Window,
cx: &mut Context<Self>,
) -> Option<impl IntoElement> {
if self.commit_history_shas.is_empty() {
return None;
}
let active_repository = self.active_repository.as_ref()?;
let workspace = self.workspace.clone();
let repo_weak = active_repository.downgrade();
let shas = self.commit_history_shas.clone();
let item_count = shas.len();
let commit_history_scroll_handle = self.commit_history_scroll_handle.clone();
let remote = self.git_remote(cx);
let focused_history_entry = self.focused_history_entry;
let is_panel_focused = self.focus_handle.is_focused(window);
let show_focus_border = self.history_keyboard_nav;
let ahead_count = active_repository
.read(cx)
.branch
.as_ref()
.and_then(|b| b.upstream.as_ref())
.and_then(|u| u.tracking.status())
.map(|s| s.ahead as usize)
.unwrap_or(0);
Some(
v_flex()
.flex_1()
.size_full()
.overflow_hidden()
.child(
uniform_list("commit_history_list", item_count, {
let workspace = workspace;
let repo_weak = repo_weak;
let git_panel = cx.weak_entity();
move |range, window, cx| {
let local_offset = time::UtcOffset::current_local_offset()
.unwrap_or(time::UtcOffset::UTC);
let now = time::OffsetDateTime::now_utc();
let visible_data: Vec<Option<Arc<CommitData>>> = repo_weak
.update(cx, |repository, cx| {
shas[range.clone()]
.iter()
.map(|sha| {
match repository.fetch_commit_data(*sha, false, cx) {
CommitDataState::Loaded(data) => Some(data.clone()),
CommitDataState::Loading(_) => None,
}
})
.collect()
})
.unwrap_or_default();
shas[range.clone()]
.iter()
.zip(visible_data)
.enumerate()
.map(|(ix, (sha, data))| {
let index = range.start + ix;
let sha_string = sha.to_string();
let sha_shared: SharedString = sha_string.clone().into();
let short_sha: SharedString =
sha_string[..7.min(sha_string.len())].to_string().into();
let (subject, author_name, author_email, timestamp): (
SharedString,
SharedString,
Option<SharedString>,
Option<i64>,
) = match &data {
Some(data) => (
data.subject.clone(),
data.author_name.clone(),
Some(data.author_email.clone()),
Some(data.commit_timestamp),
),
None => ("Loading…".into(), "".into(), None, None),
};
let relative_time: SharedString = timestamp
.and_then(|ts| {
time::OffsetDateTime::from_unix_timestamp(ts).ok()
})
.map(|dt| {
time_format::format_localized_timestamp(
dt,
now,
local_offset,
time_format::TimestampFormat::Relative,
)
.into()
})
.unwrap_or_else(|| "".into());
let avatar = CommitAvatar::new(
&sha_shared,
author_email,
remote.as_ref(),
)
.size(px(14.))
.render(window, cx);
let is_unpushed = index < ahead_count;
let is_focused = focused_history_entry == Some(index);
let workspace = workspace.clone();
let repo = repo_weak.clone();
let sha_for_click = sha_string;
let dot_separator = || {
Label::new("")
.size(LabelSize::Small)
.color(Color::Muted)
.alpha(0.5)
};
v_flex()
.id(("commit-history-item", index))
.cursor_pointer()
.w_full()
.py_1()
.px_2()
.gap_0p5()
.border_1()
.border_color(gpui::transparent_black())
.when(
is_focused && is_panel_focused && show_focus_border,
|this| {
this.border_color(
cx.theme().colors().panel_focused_border,
)
},
)
.hover(|s| s.bg(cx.theme().colors().element_hover))
.child(
h_flex()
.gap_1()
.w_full()
.child(Label::new(subject).truncate())
.when(is_unpushed, |this| {
this.child(
Icon::new(IconName::ArrowUp)
.size(IconSize::XSmall),
)
}),
)
.child(
h_flex()
.gap_1p5()
.child(avatar)
.when(!author_name.is_empty(), |this| {
this.child(
Label::new(author_name)
.size(LabelSize::Small)
.color(Color::Muted),
)
.child(dot_separator())
})
.when(!relative_time.is_empty(), |this| {
this.child(
Label::new(relative_time)
.size(LabelSize::Small)
.color(Color::Muted),
)
.child(dot_separator())
})
.child(
Label::new(short_sha.clone())
.size(LabelSize::Small)
.color(Color::Muted),
),
)
.tooltip(move |_, cx| {
Tooltip::with_meta(
"View Commit",
None,
short_sha.clone(),
cx,
)
})
.on_mouse_down(gpui::MouseButton::Left, {
let git_panel = git_panel.clone();
move |_, _, cx| {
git_panel
.update(cx, |panel, cx| {
panel.focused_history_entry = Some(index);
panel.history_keyboard_nav = false;
cx.notify();
})
.ok();
}
})
.on_click(move |_, window, cx| {
CommitView::open(
sha_for_click.clone(),
repo.clone(),
workspace.clone(),
None,
None,
window,
cx,
);
})
.into_any_element()
})
.collect()
}
})
.size_full()
.track_scroll(&commit_history_scroll_handle),
)
.vertical_scrollbar_for(&commit_history_scroll_handle, window, cx),
)
}
fn render_empty_state(&self, cx: &mut Context<Self>) -> impl IntoElement {
let content = match (self.git_access, &self.active_repository) {
(GitAccess::No, Some(repository)) => self.render_unsafe_repo_ui(repository, cx),
(_, None) => self.render_uninitialized_ui(cx),
(_, Some(_)) => self.render_no_changes_ui(cx),
};
v_flex()
.gap_1p5()
.flex_1()
.items_center()
.justify_center()
.child(content)
}
fn render_no_changes_ui(&self, cx: &Context<Self>) -> AnyElement {
let show_branch_diff = self.changes_count == 0 && !self.is_on_main_branch(cx);
v_flex()
.gap_1()
.items_center()
.child(Label::new("No changes to commit").color(Color::Muted))
.when(show_branch_diff, |this| {
this.child(
Button::new("view_branch_diff", "View Branch Diff")
.label_size(LabelSize::Small)
.style(ButtonStyle::Outlined)
.on_click(move |_, _, cx| {
cx.defer(move |cx| {
cx.dispatch_action(&BranchDiff);
})
}),
)
})
.into_any_element()
}
fn render_unsafe_repo_ui(
&self,
active_repository: &Entity<Repository>,
cx: &mut Context<Self>,
) -> AnyElement {
let directory = active_repository.update(cx, |repository, _cx| {
repository.snapshot().work_directory_abs_path
});
let message = format!(
"Detected dubious ownership in repository at {}. \
This happens when the .git/ directory is not owned by the current user. \
If you want to learn more about safe directories, visit git's documentation.",
directory.display()
);
v_flex()
.px_4()
.gap_1()
.child(Label::new(message).color(Color::Muted))
.child(
h_flex()
.flex_wrap()
.gap_1()
.child(
Button::new("trust_directory", "Trust Directory")
.label_size(LabelSize::Small)
.layer(ElevationIndex::ModalSurface)
.style(ButtonStyle::Filled)
.tooltip(Tooltip::text(
format!("git config --global --add safe.directory {}", directory.display())
))
.on_click(
cx.listener(|this, _, window, cx| {
this.add_safe_directory(window, cx);
})
)
)
.child(
Button::new("learn_more", "Learn More")
.label_size(LabelSize::Small)
.style(ButtonStyle::Outlined)
.end_icon(Icon::new(IconName::ArrowUpRight).size(IconSize::Small).color(Color::Muted))
.on_click(move |_, _, cx| cx.open_url("https://git-scm.com/docs/git-config#Documentation/git-config.txt-safedirectory"))
)
)
.into_any_element()
}
fn render_uninitialized_ui(&self, cx: &mut Context<Self>) -> AnyElement {
let worktree_count = self.project.read(cx).visible_worktrees(cx).count();
if worktree_count > 0 && self.active_repository.is_none() {
v_flex()
.gap_1()
.items_center()
.child(Label::new("No Git Repositories").color(Color::Muted))
.child(
Button::new("initialize_repository", "Initialize Repository")
.label_size(LabelSize::Small)
.style(ButtonStyle::Outlined)
.tooltip(Tooltip::for_action_title_in(
"git init",
&git::Init,
&self.focus_handle,
))
.on_click(move |_, _, cx| {
cx.defer(move |cx| {
cx.dispatch_action(&git::Init);
})
}),
)
.into_any_element()
} else if worktree_count == 0 {
let focus_handle = self.focus_handle.clone();
ProjectEmptyState::new(
"Git Panel",
focus_handle.clone(),
KeyBinding::for_action_in(&workspace::Open::default(), &focus_handle, cx),
)
.on_open_project(|_, window, cx| {
telemetry::event!("Git Panel Add Project Clicked");
window.dispatch_action(workspace::Open::default().boxed_clone(), cx);
})
.on_clone_repo(|_, window, cx| {
telemetry::event!("Git Panel Clone Repo Clicked");
window.dispatch_action(git::Clone.boxed_clone(), cx);
})
.into_any_element()
} else {
Empty.into_any_element()
}
}
fn is_on_main_branch(&self, cx: &Context<Self>) -> bool {
let Some(repo) = self.active_repository.as_ref() else {
return false;
};
let Some(branch) = repo.read(cx).branch.as_ref() else {
return false;
};
let branch_name = branch.name();
matches!(branch_name, "main" | "master")
}
fn render_buffer_header_controls(
&self,
entity: &Entity<Self>,
file: &Arc<dyn File>,
_: &Window,
cx: &App,
) -> Option<AnyElement> {
let repo = self.active_repository.as_ref()?.read(cx);
let project_path = (file.worktree_id(cx), file.path().clone()).into();
let repo_path = repo.project_path_to_repo_path(&project_path, cx)?;
let ix = self.entry_by_path(&repo_path)?;
let entry = self.entries.get(ix)?;
let is_staging_or_staged = repo
.pending_ops_for_path(&repo_path)
.map(|ops| !ops.last_op_errored() && (ops.staging() || ops.staged()))
.or_else(|| {
repo.status_for_path(&repo_path)
.and_then(|status| status.status.staging().as_bool())
})
.or_else(|| {
entry
.status_entry()
.and_then(|entry| entry.staging.as_bool())
});
let checkbox = Checkbox::new("stage-file", is_staging_or_staged.into())
.disabled(!self.has_write_access(cx))
.fill()
.elevation(ElevationIndex::Surface)
.on_click({
let entry = entry.clone();
let git_panel = entity.downgrade();
move |_, window, cx| {
git_panel
.update(cx, |this, cx| {
this.toggle_staged_for_entry(&entry, window, cx);
cx.stop_propagation();
})
.ok();
}
});
Some(
h_flex()
.id("start-slot")
.text_lg()
.child(checkbox)
.on_mouse_down(MouseButton::Left, |_, _, cx| {
// prevent the list item active state triggering when toggling checkbox
cx.stop_propagation();
})
.into_any_element(),
)
}
fn render_entries(
&self,
has_write_access: bool,
repo: Entity<Repository>,
window: &mut Window,
cx: &mut Context<Self>,
) -> impl IntoElement {
let (is_tree_view, entry_count) = match &self.view_mode {
GitPanelViewMode::Tree(state) => (true, state.logical_indices.len()),
GitPanelViewMode::Flat => (false, self.entries.len()),
};
let repo = repo.downgrade();
v_flex()
.flex_1()
.size_full()
.overflow_hidden()
.relative()
.child(
h_flex()
.flex_1()
.size_full()
.relative()
.overflow_hidden()
.child(
uniform_list(
"entries",
entry_count,
cx.processor(move |this, range: Range<usize>, window, cx| {
let Some(repo) = repo.upgrade() else {
return Vec::new();
};
let repo = repo.read(cx);
let mut items = Vec::with_capacity(range.end - range.start);
for ix in range.into_iter().map(|ix| match &this.view_mode {
GitPanelViewMode::Tree(state) => state.logical_indices[ix],
GitPanelViewMode::Flat => ix,
}) {
match &this.entries.get(ix) {
Some(GitListEntry::Status(entry)) => {
items.push(this.render_status_entry(
ix,
entry,
0,
has_write_access,
repo,
window,
cx,
));
}
Some(GitListEntry::TreeStatus(entry)) => {
items.push(this.render_status_entry(
ix,
&entry.entry,
entry.depth,
has_write_access,
repo,
window,
cx,
));
}
Some(GitListEntry::Directory(entry)) => {
items.push(this.render_directory_entry(
ix,
entry,
has_write_access,
window,
cx,
));
}
Some(GitListEntry::Header(header)) => {
items.push(this.render_list_header(
ix,
header,
has_write_access,
window,
cx,
));
}
None => {}
}
}
items
}),
)
.when(is_tree_view, |list| {
let indent_size = px(TREE_INDENT);
list.with_decoration(
ui::indent_guides(indent_size, IndentGuideColors::panel(cx))
.with_compute_indents_fn(
cx.entity(),
|this, range, _window, _cx| {
this.compute_visible_depths(range)
},
)
.with_render_fn(cx.entity(), |_, params, _, _| {
// Magic number to align the tree item is 3 here
// because we're using 12px as the left-side padding
// and 3 makes the alignment work with the bounding box of the icon
let left_offset = px(TREE_INDENT + 3_f32);
let indent_size = params.indent_size;
let item_height = params.item_height;
params
.indent_guides
.into_iter()
.map(|layout| {
let bounds = Bounds::new(
point(
layout.offset.x * indent_size + left_offset,
layout.offset.y * item_height,
),
size(px(1.), layout.length * item_height),
);
RenderedIndentGuide {
bounds,
layout,
is_active: false,
hitbox: None,
}
})
.collect()
}),
)
})
.group("entries")
.size_full()
.flex_grow()
.with_width_from_item(self.max_width_item_index)
.track_scroll(&self.scroll_handle),
)
.on_mouse_down(
MouseButton::Right,
cx.listener(move |this, event: &MouseDownEvent, window, cx| {
this.deploy_panel_context_menu(event.position, window, cx)
}),
)
.custom_scrollbars(
Scrollbars::for_settings::<GitPanelScrollbarAccessor>()
.tracked_scroll_handle(&self.scroll_handle)
.with_track_along(
ScrollAxes::Horizontal,
cx.theme().colors().panel_background,
),
window,
cx,
),
)
}
fn entry_label(&self, label: impl Into<SharedString>, color: Color) -> Label {
Label::new(label.into()).color(color)
}
fn list_item_height(&self) -> Rems {
rems(1.75)
}
fn render_list_header(
&self,
ix: usize,
header: &GitHeaderEntry,
has_write_access: bool,
_window: &Window,
cx: &Context<Self>,
) -> AnyElement {
let id: ElementId = ElementId::Name(format!("header_{}", ix).into());
let checkbox_id: ElementId = ElementId::Name(format!("header_{}_checkbox", ix).into());
let group_name: SharedString = format!("header_{}", ix).into();
let toggle_state = self.header_state(header.header);
let section = header.header;
let weak = cx.weak_entity();
h_flex()
.id(id)
.cursor_pointer()
.group(group_name)
.h(self.list_item_height())
.w_full()
.pl_3()
.pr_1()
.gap_2()
.justify_between()
.hover(|s| s.bg(cx.theme().colors().ghost_element_hover))
.border_1()
.border_r_2()
.child(
Label::new(header.title())
.color(Color::Muted)
.size(LabelSize::Small),
)
.child(
Checkbox::new(checkbox_id, toggle_state)
.disabled(!has_write_access)
.fill()
.elevation(ElevationIndex::Surface),
)
.on_click(move |_, window, cx| {
if !has_write_access {
return;
}
weak.update(cx, |this, cx| {
this.toggle_staged_for_entry(
&GitListEntry::Header(GitHeaderEntry { header: section }),
window,
cx,
);
cx.stop_propagation();
})
.ok();
})
.into_any_element()
}
pub fn load_commit_details(
&self,
sha: String,
cx: &mut Context<Self>,
) -> Task<anyhow::Result<CommitDetails>> {
let Some(repo) = self.active_repository.clone() else {
return Task::ready(Err(anyhow::anyhow!("no active repo")));
};
repo.update(cx, |repo, cx| {
let show = repo.show(sha);
cx.spawn(async move |_, _| show.await?)
})
}
fn deploy_entry_context_menu(
&mut self,
position: Point<Pixels>,
ix: usize,
window: &mut Window,
cx: &mut Context<Self>,
) {
let Some(entry) = self.entries.get(ix).and_then(|e| e.status_entry()) else {
return;
};
let stage_title = if entry.status.staging().is_fully_staged() {
"Unstage File"
} else {
"Stage File"
};
let restore_title = if entry.status.is_created() {
"Trash File"
} else {
"Discard Changes"
};
let context_menu = ContextMenu::build(window, cx, |context_menu, _, _| {
let is_created = entry.status.is_created();
context_menu
.context(self.focus_handle.clone())
.action(stage_title, ToggleStaged.boxed_clone())
.action(restore_title, git::RestoreFile::default().boxed_clone())
.action_disabled_when(
!is_created,
"Add to .gitignore",
git::AddToGitignore.boxed_clone(),
)
.separator()
.action("Open Diff", menu::Confirm.boxed_clone())
.action("Open Diff (File)", menu::SecondaryConfirm.boxed_clone())
.when(!is_created, |context_menu| {
context_menu
.separator()
.action("View File History", Box::new(git::FileHistory))
})
});
self.selected_entry = Some(ix);
self.set_context_menu(context_menu, position, window, cx);
}
fn deploy_panel_context_menu(
&mut self,
position: Point<Pixels>,
window: &mut Window,
cx: &mut Context<Self>,
) {
let context_menu = git_panel_context_menu(
self.focus_handle.clone(),
GitMenuState {
has_tracked_changes: self.has_tracked_changes(),
has_staged_changes: self.has_staged_changes(),
has_unstaged_changes: self.has_unstaged_changes(),
has_new_changes: self.new_count > 0,
sort_by_path: GitPanelSettings::get_global(cx).sort_by_path,
has_stash_items: self.stash_entries.entries.len() > 0,
tree_view: GitPanelSettings::get_global(cx).tree_view,
},
window,
cx,
);
self.set_context_menu(context_menu, position, window, cx);
}
fn set_context_menu(
&mut self,
context_menu: Entity<ContextMenu>,
position: Point<Pixels>,
window: &Window,
cx: &mut Context<Self>,
) {
let subscription = cx.subscribe_in(
&context_menu,
window,
|this, _, _: &DismissEvent, window, cx| {
if this.context_menu.as_ref().is_some_and(|context_menu| {
context_menu.0.focus_handle(cx).contains_focused(window, cx)
}) {
cx.focus_self(window);
}
this.context_menu.take();
cx.notify();
},
);
self.context_menu = Some((context_menu, position, subscription));
cx.notify();
}
fn render_status_entry(
&self,
ix: usize,
entry: &GitStatusEntry,
depth: usize,
has_write_access: bool,
repo: &Repository,
window: &Window,
cx: &Context<Self>,
) -> AnyElement {
let settings = GitPanelSettings::get_global(cx);
let tree_view = settings.tree_view;
let path_style = self.project.read(cx).path_style(cx);
let git_path_style = ProjectSettings::get_global(cx).git.path_style;
let display_name = entry.display_name(path_style);
let selected = self.selected_entry == Some(ix);
let marked = self.marked_entries.contains(&ix);
let status_style = settings.status_style;
let status = entry.status;
let file_icon = if settings.file_icons {
FileIcons::get_icon(entry.repo_path.as_std_path(), cx)
} else {
None
};
let has_conflict = status.is_conflicted();
let is_modified = status.is_modified();
let is_deleted = status.is_deleted();
let is_created = status.is_created();
let label_color = if status_style == StatusStyle::LabelColor {
if has_conflict {
Color::VersionControlConflict
} else if is_created {
Color::VersionControlAdded
} else if is_modified {
Color::VersionControlModified
} else if is_deleted {
// We don't want a bunch of red labels in the list
Color::Disabled
} else {
Color::VersionControlAdded
}
} else {
Color::Default
};
let path_color = if status.is_deleted() {
Color::Disabled
} else {
Color::Muted
};
let id: ElementId = ElementId::Name(format!("entry_{}_{}", display_name, ix).into());
let checkbox_wrapper_id: ElementId =
ElementId::Name(format!("entry_{}_{}_checkbox_wrapper", display_name, ix).into());
let checkbox_id: ElementId =
ElementId::Name(format!("entry_{}_{}_checkbox", display_name, ix).into());
let stage_status = GitPanel::stage_status_for_entry(entry, &repo);
let mut is_staged: ToggleState = match stage_status {
StageStatus::Staged => ToggleState::Selected,
StageStatus::Unstaged => ToggleState::Unselected,
StageStatus::PartiallyStaged => ToggleState::Indeterminate,
};
if self.show_placeholders && !self.has_staged_changes() && !entry.status.is_created() {
is_staged = ToggleState::Selected;
}
let handle = cx.weak_entity();
let selected_bg_alpha = 0.08;
let marked_bg_alpha = 0.12;
let state_opacity_step = 0.04;
let info_color = cx.theme().status().info;
let base_bg = match (selected, marked) {
(true, true) => info_color.alpha(selected_bg_alpha + marked_bg_alpha),
(true, false) => info_color.alpha(selected_bg_alpha),
(false, true) => info_color.alpha(marked_bg_alpha),
_ => cx.theme().colors().ghost_element_background,
};
let (hover_bg, active_bg) = if selected {
(
info_color.alpha(selected_bg_alpha + state_opacity_step),
info_color.alpha(selected_bg_alpha + state_opacity_step * 2.0),
)
} else {
(
cx.theme().colors().ghost_element_hover,
cx.theme().colors().ghost_element_active,
)
};
let name_row = h_flex()
.min_w_0()
.flex_1()
.gap_1()
.when(settings.file_icons, |this| {
this.child(
file_icon
.map(|file_icon| {
Icon::from_path(file_icon)
.size(IconSize::Small)
.color(Color::Muted)
})
.unwrap_or_else(|| {
Icon::new(IconName::File)
.size(IconSize::Small)
.color(Color::Muted)
}),
)
})
.when(status_style != StatusStyle::LabelColor, |el| {
el.child(git_status_icon(status))
})
.map(|this| {
if tree_view {
this.pl(px(depth as f32 * TREE_INDENT)).child(
self.entry_label(display_name, label_color)
.when(status.is_deleted(), Label::strikethrough)
.truncate(),
)
} else {
this.child(self.path_formatted(
entry.parent_dir(path_style),
path_color,
display_name,
label_color,
path_style,
git_path_style,
status.is_deleted(),
))
}
});
let id_for_diff_stat = id.clone();
h_flex()
.id(id)
.h(self.list_item_height())
.w_full()
.pl_3()
.pr_1()
.gap_1p5()
.border_1()
.border_r_2()
.when(selected && self.focus_handle.is_focused(window), |el| {
el.border_color(cx.theme().colors().panel_focused_border)
})
.bg(base_bg)
.hover(|s| s.bg(hover_bg))
.active(|s| s.bg(active_bg))
.child(name_row)
.when(GitPanelSettings::get_global(cx).diff_stats, |el| {
el.when_some(entry.diff_stat, move |this, stat| {
let id = format!("diff-stat-{}", id_for_diff_stat);
this.child(ui::DiffStat::new(
id,
stat.added as usize,
stat.deleted as usize,
))
})
})
.child(
div()
.id(checkbox_wrapper_id)
.flex_none()
.occlude()
.cursor_pointer()
.child(
Checkbox::new(checkbox_id, is_staged)
.disabled(!has_write_access)
.fill()
.elevation(ElevationIndex::Surface)
.on_click_ext({
let entry = entry.clone();
let this = cx.weak_entity();
move |_, click, window, cx| {
this.update(cx, |this, cx| {
if !has_write_access {
return;
}
if click.modifiers().shift {
this.stage_bulk(ix, cx);
} else {
let list_entry =
if GitPanelSettings::get_global(cx).tree_view {
GitListEntry::TreeStatus(GitTreeStatusEntry {
entry: entry.clone(),
depth,
})
} else {
GitListEntry::Status(entry.clone())
};
this.toggle_staged_for_entry(&list_entry, window, cx);
}
cx.stop_propagation();
})
.ok();
}
})
.tooltip(move |_window, cx| {
let action = match stage_status {
StageStatus::Staged => "Unstage",
StageStatus::Unstaged | StageStatus::PartiallyStaged => "Stage",
};
let tooltip_name = action.to_string();
Tooltip::for_action(tooltip_name, &ToggleStaged, cx)
}),
),
)
.on_click({
cx.listener(move |this, event: &ClickEvent, window, cx| {
this.selected_entry = Some(ix);
cx.notify();
if event.click_count() > 1 || event.modifiers().secondary() {
this.open_solo_diff(&Default::default(), window, cx)
} else {
this.open_diff(&Default::default(), window, cx);
this.focus_handle.focus(window, cx);
}
})
})
.on_mouse_down(
MouseButton::Right,
move |event: &MouseDownEvent, window, cx| {
// why isn't this happening automatically? we are passing MouseButton::Right to `on_mouse_down`?
if event.button != MouseButton::Right {
return;
}
let Some(this) = handle.upgrade() else {
return;
};
this.update(cx, |this, cx| {
this.deploy_entry_context_menu(event.position, ix, window, cx);
});
cx.stop_propagation();
},
)
.into_any_element()
}
fn render_directory_entry(
&self,
ix: usize,
entry: &GitTreeDirEntry,
has_write_access: bool,
window: &Window,
cx: &Context<Self>,
) -> AnyElement {
// TODO: Have not yet plugin the self.marked_entries. Not sure when and why we need that
let selected = self.selected_entry == Some(ix);
let label_color = Color::Muted;
let id: ElementId = ElementId::Name(format!("dir_{}_{}", entry.name, ix).into());
let checkbox_id: ElementId =
ElementId::Name(format!("dir_checkbox_{}_{}", entry.name, ix).into());
let checkbox_wrapper_id: ElementId =
ElementId::Name(format!("dir_checkbox_wrapper_{}_{}", entry.name, ix).into());
let selected_bg_alpha = 0.08;
let state_opacity_step = 0.04;
let info_color = cx.theme().status().info;
let colors = cx.theme().colors();
let (base_bg, hover_bg, active_bg) = if selected {
(
info_color.alpha(selected_bg_alpha),
info_color.alpha(selected_bg_alpha + state_opacity_step),
info_color.alpha(selected_bg_alpha + state_opacity_step * 2.0),
)
} else {
(
colors.ghost_element_background,
colors.ghost_element_hover,
colors.ghost_element_active,
)
};
let settings = GitPanelSettings::get_global(cx);
let folder_icon = if settings.folder_icons {
FileIcons::get_folder_icon(entry.expanded, entry.key.path.as_std_path(), cx)
} else {
FileIcons::get_chevron_icon(entry.expanded, cx)
};
let fallback_folder_icon = if settings.folder_icons {
if entry.expanded {
IconName::FolderOpen
} else {
IconName::Folder
}
} else {
if entry.expanded {
IconName::ChevronDown
} else {
IconName::ChevronRight
}
};
let stage_status = if let Some(repo) = &self.active_repository {
self.stage_status_for_directory(entry, repo.read(cx))
} else {
util::debug_panic!(
"Won't have entries to render without an active repository in Git Panel"
);
StageStatus::PartiallyStaged
};
let toggle_state: ToggleState = match stage_status {
StageStatus::Staged => ToggleState::Selected,
StageStatus::Unstaged => ToggleState::Unselected,
StageStatus::PartiallyStaged => ToggleState::Indeterminate,
};
let name_row = h_flex()
.min_w_0()
.gap_1()
.pl(px(entry.depth as f32 * TREE_INDENT))
.child(
folder_icon
.map(|folder_icon| {
Icon::from_path(folder_icon)
.size(IconSize::Small)
.color(Color::Muted)
})
.unwrap_or_else(|| {
Icon::new(fallback_folder_icon)
.size(IconSize::Small)
.color(Color::Muted)
}),
)
.child(self.entry_label(entry.name.clone(), label_color).truncate());
h_flex()
.id(id)
.h(self.list_item_height())
.min_w_0()
.w_full()
.pl_3()
.pr_1()
.gap_1p5()
.justify_between()
.border_1()
.border_r_2()
.when(selected && self.focus_handle.is_focused(window), |el| {
el.border_color(cx.theme().colors().panel_focused_border)
})
.bg(base_bg)
.hover(|s| s.bg(hover_bg))
.active(|s| s.bg(active_bg))
.child(name_row)
.child(
div()
.id(checkbox_wrapper_id)
.flex_none()
.occlude()
.cursor_pointer()
.child(
Checkbox::new(checkbox_id, toggle_state)
.disabled(!has_write_access)
.fill()
.elevation(ElevationIndex::Surface)
.on_click({
let entry = entry.clone();
let this = cx.weak_entity();
move |_, window, cx| {
this.update(cx, |this, cx| {
if !has_write_access {
return;
}
this.toggle_staged_for_entry(
&GitListEntry::Directory(entry.clone()),
window,
cx,
);
cx.stop_propagation();
})
.ok();
}
})
.tooltip(move |_window, cx| {
let action = match stage_status {
StageStatus::Staged => "Unstage",
StageStatus::Unstaged | StageStatus::PartiallyStaged => "Stage",
};
Tooltip::simple(format!("{action} folder"), cx)
}),
),
)
.on_click({
let key = entry.key.clone();
cx.listener(move |this, _event: &ClickEvent, window, cx| {
this.selected_entry = Some(ix);
this.toggle_directory(&key, window, cx);
})
})
.into_any_element()
}
fn path_formatted(
&self,
directory: Option<String>,
path_color: Color,
file_name: String,
label_color: Color,
path_style: PathStyle,
git_path_style: GitPathStyle,
strikethrough: bool,
) -> Div {
let file_name_first = git_path_style == GitPathStyle::FileNameFirst;
let file_path_first = git_path_style == GitPathStyle::FilePathFirst;
let file_name = format!("{} ", file_name);
h_flex()
.min_w_0()
.overflow_hidden()
.when(file_path_first, |this| this.flex_row_reverse())
.child(
div().flex_none().child(
self.entry_label(file_name, label_color)
.when(strikethrough, Label::strikethrough),
),
)
.when_some(directory, |this, dir| {
let path_name = if file_name_first {
dir
} else {
format!("{dir}{}", path_style.primary_separator())
};
this.child(
self.entry_label(path_name, path_color)
.truncate_start()
.when(strikethrough, Label::strikethrough),
)
})
}
fn has_write_access(&self, cx: &App) -> bool {
!self.project.read(cx).is_read_only(cx)
}
pub fn load_commit_template(
&self,
cx: &mut Context<Self>,
) -> Task<anyhow::Result<Option<GitCommitTemplate>>> {
let Some(repo) = self.active_repository.clone() else {
return Task::ready(Err(anyhow::anyhow!("no active repo")));
};
repo.update(cx, |repo, cx| {
let rx = repo.load_commit_template_text();
cx.spawn(async move |_, _| rx.await?)
})
}
pub fn amend_pending(&self) -> bool {
self.amend_pending
}
/// Sets the pending amend state, ensuring that the original commit message
/// is either saved, when `value` is `true` and there's no pending amend, or
/// restored, when `value` is `false` and there's a pending amend.
pub fn set_amend_pending(&mut self, value: bool, cx: &mut Context<Self>) {
if value && !self.amend_pending {
let current_message = self.commit_message_buffer(cx).read(cx).text();
self.original_commit_message = if current_message.trim().is_empty() {
None
} else {
Some(current_message)
};
} else if !value && self.amend_pending {
let message = self.original_commit_message.take().unwrap_or_default();
self.commit_message_buffer(cx).update(cx, |buffer, cx| {
let start = buffer.anchor_before(0);
let end = buffer.anchor_after(buffer.len());
buffer.edit([(start..end, message)], None, cx);
});
}
self.amend_pending = value;
self.serialize(cx);
cx.notify();
}
pub fn signoff_enabled(&self) -> bool {
self.signoff_enabled
}
pub fn set_signoff_enabled(&mut self, value: bool, cx: &mut Context<Self>) {
self.signoff_enabled = value;
self.serialize(cx);
cx.notify();
}
pub fn toggle_signoff_enabled(
&mut self,
_: &Signoff,
_window: &mut Window,
cx: &mut Context<Self>,
) {
self.set_signoff_enabled(!self.signoff_enabled, cx);
}
pub async fn load(
workspace: WeakEntity<Workspace>,
mut cx: AsyncWindowContext,
) -> anyhow::Result<Entity<Self>> {
let serialized_panel = match workspace
.read_with(&cx, |workspace, cx| {
Self::serialization_key(workspace).map(|key| (key, KeyValueStore::global(cx)))
})
.ok()
.flatten()
{
Some((serialization_key, kvp)) => cx
.background_spawn(async move { kvp.read_kvp(&serialization_key) })
.await
.context("loading git panel")
.log_err()
.flatten()
.map(|panel| serde_json::from_str::<SerializedGitPanel>(&panel))
.transpose()
.log_err()
.flatten(),
None => None,
};
workspace.update_in(&mut cx, |workspace, window, cx| {
let panel = GitPanel::new(workspace, window, cx);
if let Some(serialized_panel) = serialized_panel {
panel.update(cx, |panel, cx| {
panel.amend_pending = serialized_panel.amend_pending;
panel.signoff_enabled = serialized_panel.signoff_enabled;
cx.notify();
})
}
panel
})
}
fn stage_bulk(&mut self, mut index: usize, cx: &mut Context<'_, Self>) {
let Some(op) = self.bulk_staging.as_ref() else {
return;
};
let Some(mut anchor_index) = self.entry_by_path(&op.anchor) else {
return;
};
if let Some(entry) = self.entries.get(index)
&& let Some(entry) = entry.status_entry()
{
self.set_bulk_staging_anchor(entry.repo_path.clone(), cx);
}
if index < anchor_index {
std::mem::swap(&mut index, &mut anchor_index);
}
let entries = self
.entries
.get(anchor_index..=index)
.unwrap_or_default()
.iter()
.filter_map(|entry| entry.status_entry().cloned())
.collect::<Vec<_>>();
self.change_file_stage(true, entries, cx);
}
fn set_bulk_staging_anchor(&mut self, path: RepoPath, cx: &mut Context<'_, GitPanel>) {
let Some(repo) = self.active_repository.as_ref() else {
return;
};
self.bulk_staging = Some(BulkStaging {
repo_id: repo.read(cx).id,
anchor: path,
});
}
pub(crate) fn toggle_amend_pending(&mut self, cx: &mut Context<Self>) {
self.set_amend_pending(!self.amend_pending, cx);
if self.amend_pending {
self.load_last_commit_message(cx);
}
}
}
impl GitPanel {
pub fn selected_file_history_target(&self) -> Option<(Entity<Repository>, RepoPath)> {
let entry = self.get_selected_entry()?.status_entry()?;
let repository = self.active_repository.clone()?;
if entry.status.is_created() {
return None;
}
Some((repository, entry.repo_path.clone()))
}
}
#[cfg(any(test, feature = "test-support"))]
impl GitPanel {
pub fn new_test(
workspace: &mut Workspace,
window: &mut Window,
cx: &mut Context<Workspace>,
) -> Entity<Self> {
Self::new(workspace, window, cx)
}
pub fn active_repository(&self) -> Option<&Entity<Repository>> {
self.active_repository.as_ref()
}
}
impl Render for GitPanel {
fn render(&mut self, window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
let project = self.project.read(cx);
let has_entries = !self.entries.is_empty();
let room = self.workspace.upgrade().and_then(|_workspace| {
call::ActiveCall::try_global(cx).and_then(|call| call.read(cx).room().cloned())
});
let has_write_access = self.has_write_access(cx);
let has_co_authors = room.is_some_and(|room| {
self.load_local_committer(cx);
let room = room.read(cx);
room.remote_participants()
.values()
.any(|remote_participant| remote_participant.can_write())
});
v_flex()
.id("git_panel")
.key_context(self.dispatch_context(window, cx))
.track_focus(&self.focus_handle)
.when(has_write_access && !project.is_read_only(cx), |this| {
this.on_action(cx.listener(Self::toggle_staged_for_selected))
.on_action(cx.listener(Self::stage_range))
.on_action(cx.listener(GitPanel::on_commit))
.on_action(cx.listener(GitPanel::on_amend))
.on_action(cx.listener(GitPanel::toggle_signoff_enabled))
.on_action(cx.listener(Self::stage_all))
.on_action(cx.listener(Self::unstage_all))
.on_action(cx.listener(Self::stage_selected))
.on_action(cx.listener(Self::unstage_selected))
.on_action(cx.listener(Self::restore_tracked_files))
.on_action(cx.listener(Self::revert_selected))
.on_action(cx.listener(Self::add_to_gitignore))
.on_action(cx.listener(Self::clean_all))
.on_action(cx.listener(Self::generate_commit_message_action))
.on_action(cx.listener(Self::stash_all))
.on_action(cx.listener(Self::stash_pop))
})
.on_action(cx.listener(Self::collapse_selected_entry))
.on_action(cx.listener(Self::expand_selected_entry))
.on_action(cx.listener(Self::select_first))
.on_action(cx.listener(Self::select_next))
.on_action(cx.listener(Self::select_previous))
.on_action(cx.listener(Self::select_last))
.on_action(cx.listener(Self::first_entry))
.on_action(cx.listener(Self::next_entry))
.on_action(cx.listener(Self::previous_entry))
.on_action(cx.listener(Self::last_entry))
.on_action(cx.listener(Self::close_panel))
.on_action(cx.listener(Self::open_diff))
.on_action(cx.listener(Self::open_solo_diff))
.on_action(cx.listener(Self::focus_changes_list))
.on_action(cx.listener(Self::focus_editor))
.on_action(cx.listener(Self::expand_commit_editor))
.when(has_write_access && has_co_authors, |git_panel| {
git_panel.on_action(cx.listener(Self::toggle_fill_co_authors))
})
.on_action(cx.listener(Self::toggle_sort_by_path))
.on_action(cx.listener(Self::toggle_tree_view))
.on_action(cx.listener(Self::increase_font_size))
.on_action(cx.listener(Self::decrease_font_size))
.on_action(cx.listener(Self::reset_font_size))
.on_action(cx.listener(Self::activate_changes_tab))
.on_action(cx.listener(Self::activate_history_tab))
.size_full()
.overflow_hidden()
.bg(cx.theme().colors().panel_background)
.child(
v_flex()
.size_full()
.when(!self.commit_editor_expanded, |this| {
this.child(self.render_tab_bar(cx))
})
.map(|this| match self.active_tab {
GitPanelTab::Changes => this
.children(self.render_changes_header(window, cx))
.when(!self.commit_editor_expanded, |this| {
this.map(|this| {
if let Some(repo) = self.active_repository.clone()
&& has_entries
{
this.child(self.render_entries(
has_write_access,
repo,
window,
cx,
))
} else {
this.child(self.render_empty_state(cx).into_any_element())
}
})
})
.children(self.render_footer(window, cx))
.when(self.amend_pending, |this| {
this.child(self.render_pending_amend(cx))
})
.when(!self.amend_pending, |this| {
this.children(self.render_previous_commit(window, cx))
}),
GitPanelTab::History => this.child(self.render_history_tab(window, cx)),
})
.into_any_element(),
)
.children(self.context_menu.as_ref().map(|(menu, position, _)| {
deferred(
anchored()
.position(*position)
.anchor(Anchor::TopLeft)
.child(menu.clone()),
)
.with_priority(1)
}))
}
}
impl Focusable for GitPanel {
fn focus_handle(&self, cx: &App) -> gpui::FocusHandle {
if self.entries.is_empty() {
self.commit_editor.focus_handle(cx)
} else {
self.focus_handle.clone()
}
}
}
impl EventEmitter<Event> for GitPanel {}
impl EventEmitter<PanelEvent> for GitPanel {}
pub(crate) struct GitPanelAddon {
pub(crate) workspace: WeakEntity<Workspace>,
}
impl editor::Addon for GitPanelAddon {
fn to_any(&self) -> &dyn std::any::Any {
self
}
fn render_buffer_header_controls(
&self,
_excerpt_info: &ExcerptBoundaryInfo,
buffer: &language::BufferSnapshot,
window: &Window,
cx: &App,
) -> Option<AnyElement> {
let file = buffer.file()?;
let git_panel = self.workspace.upgrade()?.read(cx).panel::<GitPanel>(cx)?;
git_panel
.read(cx)
.render_buffer_header_controls(&git_panel, file, window, cx)
}
}
impl Panel for GitPanel {
fn persistent_name() -> &'static str {
"GitPanel"
}
fn panel_key() -> &'static str {
GIT_PANEL_KEY
}
fn position(&self, _: &Window, cx: &App) -> DockPosition {
GitPanelSettings::get_global(cx).dock
}
fn position_is_valid(&self, position: DockPosition) -> bool {
matches!(position, DockPosition::Left | DockPosition::Right)
}
fn set_position(&mut self, position: DockPosition, _: &mut Window, cx: &mut Context<Self>) {
settings::update_settings_file(self.fs.clone(), cx, move |settings, _| {
settings.git_panel.get_or_insert_default().dock = Some(position.into())
});
}
fn default_size(&self, _: &Window, cx: &App) -> Pixels {
GitPanelSettings::get_global(cx).default_width
}
fn icon(&self, _: &Window, cx: &App) -> Option<ui::IconName> {
Some(ui::IconName::GitBranch).filter(|_| GitPanelSettings::get_global(cx).button)
}
fn icon_tooltip(&self, _window: &Window, _cx: &App) -> Option<&'static str> {
Some("Git Panel")
}
fn icon_label(&self, _: &Window, cx: &App) -> Option<String> {
if !GitPanelSettings::get_global(cx).show_count_badge {
return None;
}
let total = self.changes_count;
(total > 0).then(|| total.to_string())
}
fn toggle_action(&self) -> Box<dyn Action> {
Box::new(ToggleFocus)
}
fn starts_open(&self, _: &Window, cx: &App) -> bool {
GitPanelSettings::get_global(cx).starts_open
}
fn activation_priority(&self) -> u32 {
3
}
fn hide_button_setting(&self, _: &App) -> Option<workspace::HideStatusItem> {
Some(workspace::HideStatusItem::new(|settings| {
settings.git_panel.get_or_insert_default().button = Some(false);
}))
}
}
impl PanelHeader for GitPanel {}
pub fn panel_editor_container(_window: &mut Window, cx: &mut App) -> Div {
v_flex()
.size_full()
.gap(px(8.))
.p_2()
.bg(cx.theme().colors().editor_background)
}
pub(crate) fn git_commit_editor_style(font_size: gpui::Pixels, cx: &App) -> EditorStyle {
let settings = ThemeSettings::get_global(cx);
EditorStyle {
background: cx.theme().colors().editor_background,
local_player: cx.theme().players().local(),
text: TextStyle {
color: cx.theme().colors().text,
font_family: settings.buffer_font.family.clone(),
font_fallbacks: settings.buffer_font.fallbacks.clone(),
font_features: settings.buffer_font.features.clone(),
font_size: AbsoluteLength::from(font_size),
font_weight: settings.buffer_font.weight,
line_height: (font_size * settings.buffer_line_height.value()).into(),
..Default::default()
},
syntax: cx.theme().syntax().clone(),
..Default::default()
}
}
struct GitPanelMessageTooltip {
commit_tooltip: Option<Entity<CommitTooltip>>,
}
impl GitPanelMessageTooltip {
fn new(
git_panel: Entity<GitPanel>,
sha: SharedString,
repository: Entity<Repository>,
window: &mut Window,
cx: &mut App,
) -> Entity<Self> {
let remote_url = repository.read(cx).default_remote_url();
cx.new(|cx| {
cx.spawn_in(window, async move |this, cx| {
let (details, workspace) = git_panel.update(cx, |git_panel, cx| {
(
git_panel.load_commit_details(sha.to_string(), cx),
git_panel.workspace.clone(),
)
});
let details = details.await?;
let provider_registry = cx
.update(|_, app| GitHostingProviderRegistry::default_global(app))
.ok();
let commit_details = crate::commit_tooltip::CommitDetails {
sha: details.sha.clone(),
author_name: details.author_name.clone(),
author_email: details.author_email.clone(),
commit_time: OffsetDateTime::from_unix_timestamp(details.commit_timestamp)?,
message: Some(ParsedCommitMessage::parse(
details.sha.to_string(),
details.message.to_string(),
remote_url.as_deref(),
provider_registry,
)),
};
this.update(cx, |this: &mut GitPanelMessageTooltip, cx| {
this.commit_tooltip = Some(cx.new(move |cx| {
CommitTooltip::new(commit_details, repository, workspace, cx)
}));
cx.notify();
})
})
.detach();
Self {
commit_tooltip: None,
}
})
}
}
impl Render for GitPanelMessageTooltip {
fn render(&mut self, _window: &mut Window, _cx: &mut Context<Self>) -> impl IntoElement {
if let Some(commit_tooltip) = &self.commit_tooltip {
commit_tooltip.clone().into_any_element()
} else {
gpui::Empty.into_any_element()
}
}
}
#[derive(IntoElement, RegisterComponent)]
pub struct PanelRepoFooter {
active_repository: SharedString,
branch: Option<Branch>,
head_commit: Option<CommitDetails>,
// Getting a GitPanel in previews will be difficult.
//
// For now just take an option here, and we won't bind handlers to buttons in previews.
git_panel: Option<Entity<GitPanel>>,
}
impl PanelRepoFooter {
pub fn new(
active_repository: SharedString,
branch: Option<Branch>,
head_commit: Option<CommitDetails>,
git_panel: Option<Entity<GitPanel>>,
) -> Self {
Self {
active_repository,
branch,
head_commit,
git_panel,
}
}
pub fn new_preview(active_repository: SharedString, branch: Option<Branch>) -> Self {
Self {
active_repository,
branch,
head_commit: None,
git_panel: None,
}
}
}
impl RenderOnce for PanelRepoFooter {
fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement {
let project = self
.git_panel
.as_ref()
.map(|panel| panel.read(cx).project.clone());
let (workspace, repo) = self
.git_panel
.as_ref()
.map(|panel| {
let panel = panel.read(cx);
(panel.workspace.clone(), panel.active_repository.clone())
})
.unzip();
let single_repo = project
.as_ref()
.map(|project| project.read(cx).git_store().read(cx).repositories().len() == 1)
.unwrap_or(true);
const MAX_SHORT_SHA_LEN: usize = 8;
let branch_name = self
.branch
.as_ref()
.map(|branch| branch.name().to_owned())
.or_else(|| {
self.head_commit.as_ref().map(|commit| {
commit
.sha
.chars()
.take(MAX_SHORT_SHA_LEN)
.collect::<String>()
})
})
.unwrap_or_else(|| " (no branch)".to_owned());
let show_separator = self.branch.is_some() || self.head_commit.is_some();
let active_repo_name = self.active_repository.clone();
let repo_selector = PopoverMenu::new("repository-switcher")
.menu({
let project = project;
move |window, cx| {
let project = project.clone()?;
Some(cx.new(|cx| RepositorySelector::new(project, rems(20.), window, cx)))
}
})
.trigger_with_tooltip(
Button::new("repo-selector", active_repo_name)
.size(ButtonSize::None)
.label_size(LabelSize::Small)
.truncate(true),
move |_, cx| {
if single_repo {
cx.new(|_| Empty).into()
} else {
Tooltip::simple("Switch Active Repository", cx)
}
},
)
.anchor(Anchor::BottomLeft)
.offset(gpui::Point {
x: px(0.0),
y: px(-2.0),
})
.into_any_element();
let branch_selector_button = Button::new("branch-selector", branch_name)
.size(ButtonSize::None)
.label_size(LabelSize::Small)
.truncate(true)
.on_click(|_, window, cx| {
window.dispatch_action(zed_actions::git::Switch.boxed_clone(), cx);
});
let branch_selector = PopoverMenu::new("popover-button")
.menu(move |window, cx| {
let workspace = workspace.clone()?;
let repo = repo.clone().flatten();
Some(branch_picker::popover(workspace, false, repo, window, cx))
})
.trigger_with_tooltip(
branch_selector_button,
Tooltip::for_action_title("Switch Branch", &zed_actions::git::Switch),
)
.anchor(Anchor::BottomLeft)
.offset(gpui::Point {
x: px(0.0),
y: px(-2.0),
});
h_flex()
.h_9()
.w_full()
.px_2()
.justify_between()
.gap_1()
.child(
h_flex()
.flex_1()
.overflow_hidden()
.gap_px()
.child(Icon::new(IconName::GitBranch).size(IconSize::Small).color(
if single_repo {
Color::Disabled
} else {
Color::Muted
},
))
.when(!single_repo, |this| {
this.child(div().child(repo_selector).min_w_0()).when(
show_separator,
|this| {
this.child(Label::new("/").size(LabelSize::Small).color(
Color::Custom(cx.theme().colors().text_muted.opacity(0.4)),
))
},
)
})
.child(div().child(branch_selector).min_w_0()),
)
.children(if let Some(git_panel) = self.git_panel {
git_panel.update(cx, |git_panel, cx| git_panel.render_remote_button(cx))
} else {
None
})
}
}
impl Component for PanelRepoFooter {
fn scope() -> ComponentScope {
ComponentScope::VersionControl
}
fn description() -> &'static str {
"The footer shown at the bottom of the git panel."
}
fn preview(_window: &mut Window, _cx: &mut App) -> AnyElement {
let unknown_upstream = None;
let no_remote_upstream = Some(UpstreamTracking::Gone);
let ahead_of_upstream = Some(
UpstreamTrackingStatus {
ahead: 2,
behind: 0,
}
.into(),
);
let behind_upstream = Some(
UpstreamTrackingStatus {
ahead: 0,
behind: 2,
}
.into(),
);
let ahead_and_behind_upstream = Some(
UpstreamTrackingStatus {
ahead: 3,
behind: 1,
}
.into(),
);
let not_ahead_or_behind_upstream = Some(
UpstreamTrackingStatus {
ahead: 0,
behind: 0,
}
.into(),
);
fn branch(upstream: Option<UpstreamTracking>) -> Branch {
Branch {
is_head: true,
ref_name: "some-branch".into(),
upstream: upstream.map(|tracking| Upstream {
ref_name: "origin/some-branch".into(),
tracking,
}),
most_recent_commit: Some(CommitSummary {
sha: "abc123".into(),
subject: "Modify stuff".into(),
commit_timestamp: 1710932954,
author_name: "John Doe".into(),
has_parent: true,
}),
}
}
fn custom(branch_name: &str, upstream: Option<UpstreamTracking>) -> Branch {
Branch {
is_head: true,
ref_name: branch_name.to_string().into(),
upstream: upstream.map(|tracking| Upstream {
ref_name: format!("zed/{}", branch_name).into(),
tracking,
}),
most_recent_commit: Some(CommitSummary {
sha: "abc123".into(),
subject: "Modify stuff".into(),
commit_timestamp: 1710932954,
author_name: "John Doe".into(),
has_parent: true,
}),
}
}
fn active_repository(id: usize) -> SharedString {
format!("repo-{}", id).into()
}
let example_width = px(340.);
v_flex()
.gap_6()
.w_full()
.flex_none()
.children(vec![
example_group_with_title(
"Action Button States",
vec![
single_example(
"No Branch",
div()
.w(example_width)
.overflow_hidden()
.child(PanelRepoFooter::new_preview(active_repository(1), None))
.into_any_element(),
),
single_example(
"Remote status unknown",
div()
.w(example_width)
.overflow_hidden()
.child(PanelRepoFooter::new_preview(
active_repository(2),
Some(branch(unknown_upstream)),
))
.into_any_element(),
),
single_example(
"No Remote Upstream",
div()
.w(example_width)
.overflow_hidden()
.child(PanelRepoFooter::new_preview(
active_repository(3),
Some(branch(no_remote_upstream)),
))
.into_any_element(),
),
single_example(
"Not Ahead or Behind",
div()
.w(example_width)
.overflow_hidden()
.child(PanelRepoFooter::new_preview(
active_repository(4),
Some(branch(not_ahead_or_behind_upstream)),
))
.into_any_element(),
),
single_example(
"Behind remote",
div()
.w(example_width)
.overflow_hidden()
.child(PanelRepoFooter::new_preview(
active_repository(5),
Some(branch(behind_upstream)),
))
.into_any_element(),
),
single_example(
"Ahead of remote",
div()
.w(example_width)
.overflow_hidden()
.child(PanelRepoFooter::new_preview(
active_repository(6),
Some(branch(ahead_of_upstream)),
))
.into_any_element(),
),
single_example(
"Ahead and behind remote",
div()
.w(example_width)
.overflow_hidden()
.child(PanelRepoFooter::new_preview(
active_repository(7),
Some(branch(ahead_and_behind_upstream)),
))
.into_any_element(),
),
],
)
.grow()
.vertical(),
])
.children(vec![
example_group_with_title(
"Labels",
vec![
single_example(
"Short Branch & Repo",
div()
.w(example_width)
.overflow_hidden()
.child(PanelRepoFooter::new_preview(
SharedString::from("zed"),
Some(custom("main", behind_upstream)),
))
.into_any_element(),
),
single_example(
"Long Branch",
div()
.w(example_width)
.overflow_hidden()
.child(PanelRepoFooter::new_preview(
SharedString::from("zed"),
Some(custom(
"redesign-and-update-git-ui-list-entry-style",
behind_upstream,
)),
))
.into_any_element(),
),
single_example(
"Long Repo",
div()
.w(example_width)
.overflow_hidden()
.child(PanelRepoFooter::new_preview(
SharedString::from("zed-industries-community-examples"),
Some(custom("gpui", ahead_of_upstream)),
))
.into_any_element(),
),
single_example(
"Long Repo & Branch",
div()
.w(example_width)
.overflow_hidden()
.child(PanelRepoFooter::new_preview(
SharedString::from("zed-industries-community-examples"),
Some(custom(
"redesign-and-update-git-ui-list-entry-style",
behind_upstream,
)),
))
.into_any_element(),
),
single_example(
"Uppercase Repo",
div()
.w(example_width)
.overflow_hidden()
.child(PanelRepoFooter::new_preview(
SharedString::from("LICENSES"),
Some(custom("main", ahead_of_upstream)),
))
.into_any_element(),
),
single_example(
"Uppercase Branch",
div()
.w(example_width)
.overflow_hidden()
.child(PanelRepoFooter::new_preview(
SharedString::from("zed"),
Some(custom("update-README", behind_upstream)),
))
.into_any_element(),
),
],
)
.grow()
.vertical(),
])
.into_any_element()
}
}
pub(crate) fn open_output(
operation: impl Into<SharedString>,
workspace: &mut Workspace,
output: &str,
window: &mut Window,
cx: &mut Context<Workspace>,
) {
let operation = operation.into();
let mut handler = GitOutputHandler::default();
let mut processor = ansi::Processor::<ansi::StdSyncHandler>::default();
processor.advance(&mut handler, output.as_bytes());
let plain_text = handler.output;
let buffer = cx.new(|cx| Buffer::local(plain_text.as_str(), cx));
buffer.update(cx, |buffer, cx| {
buffer.set_capability(language::Capability::ReadOnly, cx);
});
let editor = cx.new(|cx| {
let mut editor = Editor::for_buffer(buffer, None, window, cx);
editor.buffer().update(cx, |buffer, cx| {
buffer.set_title(format!("Output from git {operation}"), cx);
});
editor.set_read_only(true);
editor
});
workspace.add_item_to_center(Box::new(editor), window, cx);
}
#[derive(Default)]
struct GitOutputHandler {
output: String,
line_start: usize,
}
impl ansi::Handler for GitOutputHandler {
fn input(&mut self, c: char) {
self.output.push(c);
}
fn linefeed(&mut self) {
self.output.push('\n');
self.line_start = self.output.len();
}
fn carriage_return(&mut self) {
self.output.truncate(self.line_start);
}
fn put_tab(&mut self, count: u16) {
self.output
.extend(std::iter::repeat_n('\t', count as usize));
}
}
pub(crate) fn show_error_toast(
workspace: Entity<Workspace>,
action: impl Into<SharedString>,
e: anyhow::Error,
cx: &mut App,
) {
let action = action.into();
let message = format_git_error_toast_message(&e);
if message
.matches(git::repository::REMOTE_CANCELLED_BY_USER)
.next()
.is_some()
{ // Hide the cancelled by user message
} else {
cx.defer(move |cx| {
workspace.update(cx, |workspace, cx| {
let workspace_weak = cx.weak_entity();
let toast = StatusToast::new(format!("git {} failed", action), cx, |this, _cx| {
this.icon(
Icon::new(IconName::XCircle)
.size(IconSize::Small)
.color(Color::Error),
)
.action("View Log", move |window, cx| {
let message = message.clone();
let action = action.clone();
workspace_weak
.update(cx, move |workspace, cx| {
open_output(action, workspace, &message, window, cx)
})
.ok();
})
});
workspace.toggle_status_toast(toast, cx)
});
});
}
}
fn rpc_error_raw_message_from_chain(error: &anyhow::Error) -> Option<&str> {
error
.chain()
.find_map(|cause| cause.downcast_ref::<RpcError>().map(RpcError::raw_message))
}
fn format_git_error_toast_message(error: &anyhow::Error) -> String {
if let Some(message) = rpc_error_raw_message_from_chain(error) {
message.trim().to_string()
} else {
error.to_string().trim().to_string()
}
}
pub(crate) fn commit_title_exceeds_limit(title: &str, max_length: usize) -> bool {
max_length > 0 && title.chars().count() > max_length
}
#[cfg(test)]
mod tests {
use git::{
repository::repo_path,
status::{StatusCode, UnmergedStatus, UnmergedStatusCode},
};
use gpui::{TestAppContext, UpdateGlobal, VisualTestContext, px};
use indoc::indoc;
use project::FakeFs;
use serde_json::json;
use settings::SettingsStore;
use theme::LoadThemes;
use util::path;
use util::rel_path::rel_path;
use workspace::MultiWorkspace;
use super::*;
fn init_test(cx: &mut gpui::TestAppContext) {
zlog::init_test();
cx.update(|cx| {
let settings_store = SettingsStore::test(cx);
cx.set_global(settings_store);
theme_settings::init(LoadThemes::JustBase, cx);
editor::init(cx);
crate::init(cx);
});
}
#[test]
fn test_format_git_error_toast_message_prefers_raw_rpc_message() {
let rpc_error = RpcError::from_proto(
&proto::Error {
message:
"Your local changes to the following files would be overwritten by merge\n"
.to_string(),
code: proto::ErrorCode::Internal as i32,
tags: Default::default(),
},
"Pull",
);
let message = format_git_error_toast_message(&rpc_error);
assert_eq!(
message,
"Your local changes to the following files would be overwritten by merge"
);
}
#[test]
fn test_format_git_error_toast_message_prefers_raw_rpc_message_when_wrapped() {
let rpc_error = RpcError::from_proto(
&proto::Error {
message:
"Your local changes to the following files would be overwritten by merge\n"
.to_string(),
code: proto::ErrorCode::Internal as i32,
tags: Default::default(),
},
"Pull",
);
let wrapped = rpc_error.context("sending pull request");
let message = format_git_error_toast_message(&wrapped);
assert_eq!(
message,
"Your local changes to the following files would be overwritten by merge"
);
}
#[gpui::test]
async fn test_entry_worktree_paths(cx: &mut TestAppContext) {
init_test(cx);
let fs = FakeFs::new(cx.background_executor.clone());
fs.insert_tree(
"/root",
json!({
"zed": {
".git": {},
"crates": {
"gpui": {
"gpui.rs": "fn main() {}"
},
"util": {
"util.rs": "fn do_it() {}"
}
}
},
}),
)
.await;
fs.set_status_for_repo(
Path::new(path!("/root/zed/.git")),
&[
("crates/gpui/gpui.rs", StatusCode::Modified.worktree()),
("crates/util/util.rs", StatusCode::Modified.worktree()),
],
);
let project =
Project::test(fs.clone(), [path!("/root/zed/crates/gpui").as_ref()], cx).await;
let window_handle =
cx.add_window(|window, cx| MultiWorkspace::test_new(project.clone(), window, cx));
let workspace = window_handle
.read_with(cx, |mw, _| mw.workspace().clone())
.unwrap();
let cx = &mut VisualTestContext::from_window(window_handle.into(), cx);
cx.read(|cx| {
project
.read(cx)
.worktrees(cx)
.next()
.unwrap()
.read(cx)
.as_local()
.unwrap()
.scan_complete()
})
.await;
cx.executor().run_until_parked();
let panel = workspace.update_in(cx, GitPanel::new);
let handle = cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
});
cx.executor().advance_clock(2 * UPDATE_DEBOUNCE);
handle.await;
let entries = panel.read_with(cx, |panel, _| panel.entries.clone());
pretty_assertions::assert_eq!(
entries,
[
GitListEntry::Header(GitHeaderEntry {
header: Section::Tracked
}),
GitListEntry::Status(GitStatusEntry {
repo_path: repo_path("crates/gpui/gpui.rs"),
status: StatusCode::Modified.worktree(),
staging: StageStatus::Unstaged,
diff_stat: Some(DiffStat {
added: 1,
deleted: 1,
}),
}),
GitListEntry::Status(GitStatusEntry {
repo_path: repo_path("crates/util/util.rs"),
status: StatusCode::Modified.worktree(),
staging: StageStatus::Unstaged,
diff_stat: Some(DiffStat {
added: 1,
deleted: 1,
}),
},),
],
);
let handle = cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
});
cx.executor().advance_clock(2 * UPDATE_DEBOUNCE);
handle.await;
let entries = panel.read_with(cx, |panel, _| panel.entries.clone());
pretty_assertions::assert_eq!(
entries,
[
GitListEntry::Header(GitHeaderEntry {
header: Section::Tracked
}),
GitListEntry::Status(GitStatusEntry {
repo_path: repo_path("crates/gpui/gpui.rs"),
status: StatusCode::Modified.worktree(),
staging: StageStatus::Unstaged,
diff_stat: Some(DiffStat {
added: 1,
deleted: 1,
}),
}),
GitListEntry::Status(GitStatusEntry {
repo_path: repo_path("crates/util/util.rs"),
status: StatusCode::Modified.worktree(),
staging: StageStatus::Unstaged,
diff_stat: Some(DiffStat {
added: 1,
deleted: 1,
}),
},),
],
);
}
#[gpui::test]
async fn test_discard_prompt_escapes_markdown_in_file_name(cx: &mut TestAppContext) {
init_test(cx);
let fs = FakeFs::new(cx.background_executor.clone());
fs.insert_tree(
"/root",
json!({
"project": {
".git": {},
"__somefile__": "modified\n",
},
}),
)
.await;
fs.set_status_for_repo(
Path::new(path!("/root/project/.git")),
&[("__somefile__", StatusCode::Modified.worktree())],
);
let project = Project::test(fs.clone(), [Path::new(path!("/root/project"))], cx).await;
let window_handle =
cx.add_window(|window, cx| MultiWorkspace::test_new(project.clone(), window, cx));
let workspace = window_handle
.read_with(cx, |mw, _| mw.workspace().clone())
.unwrap();
let cx = &mut VisualTestContext::from_window(window_handle.into(), cx);
cx.read(|cx| {
project
.read(cx)
.worktrees(cx)
.next()
.unwrap()
.read(cx)
.as_local()
.unwrap()
.scan_complete()
})
.await;
cx.executor().run_until_parked();
let panel = workspace.update_in(cx, GitPanel::new);
let handle = cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
});
cx.executor().advance_clock(2 * UPDATE_DEBOUNCE);
handle.await;
panel.update_in(cx, |panel, window, cx| {
panel.selected_entry = Some(1);
panel.revert_selected(&git::RestoreFile::default(), window, cx);
});
let (message, _detail) = cx
.pending_prompt()
.expect("discard should show a confirmation prompt");
assert_eq!(
message,
"Are you sure you want to discard changes to `__somefile__`?"
);
}
#[gpui::test]
async fn test_bulk_staging(cx: &mut TestAppContext) {
use GitListEntry::*;
init_test(cx);
let fs = FakeFs::new(cx.background_executor.clone());
fs.insert_tree(
"/root",
json!({
"project": {
".git": {},
"src": {
"main.rs": "fn main() {}",
"lib.rs": "pub fn hello() {}",
"utils.rs": "pub fn util() {}"
},
"tests": {
"test.rs": "fn test() {}"
},
"new_file.txt": "new content",
"another_new.rs": "// new file",
"conflict.txt": "conflicted content"
}
}),
)
.await;
fs.set_status_for_repo(
Path::new(path!("/root/project/.git")),
&[
("src/main.rs", StatusCode::Modified.worktree()),
("src/lib.rs", StatusCode::Modified.worktree()),
("tests/test.rs", StatusCode::Modified.worktree()),
("new_file.txt", FileStatus::Untracked),
("another_new.rs", FileStatus::Untracked),
("src/utils.rs", FileStatus::Untracked),
(
"conflict.txt",
UnmergedStatus {
first_head: UnmergedStatusCode::Updated,
second_head: UnmergedStatusCode::Updated,
}
.into(),
),
],
);
let project = Project::test(fs.clone(), [Path::new(path!("/root/project"))], cx).await;
let window_handle =
cx.add_window(|window, cx| MultiWorkspace::test_new(project.clone(), window, cx));
let workspace = window_handle
.read_with(cx, |mw, _| mw.workspace().clone())
.unwrap();
let cx = &mut VisualTestContext::from_window(window_handle.into(), cx);
cx.read(|cx| {
project
.read(cx)
.worktrees(cx)
.next()
.unwrap()
.read(cx)
.as_local()
.unwrap()
.scan_complete()
})
.await;
cx.executor().run_until_parked();
let panel = workspace.update_in(cx, GitPanel::new);
let handle = cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
});
cx.executor().advance_clock(2 * UPDATE_DEBOUNCE);
handle.await;
let entries = panel.read_with(cx, |panel, _| panel.entries.clone());
#[rustfmt::skip]
pretty_assertions::assert_matches!(
entries.as_slice(),
&[
Header(GitHeaderEntry { header: Section::Conflict }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
Header(GitHeaderEntry { header: Section::Tracked }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
Header(GitHeaderEntry { header: Section::New }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
],
);
let second_status_entry = entries[3].clone();
panel.update_in(cx, |panel, window, cx| {
panel.toggle_staged_for_entry(&second_status_entry, window, cx);
});
panel.update_in(cx, |panel, window, cx| {
panel.selected_entry = Some(7);
panel.stage_range(&git::StageRange, window, cx);
});
cx.read(|cx| {
project
.read(cx)
.worktrees(cx)
.next()
.unwrap()
.read(cx)
.as_local()
.unwrap()
.scan_complete()
})
.await;
cx.executor().run_until_parked();
let handle = cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
});
cx.executor().advance_clock(2 * UPDATE_DEBOUNCE);
handle.await;
let entries = panel.read_with(cx, |panel, _| panel.entries.clone());
#[rustfmt::skip]
pretty_assertions::assert_matches!(
entries.as_slice(),
&[
Header(GitHeaderEntry { header: Section::Conflict }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
Header(GitHeaderEntry { header: Section::Tracked }),
Status(GitStatusEntry { staging: StageStatus::Staged, .. }),
Status(GitStatusEntry { staging: StageStatus::Staged, .. }),
Status(GitStatusEntry { staging: StageStatus::Staged, .. }),
Header(GitHeaderEntry { header: Section::New }),
Status(GitStatusEntry { staging: StageStatus::Staged, .. }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
],
);
let third_status_entry = entries[4].clone();
panel.update_in(cx, |panel, window, cx| {
panel.toggle_staged_for_entry(&third_status_entry, window, cx);
});
panel.update_in(cx, |panel, window, cx| {
panel.selected_entry = Some(9);
panel.stage_range(&git::StageRange, window, cx);
});
cx.read(|cx| {
project
.read(cx)
.worktrees(cx)
.next()
.unwrap()
.read(cx)
.as_local()
.unwrap()
.scan_complete()
})
.await;
cx.executor().run_until_parked();
let handle = cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
});
cx.executor().advance_clock(2 * UPDATE_DEBOUNCE);
handle.await;
let entries = panel.read_with(cx, |panel, _| panel.entries.clone());
#[rustfmt::skip]
pretty_assertions::assert_matches!(
entries.as_slice(),
&[
Header(GitHeaderEntry { header: Section::Conflict }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
Header(GitHeaderEntry { header: Section::Tracked }),
Status(GitStatusEntry { staging: StageStatus::Staged, .. }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { staging: StageStatus::Staged, .. }),
Header(GitHeaderEntry { header: Section::New }),
Status(GitStatusEntry { staging: StageStatus::Staged, .. }),
Status(GitStatusEntry { staging: StageStatus::Staged, .. }),
Status(GitStatusEntry { staging: StageStatus::Staged, .. }),
],
);
}
#[gpui::test]
async fn test_bulk_staging_with_sort_by_paths(cx: &mut TestAppContext) {
use GitListEntry::*;
init_test(cx);
let fs = FakeFs::new(cx.background_executor.clone());
fs.insert_tree(
"/root",
json!({
"project": {
".git": {},
"src": {
"main.rs": "fn main() {}",
"lib.rs": "pub fn hello() {}",
"utils.rs": "pub fn util() {}"
},
"tests": {
"test.rs": "fn test() {}"
},
"new_file.txt": "new content",
"another_new.rs": "// new file",
"conflict.txt": "conflicted content"
}
}),
)
.await;
fs.set_status_for_repo(
Path::new(path!("/root/project/.git")),
&[
("src/main.rs", StatusCode::Modified.worktree()),
("src/lib.rs", StatusCode::Modified.worktree()),
("tests/test.rs", StatusCode::Modified.worktree()),
("new_file.txt", FileStatus::Untracked),
("another_new.rs", FileStatus::Untracked),
("src/utils.rs", FileStatus::Untracked),
(
"conflict.txt",
UnmergedStatus {
first_head: UnmergedStatusCode::Updated,
second_head: UnmergedStatusCode::Updated,
}
.into(),
),
],
);
let project = Project::test(fs.clone(), [Path::new(path!("/root/project"))], cx).await;
let window_handle =
cx.add_window(|window, cx| MultiWorkspace::test_new(project.clone(), window, cx));
let workspace = window_handle
.read_with(cx, |mw, _| mw.workspace().clone())
.unwrap();
let cx = &mut VisualTestContext::from_window(window_handle.into(), cx);
cx.read(|cx| {
project
.read(cx)
.worktrees(cx)
.next()
.unwrap()
.read(cx)
.as_local()
.unwrap()
.scan_complete()
})
.await;
cx.executor().run_until_parked();
let panel = workspace.update_in(cx, GitPanel::new);
let handle = cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
});
cx.executor().advance_clock(2 * UPDATE_DEBOUNCE);
handle.await;
let entries = panel.read_with(cx, |panel, _| panel.entries.clone());
#[rustfmt::skip]
pretty_assertions::assert_matches!(
entries.as_slice(),
&[
Header(GitHeaderEntry { header: Section::Conflict }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
Header(GitHeaderEntry { header: Section::Tracked }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
Header(GitHeaderEntry { header: Section::New }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { staging: StageStatus::Unstaged, .. }),
],
);
assert_entry_paths(
&entries,
&[
None,
Some("conflict.txt"),
None,
Some("src/lib.rs"),
Some("src/main.rs"),
Some("tests/test.rs"),
None,
Some("another_new.rs"),
Some("new_file.txt"),
Some("src/utils.rs"),
],
);
let second_status_entry = entries[3].clone();
panel.update_in(cx, |panel, window, cx| {
panel.toggle_staged_for_entry(&second_status_entry, window, cx);
});
cx.update(|_window, cx| {
SettingsStore::update_global(cx, |store, cx| {
store.update_user_settings(cx, |settings| {
settings.git_panel.get_or_insert_default().sort_by_path = Some(true);
})
});
});
panel.update_in(cx, |panel, window, cx| {
panel.selected_entry = Some(7);
panel.stage_range(&git::StageRange, window, cx);
});
cx.read(|cx| {
project
.read(cx)
.worktrees(cx)
.next()
.unwrap()
.read(cx)
.as_local()
.unwrap()
.scan_complete()
})
.await;
cx.executor().run_until_parked();
let handle = cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
});
cx.executor().advance_clock(2 * UPDATE_DEBOUNCE);
handle.await;
let entries = panel.read_with(cx, |panel, _| panel.entries.clone());
#[rustfmt::skip]
pretty_assertions::assert_matches!(
entries.as_slice(),
&[
Status(GitStatusEntry { status: FileStatus::Untracked, staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { status: FileStatus::Unmerged(..), staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { status: FileStatus::Untracked, staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { status: FileStatus::Tracked(..), staging: StageStatus::Staged, .. }),
Status(GitStatusEntry { status: FileStatus::Tracked(..), staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { status: FileStatus::Untracked, staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { status: FileStatus::Tracked(..), staging: StageStatus::Unstaged, .. }),
],
);
assert_entry_paths(
&entries,
&[
Some("another_new.rs"),
Some("conflict.txt"),
Some("new_file.txt"),
Some("src/lib.rs"),
Some("src/main.rs"),
Some("src/utils.rs"),
Some("tests/test.rs"),
],
);
let third_status_entry = entries[4].clone();
panel.update_in(cx, |panel, window, cx| {
panel.toggle_staged_for_entry(&third_status_entry, window, cx);
});
panel.update_in(cx, |panel, window, cx| {
panel.selected_entry = Some(9);
panel.stage_range(&git::StageRange, window, cx);
});
cx.read(|cx| {
project
.read(cx)
.worktrees(cx)
.next()
.unwrap()
.read(cx)
.as_local()
.unwrap()
.scan_complete()
})
.await;
cx.executor().run_until_parked();
let handle = cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
});
cx.executor().advance_clock(2 * UPDATE_DEBOUNCE);
handle.await;
let entries = panel.read_with(cx, |panel, _| panel.entries.clone());
#[rustfmt::skip]
pretty_assertions::assert_matches!(
entries.as_slice(),
&[
Status(GitStatusEntry { status: FileStatus::Untracked, staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { status: FileStatus::Unmerged(..), staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { status: FileStatus::Untracked, staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { status: FileStatus::Tracked(..), staging: StageStatus::Staged, .. }),
Status(GitStatusEntry { status: FileStatus::Tracked(..), staging: StageStatus::Staged, .. }),
Status(GitStatusEntry { status: FileStatus::Untracked, staging: StageStatus::Unstaged, .. }),
Status(GitStatusEntry { status: FileStatus::Tracked(..), staging: StageStatus::Unstaged, .. }),
],
);
assert_entry_paths(
&entries,
&[
Some("another_new.rs"),
Some("conflict.txt"),
Some("new_file.txt"),
Some("src/lib.rs"),
Some("src/main.rs"),
Some("src/utils.rs"),
Some("tests/test.rs"),
],
);
}
#[gpui::test]
async fn test_amend_commit_message_handling(cx: &mut TestAppContext) {
init_test(cx);
let fs = FakeFs::new(cx.background_executor.clone());
fs.insert_tree(
"/root",
json!({
"project": {
".git": {},
"src": {
"main.rs": "fn main() {}"
}
}
}),
)
.await;
fs.set_status_for_repo(
Path::new(path!("/root/project/.git")),
&[("src/main.rs", StatusCode::Modified.worktree())],
);
let project = Project::test(fs.clone(), [Path::new(path!("/root/project"))], cx).await;
let window_handle =
cx.add_window(|window, cx| MultiWorkspace::test_new(project.clone(), window, cx));
let workspace = window_handle
.read_with(cx, |mw, _| mw.workspace().clone())
.unwrap();
let cx = &mut VisualTestContext::from_window(window_handle.into(), cx);
let panel = workspace.update_in(cx, GitPanel::new);
// Test: User has commit message, enables amend (saves message), then disables (restores message)
panel.update(cx, |panel, cx| {
panel.commit_message_buffer(cx).update(cx, |buffer, cx| {
let start = buffer.anchor_before(0);
let end = buffer.anchor_after(buffer.len());
buffer.edit([(start..end, "Initial commit message")], None, cx);
});
panel.set_amend_pending(true, cx);
assert!(panel.original_commit_message.is_some());
panel.set_amend_pending(false, cx);
let current_message = panel.commit_message_buffer(cx).read(cx).text();
assert_eq!(current_message, "Initial commit message");
assert!(panel.original_commit_message.is_none());
});
// Test: User has empty commit message, enables amend, then disables (clears message)
panel.update(cx, |panel, cx| {
panel.commit_message_buffer(cx).update(cx, |buffer, cx| {
let start = buffer.anchor_before(0);
let end = buffer.anchor_after(buffer.len());
buffer.edit([(start..end, "")], None, cx);
});
panel.set_amend_pending(true, cx);
assert!(panel.original_commit_message.is_none());
panel.commit_message_buffer(cx).update(cx, |buffer, cx| {
let start = buffer.anchor_before(0);
let end = buffer.anchor_after(buffer.len());
buffer.edit([(start..end, "Previous commit message")], None, cx);
});
panel.set_amend_pending(false, cx);
let current_message = panel.commit_message_buffer(cx).read(cx).text();
assert_eq!(current_message, "");
});
}
#[gpui::test]
async fn test_amend(cx: &mut TestAppContext) {
init_test(cx);
let fs = FakeFs::new(cx.background_executor.clone());
fs.insert_tree(
"/root",
json!({
"project": {
".git": {},
"src": {
"main.rs": "fn main() {}"
}
}
}),
)
.await;
fs.set_status_for_repo(
Path::new(path!("/root/project/.git")),
&[("src/main.rs", StatusCode::Modified.worktree())],
);
let project = Project::test(fs.clone(), [Path::new(path!("/root/project"))], cx).await;
let window_handle =
cx.add_window(|window, cx| MultiWorkspace::test_new(project.clone(), window, cx));
let workspace = window_handle
.read_with(cx, |mw, _| mw.workspace().clone())
.unwrap();
let cx = &mut VisualTestContext::from_window(window_handle.into(), cx);
// Wait for the project scanning to finish so that `head_commit(cx)` is
// actually set, otherwise no head commit would be available from which
// to fetch the latest commit message from.
cx.executor().run_until_parked();
let panel = workspace.update_in(cx, GitPanel::new);
panel.read_with(cx, |panel, cx| {
assert!(panel.active_repository.is_some());
assert!(panel.head_commit(cx).is_some());
});
panel.update_in(cx, |panel, window, cx| {
// Update the commit editor's message to ensure that its contents
// are later restored, after amending is finished.
panel.commit_message_buffer(cx).update(cx, |buffer, cx| {
buffer.set_text("refactor: update main.rs", cx);
});
// Start amending the previous commit.
panel.focus_editor(&Default::default(), window, cx);
panel.on_amend(&Amend, window, cx);
});
// Since `GitPanel.amend` attempts to fetch the latest commit message in
// a background task, we need to wait for it to complete before being
// able to assert that the commit message editor's state has been
// updated.
cx.run_until_parked();
panel.update_in(cx, |panel, window, cx| {
assert_eq!(
panel.commit_message_buffer(cx).read(cx).text(),
"initial commit"
);
assert_eq!(
panel.original_commit_message,
Some("refactor: update main.rs".to_string())
);
// Finish amending the previous commit.
panel.focus_editor(&Default::default(), window, cx);
panel.on_amend(&Amend, window, cx);
});
// Since the actual commit logic is run in a background task, we need to
// await its completion to actually ensure that the commit message
// editor's contents are set to the original message and haven't been
// cleared.
cx.run_until_parked();
panel.update_in(cx, |panel, _window, cx| {
// After amending, the commit editor's message should be restored to
// the original message.
assert_eq!(
panel.commit_message_buffer(cx).read(cx).text(),
"refactor: update main.rs"
);
assert!(panel.original_commit_message.is_none());
});
}
#[gpui::test]
async fn test_open_diff(cx: &mut TestAppContext) {
init_test(cx);
let fs = FakeFs::new(cx.background_executor.clone());
fs.insert_tree(
path!("/project"),
json!({
".git": {},
"tracked": "tracked\n",
"untracked": "\n",
}),
)
.await;
fs.set_head_and_index_for_repo(
path!("/project/.git").as_ref(),
&[("tracked", "old tracked\n".into())],
);
let project = Project::test(fs.clone(), [Path::new(path!("/project"))], cx).await;
let window_handle =
cx.add_window(|window, cx| MultiWorkspace::test_new(project.clone(), window, cx));
let workspace = window_handle
.read_with(cx, |mw, _| mw.workspace().clone())
.unwrap();
let cx = &mut VisualTestContext::from_window(window_handle.into(), cx);
let panel = workspace.update_in(cx, GitPanel::new);
// Enable the `sort_by_path` setting and wait for entries to be updated,
// as there should no longer be separators between Tracked and Untracked
// files.
cx.update(|_window, cx| {
SettingsStore::update_global(cx, |store, cx| {
store.update_user_settings(cx, |settings| {
settings.git_panel.get_or_insert_default().sort_by_path = Some(true);
})
});
});
cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
})
.await;
// Confirm that `Open Diff` still works for the untracked file, updating
// the Project Diff's active path.
panel.update_in(cx, |panel, window, cx| {
panel.selected_entry = Some(1);
panel.open_diff(&menu::Confirm, window, cx);
});
cx.run_until_parked();
workspace.update_in(cx, |workspace, _window, cx| {
let active_path = workspace
.item_of_type::<ProjectDiff>(cx)
.expect("ProjectDiff should exist")
.read(cx)
.active_project_path(cx)
.expect("active_project_path should exist");
assert_eq!(active_path.path, rel_path("untracked").into_arc());
});
}
#[gpui::test]
async fn test_tree_view_reveals_collapsed_parent_on_select_entry_by_path(
cx: &mut TestAppContext,
) {
init_test(cx);
let fs = FakeFs::new(cx.background_executor.clone());
fs.insert_tree(
path!("/project"),
json!({
".git": {},
"src": {
"a": {
"foo.rs": "fn foo() {}",
},
"b": {
"bar.rs": "fn bar() {}",
},
},
}),
)
.await;
fs.set_status_for_repo(
path!("/project/.git").as_ref(),
&[
("src/a/foo.rs", StatusCode::Modified.worktree()),
("src/b/bar.rs", StatusCode::Modified.worktree()),
],
);
let project = Project::test(fs.clone(), [Path::new(path!("/project"))], cx).await;
let window_handle =
cx.add_window(|window, cx| MultiWorkspace::test_new(project.clone(), window, cx));
let workspace = window_handle
.read_with(cx, |mw, _| mw.workspace().clone())
.unwrap();
let cx = &mut VisualTestContext::from_window(window_handle.into(), cx);
cx.read(|cx| {
project
.read(cx)
.worktrees(cx)
.next()
.unwrap()
.read(cx)
.as_local()
.unwrap()
.scan_complete()
})
.await;
cx.executor().run_until_parked();
cx.update(|_window, cx| {
SettingsStore::update_global(cx, |store, cx| {
store.update_user_settings(cx, |settings| {
settings.git_panel.get_or_insert_default().tree_view = Some(true);
})
});
});
let panel = workspace.update_in(cx, GitPanel::new);
let handle = cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
});
cx.executor().advance_clock(2 * UPDATE_DEBOUNCE);
handle.await;
let src_key = panel.read_with(cx, |panel, _| {
panel
.entries
.iter()
.find_map(|entry| match entry {
GitListEntry::Directory(dir) if dir.key.path == repo_path("src") => {
Some(dir.key.clone())
}
_ => None,
})
.expect("src directory should exist in tree view")
});
panel.update_in(cx, |panel, window, cx| {
panel.toggle_directory(&src_key, window, cx);
});
panel.read_with(cx, |panel, _| {
let state = panel
.view_mode
.tree_state()
.expect("tree view state should exist");
assert_eq!(state.expanded_dirs.get(&src_key).copied(), Some(false));
});
let worktree_id =
cx.read(|cx| project.read(cx).worktrees(cx).next().unwrap().read(cx).id());
let project_path = ProjectPath {
worktree_id,
path: RelPath::unix("src/a/foo.rs").unwrap().into_arc(),
};
panel.update_in(cx, |panel, window, cx| {
panel.select_entry_by_path(project_path, window, cx);
});
panel.read_with(cx, |panel, _| {
let state = panel
.view_mode
.tree_state()
.expect("tree view state should exist");
assert_eq!(state.expanded_dirs.get(&src_key).copied(), Some(true));
let selected_ix = panel.selected_entry.expect("selection should be set");
assert!(state.logical_indices.contains(&selected_ix));
let selected_entry = panel
.entries
.get(selected_ix)
.and_then(|entry| entry.status_entry())
.expect("selected entry should be a status entry");
assert_eq!(selected_entry.repo_path, repo_path("src/a/foo.rs"));
});
}
#[gpui::test]
async fn test_tree_view_select_next_at_last_visible_collapsed_directory(
cx: &mut TestAppContext,
) {
init_test(cx);
let fs = FakeFs::new(cx.background_executor.clone());
fs.insert_tree(
path!("/project"),
json!({
".git": {},
"bar": {
"bar1.py": "print('bar1')",
"bar2.py": "print('bar2')",
},
"foo": {
"foo1.py": "print('foo1')",
"foo2.py": "print('foo2')",
},
"foobar.py": "print('foobar')",
}),
)
.await;
fs.set_status_for_repo(
path!("/project/.git").as_ref(),
&[
("bar/bar1.py", StatusCode::Modified.worktree()),
("bar/bar2.py", StatusCode::Modified.worktree()),
("foo/foo1.py", StatusCode::Modified.worktree()),
("foo/foo2.py", StatusCode::Modified.worktree()),
("foobar.py", FileStatus::Untracked),
],
);
let project = Project::test(fs.clone(), [Path::new(path!("/project"))], cx).await;
let window_handle =
cx.add_window(|window, cx| MultiWorkspace::test_new(project.clone(), window, cx));
let workspace = window_handle
.read_with(cx, |mw, _| mw.workspace().clone())
.unwrap();
let cx = &mut VisualTestContext::from_window(window_handle.into(), cx);
cx.read(|cx| {
project
.read(cx)
.worktrees(cx)
.next()
.unwrap()
.read(cx)
.as_local()
.unwrap()
.scan_complete()
})
.await;
cx.executor().run_until_parked();
cx.update(|_window, cx| {
SettingsStore::update_global(cx, |store, cx| {
store.update_user_settings(cx, |settings| {
settings.git_panel.get_or_insert_default().tree_view = Some(true);
})
});
});
let panel = workspace.update_in(cx, GitPanel::new);
let handle = cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
});
cx.executor().advance_clock(2 * UPDATE_DEBOUNCE);
handle.await;
let foo_key = panel.read_with(cx, |panel, _| {
panel
.entries
.iter()
.find_map(|entry| match entry {
GitListEntry::Directory(dir) if dir.key.path == repo_path("foo") => {
Some(dir.key.clone())
}
_ => None,
})
.expect("foo directory should exist in tree view")
});
panel.update_in(cx, |panel, window, cx| {
panel.toggle_directory(&foo_key, window, cx);
});
let foo_idx = panel.read_with(cx, |panel, _| {
let state = panel
.view_mode
.tree_state()
.expect("tree view state should exist");
assert_eq!(state.expanded_dirs.get(&foo_key).copied(), Some(false));
let foo_idx = panel
.entries
.iter()
.enumerate()
.find_map(|(index, entry)| match entry {
GitListEntry::Directory(dir) if dir.key.path == repo_path("foo") => Some(index),
_ => None,
})
.expect("foo directory should exist in tree view");
let foo_logical_idx = state
.logical_indices
.iter()
.position(|&index| index == foo_idx)
.expect("foo directory should be visible");
let next_logical_idx = state.logical_indices[foo_logical_idx + 1];
assert!(matches!(
panel.entries.get(next_logical_idx),
Some(GitListEntry::Header(GitHeaderEntry {
header: Section::New
}))
));
foo_idx
});
panel.update_in(cx, |panel, window, cx| {
panel.selected_entry = Some(foo_idx);
panel.select_next(&menu::SelectNext, window, cx);
});
panel.read_with(cx, |panel, _| {
let selected_idx = panel.selected_entry.expect("selection should be set");
let selected_entry = panel
.entries
.get(selected_idx)
.and_then(|entry| entry.status_entry())
.expect("selected entry should be a status entry");
assert_eq!(selected_entry.repo_path, repo_path("foobar.py"));
});
}
fn assert_entry_paths(entries: &[GitListEntry], expected_paths: &[Option<&str>]) {
assert_eq!(entries.len(), expected_paths.len());
for (entry, expected_path) in entries.iter().zip(expected_paths) {
assert_eq!(
entry.status_entry().map(|status| status
.repo_path
.as_ref()
.as_std_path()
.to_string_lossy()
.to_string()),
expected_path.map(|s| s.to_string())
);
}
}
#[test]
fn test_compress_diff_no_truncation() {
let diff = indoc! {"
--- a/file.txt
+++ b/file.txt
@@ -1,2 +1,2 @@
-old
+new
"};
let result = GitPanel::compress_commit_diff(diff, 1000);
assert_eq!(result, diff);
}
#[test]
fn test_compress_diff_truncate_long_lines() {
let long_line = "🦀".repeat(300);
let diff = indoc::formatdoc! {"
--- a/file.txt
+++ b/file.txt
@@ -1,2 +1,3 @@
context
+{}
more context
", long_line};
let result = GitPanel::compress_commit_diff(&diff, 100);
assert!(result.contains("...[truncated]"));
assert!(result.len() < diff.len());
}
#[test]
fn test_compress_diff_truncate_hunks() {
let diff = indoc! {"
--- a/file.txt
+++ b/file.txt
@@ -1,2 +1,2 @@
context
-old1
+new1
@@ -5,2 +5,2 @@
context 2
-old2
+new2
@@ -10,2 +10,2 @@
context 3
-old3
+new3
"};
let result = GitPanel::compress_commit_diff(diff, 100);
let expected = indoc! {"
--- a/file.txt
+++ b/file.txt
@@ -1,2 +1,2 @@
context
-old1
+new1
[...skipped 2 hunks...]
"};
assert_eq!(result, expected);
}
#[test]
fn test_commit_message_prompt_includes_user_agents_md_before_project_rules() {
let prompt = GitPanel::build_commit_message_prompt(
"Write a commit message.",
Some("Use terse commit messages."),
Some("Use the git_ui prefix."),
"Update generated message",
"diff --git a/file b/file",
);
assert!(prompt.contains("Use terse commit messages."));
assert!(prompt.contains("Use the git_ui prefix."));
assert!(prompt.contains("Update generated message"));
assert!(prompt.contains("diff --git a/file b/file"));
let user_agents_md_index = prompt.find("<rules>").unwrap();
let project_rules_index = prompt.find("<project_rules>").unwrap();
assert!(user_agents_md_index < project_rules_index);
}
#[gpui::test]
async fn test_suggest_commit_message(cx: &mut TestAppContext) {
init_test(cx);
let fs = FakeFs::new(cx.background_executor.clone());
fs.insert_tree(
path!("/project"),
json!({
".git": {},
"tracked": "tracked\n",
"untracked": "\n",
}),
)
.await;
fs.set_head_and_index_for_repo(
path!("/project/.git").as_ref(),
&[("tracked", "old tracked\n".into())],
);
let project = Project::test(fs.clone(), [Path::new(path!("/project"))], cx).await;
let window_handle =
cx.add_window(|window, cx| MultiWorkspace::test_new(project.clone(), window, cx));
let workspace = window_handle
.read_with(cx, |mw, _| mw.workspace().clone())
.unwrap();
let cx = &mut VisualTestContext::from_window(window_handle.into(), cx);
let panel = workspace.update_in(cx, GitPanel::new);
let handle = cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
});
cx.executor().advance_clock(2 * UPDATE_DEBOUNCE);
handle.await;
let entries = panel.read_with(cx, |panel, _| panel.entries.clone());
// GitPanel
// - Tracked:
// - [] tracked
// - Untracked
// - [] untracked
//
// The commit message should now read:
// "Update tracked"
let message = panel.update(cx, |panel, cx| panel.suggest_commit_message(cx));
assert_eq!(message, Some("Update tracked".to_string()));
let first_status_entry = entries[1].clone();
panel.update_in(cx, |panel, window, cx| {
panel.toggle_staged_for_entry(&first_status_entry, window, cx);
});
cx.read(|cx| {
project
.read(cx)
.worktrees(cx)
.next()
.unwrap()
.read(cx)
.as_local()
.unwrap()
.scan_complete()
})
.await;
cx.executor().run_until_parked();
let handle = cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
});
cx.executor().advance_clock(2 * UPDATE_DEBOUNCE);
handle.await;
// GitPanel
// - Tracked:
// - [x] tracked
// - Untracked
// - [] untracked
//
// The commit message should still read:
// "Update tracked"
let message = panel.update(cx, |panel, cx| panel.suggest_commit_message(cx));
assert_eq!(message, Some("Update tracked".to_string()));
let second_status_entry = entries[3].clone();
panel.update_in(cx, |panel, window, cx| {
panel.toggle_staged_for_entry(&second_status_entry, window, cx);
});
cx.read(|cx| {
project
.read(cx)
.worktrees(cx)
.next()
.unwrap()
.read(cx)
.as_local()
.unwrap()
.scan_complete()
})
.await;
cx.executor().run_until_parked();
let handle = cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
});
cx.executor().advance_clock(2 * UPDATE_DEBOUNCE);
handle.await;
// GitPanel
// - Tracked:
// - [x] tracked
// - Untracked
// - [x] untracked
//
// The commit message should now read:
// "Enter commit message"
// (which means we should see None returned).
let message = panel.update(cx, |panel, cx| panel.suggest_commit_message(cx));
assert!(message.is_none());
panel.update_in(cx, |panel, window, cx| {
panel.toggle_staged_for_entry(&first_status_entry, window, cx);
});
cx.read(|cx| {
project
.read(cx)
.worktrees(cx)
.next()
.unwrap()
.read(cx)
.as_local()
.unwrap()
.scan_complete()
})
.await;
cx.executor().run_until_parked();
let handle = cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
});
cx.executor().advance_clock(2 * UPDATE_DEBOUNCE);
handle.await;
// GitPanel
// - Tracked:
// - [] tracked
// - Untracked
// - [x] untracked
//
// The commit message should now read:
// "Update untracked"
let message = panel.update(cx, |panel, cx| panel.suggest_commit_message(cx));
assert_eq!(message, Some("Create untracked".to_string()));
panel.update_in(cx, |panel, window, cx| {
panel.toggle_staged_for_entry(&second_status_entry, window, cx);
});
cx.read(|cx| {
project
.read(cx)
.worktrees(cx)
.next()
.unwrap()
.read(cx)
.as_local()
.unwrap()
.scan_complete()
})
.await;
cx.executor().run_until_parked();
let handle = cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
});
cx.executor().advance_clock(2 * UPDATE_DEBOUNCE);
handle.await;
// GitPanel
// - Tracked:
// - [] tracked
// - Untracked
// - [] untracked
//
// The commit message should now read:
// "Update tracked"
let message = panel.update(cx, |panel, cx| panel.suggest_commit_message(cx));
assert_eq!(message, Some("Update tracked".to_string()));
}
#[test]
fn test_git_output_handler_strips_ansi_codes() {
use alacritty_terminal::vte::ansi;
let cases = [
("no escape codes here\n", "no escape codes here\n"),
("\x1b[31mhello\x1b[0m", "hello"),
("\x1b[1;32mfoo\x1b[0m bar", "foo bar"),
("progress 10%\rprogress 100%\n", "progress 100%\n"),
];
for (input, expected) in cases {
let mut handler = GitOutputHandler::default();
let mut processor = ansi::Processor::<ansi::StdSyncHandler>::default();
processor.advance(&mut handler, input.as_bytes());
assert_eq!(handler.output, expected);
}
}
#[test]
fn test_commit_title_exceeds_limit() {
// ASCII only
let within_ascii = "abcde";
let exceeds_ascii = "abcdef";
assert!(!commit_title_exceeds_limit(within_ascii, 5));
assert!(commit_title_exceeds_limit(exceeds_ascii, 5));
// Multi-byte characters are counted as grapheme clusters
let within_japanese = "あいうえお"; // 5 chars, 15 bytes
let exceeds_japanese = "あいうえおか"; // 6 chars, 18 bytes
assert!(!commit_title_exceeds_limit(within_japanese, 5));
assert!(commit_title_exceeds_limit(exceeds_japanese, 5));
// Mixed ASCII + multi-byte
let within_mixed = "abcあ";
let exceeds_mixed = "abcああ";
assert!(!commit_title_exceeds_limit(within_mixed, 4));
assert!(commit_title_exceeds_limit(exceeds_mixed, 4));
// Emoji counts as one character each
let within_emoji = "🚀";
let exceeds_emoji = "🚀🚀";
assert!(!commit_title_exceeds_limit(within_emoji, 1));
assert!(commit_title_exceeds_limit(exceeds_emoji, 1));
// A max_length of 0 disables the limit check
assert!(!commit_title_exceeds_limit(
"anything goes when disabled",
0
));
assert!(!commit_title_exceeds_limit("", 0));
// Empty title never exceeds a positive limit
assert!(!commit_title_exceeds_limit("", 72));
}
#[gpui::test]
async fn test_dispatch_context_with_focus_states(cx: &mut TestAppContext) {
init_test(cx);
let fs = FakeFs::new(cx.background_executor.clone());
fs.insert_tree(
path!("/project"),
json!({
".git": {},
"tracked": "tracked\n",
}),
)
.await;
fs.set_head_and_index_for_repo(
path!("/project/.git").as_ref(),
&[("tracked", "old tracked\n".into())],
);
let project = Project::test(fs.clone(), [Path::new(path!("/project"))], cx).await;
let window_handle =
cx.add_window(|window, cx| MultiWorkspace::test_new(project.clone(), window, cx));
let workspace = window_handle
.read_with(cx, |mw, _| mw.workspace().clone())
.unwrap();
let cx = &mut VisualTestContext::from_window(window_handle.into(), cx);
let panel = workspace.update_in(cx, GitPanel::new);
let handle = cx.update_window_entity(&panel, |panel, _, _| {
std::mem::replace(&mut panel.update_visible_entries_task, Task::ready(()))
});
cx.executor().advance_clock(2 * UPDATE_DEBOUNCE);
handle.await;
// Case 1: Focus the commit editor — should have "CommitEditor" but NOT "menu"/"ChangesList"
panel.update_in(cx, |panel, window, cx| {
panel.focus_editor(&FocusEditor, window, cx);
let editor_is_focused = panel.commit_editor.read(cx).is_focused(window);
assert!(
editor_is_focused,
"commit editor should be focused after focus_editor action"
);
let context = panel.dispatch_context(window, cx);
assert!(
context.contains("GitPanel"),
"should always have GitPanel context"
);
assert!(
context.contains("CommitEditor"),
"should have CommitEditor context when commit editor is focused"
);
assert!(
!context.contains("menu"),
"should not have menu context when commit editor is focused"
);
assert!(
!context.contains("ChangesList"),
"should not have ChangesList context when commit editor is focused"
);
});
// Case 2: Focus the panel's focus handle directly — should have "menu" and "ChangesList".
// We force a draw via simulate_resize to ensure the dispatch tree is populated,
// since contains_focused() depends on the rendered dispatch tree.
panel.update_in(cx, |panel, window, cx| {
panel.focus_handle.focus(window, cx);
});
cx.simulate_resize(gpui::size(px(800.), px(600.)));
panel.update_in(cx, |panel, window, cx| {
let context = panel.dispatch_context(window, cx);
assert!(
context.contains("GitPanel"),
"should always have GitPanel context"
);
assert!(
context.contains("menu"),
"should have menu context when changes list is focused"
);
assert!(
context.contains("ChangesList"),
"should have ChangesList context when changes list is focused"
);
assert!(
!context.contains("CommitEditor"),
"should not have CommitEditor context when changes list is focused"
);
});
// Case 3: Switch back to commit editor and verify context switches correctly
panel.update_in(cx, |panel, window, cx| {
panel.focus_editor(&FocusEditor, window, cx);
});
panel.update_in(cx, |panel, window, cx| {
let context = panel.dispatch_context(window, cx);
assert!(
context.contains("CommitEditor"),
"should have CommitEditor after switching focus back to editor"
);
assert!(
!context.contains("menu"),
"should not have menu after switching focus back to editor"
);
});
// Case 4: Re-focus changes list and verify it transitions back correctly
panel.update_in(cx, |panel, window, cx| {
panel.focus_handle.focus(window, cx);
});
cx.simulate_resize(gpui::size(px(800.), px(600.)));
panel.update_in(cx, |panel, window, cx| {
assert!(
panel.focus_handle.contains_focused(window, cx),
"panel focus handle should report contains_focused when directly focused"
);
let context = panel.dispatch_context(window, cx);
assert!(
context.contains("menu"),
"should have menu context after re-focusing changes list"
);
assert!(
context.contains("ChangesList"),
"should have ChangesList context after re-focusing changes list"
);
});
}
#[gpui::test]
async fn test_fill_commit_editor_toggle(cx: &mut TestAppContext) {
init_test(cx);
let fs = FakeFs::new(cx.background_executor.clone());
fs.insert_tree(
"/root",
json!({ "project": { ".git": {}, "src": { "main.rs": "fn main() {}" } } }),
)
.await;
let project = Project::test(fs.clone(), [Path::new(path!("/root/project"))], cx).await;
let window_handle =
cx.add_window(|window, cx| MultiWorkspace::test_new(project.clone(), window, cx));
let workspace = window_handle
.read_with(cx, |mw, _| mw.workspace().clone())
.unwrap();
let cx = &mut VisualTestContext::from_window(window_handle.into(), cx);
cx.executor().run_until_parked();
let panel = workspace.update_in(cx, GitPanel::new);
panel.update_in(cx, |panel, window, cx| {
assert!(!panel.commit_editor_expanded);
assert!(matches!(
panel.commit_editor.read(cx).mode().clone(),
EditorMode::AutoHeight { .. }
));
panel.toggle_fill_commit_editor(&ToggleFillCommitEditor, window, cx);
assert!(panel.commit_editor_expanded);
assert!(matches!(
panel.commit_editor.read(cx).mode().clone(),
EditorMode::Full { .. }
));
panel.toggle_fill_commit_editor(&ToggleFillCommitEditor, window, cx);
assert!(!panel.commit_editor_expanded);
assert!(matches!(
panel.commit_editor.read(cx).mode().clone(),
EditorMode::AutoHeight { .. }
));
});
}
}