pub mod blame; pub mod commit; mod hosting_provider; mod remote; pub mod repository; pub mod stash; pub mod status; pub use crate::hosting_provider::*; pub use crate::remote::*; use anyhow::Result; use gpui::{Action, actions}; pub use repository::RemoteCommandOutput; use schemars::JsonSchema; use serde::{Deserialize, Serialize}; use std::fmt::{self, Write as _}; use std::str::FromStr; pub const DOT_GIT: &str = ".git"; pub const GITIGNORE: &str = ".gitignore"; pub const FSMONITOR_DAEMON: &str = "fsmonitor--daemon"; pub const LFS_DIR: &str = "lfs"; pub const OBJECTS_DIR: &str = "objects"; pub const REFS_DIR: &str = "refs"; pub const REFTABLE_DIR: &str = "reftable"; pub const HOOKS_DIR: &str = "hooks"; pub const LOGS_DIR: &str = "logs"; pub const LOGS_REF_STASH: &str = "logs/refs/stash"; pub const REBASE_MERGE_DIR: &str = "rebase-merge"; pub const REBASE_APPLY_DIR: &str = "rebase-apply"; pub const SEQUENCER_DIR: &str = "sequencer"; pub const COMMIT_MESSAGE: &str = "COMMIT_EDITMSG"; pub const FETCH_HEAD: &str = "FETCH_HEAD"; pub const ORIG_HEAD: &str = "ORIG_HEAD"; pub const BISECT_LOG: &str = "BISECT_LOG"; pub const GC_PID: &str = "gc.pid"; pub const INFO_DIR: &str = "info"; pub const REPO_EXCLUDE: &str = "info/exclude"; actions!( git, [ // per-hunk /// Toggles the staged state of the hunk or status entry at cursor. ToggleStaged, /// Stage status entries between an anchor entry and the cursor. StageRange, /// Stages the current hunk and moves to the next one. StageAndNext, /// Unstages the current hunk and moves to the next one. UnstageAndNext, /// Restores the selected hunks to their original state. #[action(deprecated_aliases = ["editor::RevertSelectedHunks"])] Restore, /// Restores the selected hunks to their original state and moves to the /// next one. RestoreAndNext, // per-file /// Shows git blame information for the current file. #[action(deprecated_aliases = ["editor::ToggleGitBlame"])] Blame, /// Shows the git history for the selected file, folder, or project. FileHistory, /// Opens a permalink for the selected file on its Git hosting provider. OpenFilePermalink, /// Copies a permalink for the selected file on its Git hosting provider. CopyFilePermalink, /// Opens the selected file in the editor without a diff view. ViewFile, /// Stages the current file. StageFile, /// Unstages the current file. UnstageFile, // per-section /// Stages every entry in the section containing the selected entry. StageSection, /// Unstages every entry in the section containing the selected entry. UnstageSection, // repo-wide /// Stages all changes in the repository. StageAll, /// Unstages all changes in the repository. UnstageAll, /// Stashes all changes in the repository, including untracked files. StashAll, /// Stashes tracked changes in the repository, leaving untracked files in place. StashTracked, /// Stashes staged changes in the repository, leaving unstaged changes in place. StashStaged, /// Pops the most recent stash. StashPop, /// Apply the most recent stash. StashApply, /// Restores all tracked files to their last committed state. RestoreTrackedFiles, /// Moves all untracked files to trash. TrashUntrackedFiles, /// Undoes the last commit, keeping changes in the working directory. Uncommit, /// Pushes commits to the remote repository. Push, /// Pushes commits to a specific remote branch. PushTo, /// Force pushes commits to the remote repository. ForcePush, /// Pulls changes from the remote repository. Pull, /// Pulls changes from the remote repository with rebase. PullRebase, /// Fetches changes from the remote repository. Fetch, /// Fetches changes from a specific remote. FetchFrom, /// Creates a new commit with staged changes. Commit, /// Runs the next commit with `git commit --no-verify`. SkipHooks, /// Amends the last commit with staged changes. Amend, /// Enable the --signoff option. Signoff, /// Cancels the current git operation. Cancel, /// Expands the commit message editor. ExpandCommitEditor, /// Toggles whether the commit message editor fills all the available /// vertical space within the git panel. ToggleFillCommitEditor, /// Generates a commit message using AI. GenerateCommitMessage, /// Initializes a new git repository. Init, /// Opens all modified files in the editor. OpenModifiedFiles, /// Opens the current file in a solo diff view. OpenFileDiff, /// Clones a repository. Clone, ViewCommit, /// Adds a file to .gitignore. AddToGitignore, /// Adds a file to the repository's .git/info/exclude. AddToGitInfoExclude, /// Copies the current branch name to the clipboard. CopyBranchName, ] ); /// Renames a git branch. #[derive(Clone, Debug, Default, PartialEq, Deserialize, JsonSchema, Action)] #[action(namespace = git)] #[serde(deny_unknown_fields)] pub struct RenameBranch { /// The branch to rename. /// /// Default: the current branch. #[serde(default)] pub branch: Option, } /// Restores a file to its last committed state, discarding local changes. #[derive(Clone, Debug, Default, PartialEq, Deserialize, JsonSchema, Action)] #[action(namespace = git, deprecated_aliases = ["editor::RevertFile"])] #[serde(deny_unknown_fields)] pub struct RestoreFile { #[serde(default)] pub skip_prompt: bool, } /// The length of a Git short SHA. pub const SHORT_SHA_LENGTH: usize = 7; const SHA1_BYTE_LENGTH: usize = 20; const SHA256_BYTE_LENGTH: usize = 32; const SHA1_HEX_LENGTH: usize = SHA1_BYTE_LENGTH * 2; const SHA256_HEX_LENGTH: usize = SHA256_BYTE_LENGTH * 2; const HEX_DIGITS: &[u8; 16] = b"0123456789abcdef"; #[derive(Clone, Copy, Eq, Hash, PartialEq)] pub struct Oid { bytes: [u8; SHA256_BYTE_LENGTH], format: OidFormat, } #[derive(Clone, Copy, Eq, Hash, PartialEq)] enum OidFormat { Sha1, Sha256, } impl OidFormat { fn byte_len(self) -> usize { match self { Self::Sha1 => SHA1_BYTE_LENGTH, Self::Sha256 => SHA256_BYTE_LENGTH, } } fn hex_len(self) -> usize { match self { Self::Sha1 => SHA1_HEX_LENGTH, Self::Sha256 => SHA256_HEX_LENGTH, } } } impl Oid { pub fn from_bytes(bytes: &[u8]) -> Result { let format = match bytes.len() { SHA1_BYTE_LENGTH => OidFormat::Sha1, SHA256_BYTE_LENGTH => OidFormat::Sha256, len => { anyhow::bail!( "invalid git oid byte length: expected {SHA1_BYTE_LENGTH} for SHA-1 or {SHA256_BYTE_LENGTH} for SHA-256, got {len}" ); } }; let mut oid_bytes = [0u8; SHA256_BYTE_LENGTH]; oid_bytes[..bytes.len()].copy_from_slice(bytes); Ok(Self { bytes: oid_bytes, format, }) } #[cfg(any(test, feature = "test-support"))] pub fn random(rng: &mut impl rand::Rng) -> Self { let mut bytes = [0u8; SHA256_BYTE_LENGTH]; rng.fill(&mut bytes[..SHA1_BYTE_LENGTH]); Self { bytes, format: OidFormat::Sha1, } } pub fn as_bytes(&self) -> &[u8] { &self.bytes[..self.format.byte_len()] } pub fn is_zero(&self) -> bool { self.as_bytes().iter().all(|byte| *byte == 0) } /// Returns this [`Oid`] as a short SHA. pub fn display_short(&self) -> String { self.hex_string(SHORT_SHA_LENGTH) } fn hex_string(&self, len: usize) -> String { let mut string = String::with_capacity(len); for index in 0..len { string.push(self.hex_digit(index)); } string } fn write_hex(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { for index in 0..self.format.hex_len() { f.write_char(self.hex_digit(index))?; } Ok(()) } #[inline(always)] fn hex_digit(&self, index: usize) -> char { debug_assert!(index < self.format.hex_len()); let byte = self.as_bytes()[index / 2]; let nibble = if index & 1 == 0 { byte >> 4 } else { byte & 0x0f }; char::from(HEX_DIGITS[nibble as usize]) } } impl TryFrom<&str> for Oid { type Error = anyhow::Error; fn try_from(value: &str) -> std::result::Result { Oid::from_str(value) } } impl FromStr for Oid { type Err = anyhow::Error; fn from_str(s: &str) -> std::result::Result { let format = match s.len() { 1..=SHA1_HEX_LENGTH => OidFormat::Sha1, SHA256_HEX_LENGTH => OidFormat::Sha256, len => { anyhow::bail!( "invalid git oid hex length: expected 1..={SHA1_HEX_LENGTH} for SHA-1 or {SHA256_HEX_LENGTH} for SHA-256, got {len}" ); } }; let mut bytes = [0u8; SHA256_BYTE_LENGTH]; for (index, byte) in s.bytes().enumerate() { let digit = decode_hex_digit(byte) .ok_or_else(|| anyhow::anyhow!("invalid hex digit at byte {index} for git oid"))?; if index % 2 == 0 { bytes[index / 2] = digit << 4; } else { bytes[index / 2] |= digit; } } Ok(Self { bytes, format }) } } fn decode_hex_digit(byte: u8) -> Option { match byte { b'0'..=b'9' => Some(byte - b'0'), b'a'..=b'f' => Some(byte - b'a' + 10), b'A'..=b'F' => Some(byte - b'A' + 10), _ => None, } } impl fmt::Debug for Oid { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { fmt::Display::fmt(self, f) } } impl fmt::Display for Oid { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { self.write_hex(f) } } impl Serialize for Oid { fn serialize(&self, serializer: S) -> std::result::Result where S: serde::Serializer, { serializer.serialize_str(&self.hex_string(self.format.hex_len())) } } impl<'de> Deserialize<'de> for Oid { fn deserialize(deserializer: D) -> std::result::Result where D: serde::Deserializer<'de>, { let s = String::deserialize(deserializer)?; s.parse::().map_err(serde::de::Error::custom) } } impl From for u32 { fn from(oid: Oid) -> Self { let mut u32_bytes = [0u8; 4]; u32_bytes.copy_from_slice(&oid.as_bytes()[..4]); u32::from_ne_bytes(u32_bytes) } } impl From for usize { fn from(oid: Oid) -> Self { let mut u64_bytes = [0u8; 8]; u64_bytes.copy_from_slice(&oid.as_bytes()[..8]); u64::from_ne_bytes(u64_bytes) as usize } } #[cfg(test)] mod tests { use super::*; #[test] fn parses_short_sha1_oid_by_padding_trailing_nibbles() { let oid = "abc1234".parse::().expect("failed to parse oid"); assert_eq!(oid.as_bytes().len(), SHA1_BYTE_LENGTH); assert_eq!(oid.display_short(), "abc1234"); assert_eq!(oid.to_string(), "abc1234000000000000000000000000000000000"); } #[test] fn parses_full_sha256_oid() { let sha = "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"; let oid = sha.parse::().expect("failed to parse oid"); assert_eq!(oid.as_bytes().len(), SHA256_BYTE_LENGTH); assert_eq!(oid.to_string(), sha); } #[test] fn rejects_invalid_oid_lengths() { assert!("".parse::().is_err()); assert!("a".repeat(SHA1_HEX_LENGTH + 1).parse::().is_err()); assert!("a".repeat(SHA256_HEX_LENGTH - 1).parse::().is_err()); } } #[repr(i32)] #[derive(Copy, Clone, Debug)] pub enum RunHook { PreCommit, } impl RunHook { pub fn as_str(&self) -> &str { match self { Self::PreCommit => "pre-commit", } } pub fn to_proto(&self) -> i32 { *self as i32 } pub fn from_proto(value: i32) -> Option { match value { 0 => Some(Self::PreCommit), _ => None, } } }