extern/starship
1
0
Fork 0
mirror of https://github.com/starship/starship.git synced 2024-12-23 23:58:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat: Add config for ahead/behind count of tracked branch (#281)

Browse Source 
Add a configuration option (show_sync_count) to the git_status module that will show/hide the counts ahead/behind of the tracked branch. Currently have this default to false, and would opt-in to show this information.
This commit is contained in:
Neil Kistner 2019-09-04 23:09:51 -05:00 committed by Matan Kushner
parent c5e693b638
commit 1c66869117
3 changed files with 144 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/config/README.md
View File

@ -237,19 +237,20 @@ current directory.
### Options
| Variable | Default | Description |
| ------------ | ------- | ------------------------------------------------------- |
| `conflicted` | `"="` | This branch has merge conflicts. |
| `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. |
| `behind` | `"⇣"` | This branch is behind of the branch being tracked. |
| `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. |
| `untracked` | `"?"` | There are untracked files in the working directory. |
| `stashed` | `"$"` | A stash exists for the local repository. |
| `modified` | `"!"` | There are file modifications in the working directory. |
| `staged` | `"+"` | A new file has been added to the staging area. |
| `renamed` | `"»"` | A renamed file has been added to the staging area. |
| `deleted` | `"✘"` | A file's deletion has been added to the staging area. |
| `disabled` | `false` | Disables the `git_status` module. |
| Variable | Default | Description |
| ----------------- | ------- | ------------------------------------------------------- |
| `conflicted` | `"="` | This branch has merge conflicts. |
| `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. |
| `behind` | `"⇣"` | This branch is behind of the branch being tracked. |
| `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. |
| `untracked` | `"?"` | There are untracked files in the working directory. |
| `stashed` | `"$"` | A stash exists for the local repository. |
| `modified` | `"!"` | There are file modifications in the working directory. |
| `staged` | `"+"` | A new file has been added to the staging area. |
| `renamed` | `"»"` | A renamed file has been added to the staging area. |
| `deleted` | `"✘"` | A file's deletion has been added to the staging area. |
| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. |
| `disabled` | `false` | Disables the `git_status` module. |
### Example

39
src/modules/git_status.rs
View File

@ -36,6 +36,9 @@ pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
let module_style = Color::Red.bold();
let mut module = context.new_module("git_status")?;
let show_sync_count = module.config_value_bool("show_sync_count").unwrap_or(false);
module.get_prefix().set_value("[").set_style(module_style);
module.get_suffix().set_value("] ").set_style(module_style);
module.set_style(module_style);
@ -66,17 +69,37 @@ pub fn module<'a>(context: &'a Context) -> Option<Module<'a>> {
// Add the ahead/behind segment
if let Ok((ahead, behind)) = ahead_behind {
let ahead_segment = format!("{}{}", GIT_STATUS_AHEAD, ahead);
let behind_segment = format!("{}{}", GIT_STATUS_BEHIND, behind);
let add_ahead = |m: &mut Module<'a>| {
m.new_segment("ahead", GIT_STATUS_AHEAD);
if show_sync_count {
m.new_segment("ahead_count", &ahead.to_string());
}
};
let add_behind = |m: &mut Module<'a>| {
m.new_segment("behind", GIT_STATUS_BEHIND);
if show_sync_count {
m.new_segment("behind_count", &behind.to_string());
}
};
if ahead > 0 && behind > 0 {
module.new_segment("diverged", GIT_STATUS_DIVERGED);
module.new_segment("ahead", ahead_segment.as_str());
module.new_segment("behind", behind_segment.as_str());
} else if ahead > 0 {
module.new_segment("ahead", ahead_segment.as_str());
} else if behind > 0 {
module.new_segment("behind", behind_segment.as_str());
if show_sync_count {
add_ahead(&mut module);
add_behind(&mut module);
}
}
if ahead > 0 && behind == 0 {
add_ahead(&mut module);
}
if behind > 0 && ahead == 0 {
add_behind(&mut module);
}
}

102
tests/testsuite/git_status.rs
View File

@ -5,11 +5,11 @@ use std::fs::{self, File};
use std::io;
use std::process::Command;
use crate::common;
use crate::common::{self, TestCommand};
#[test]
#[ignore]
fn shows_behind_count() -> io::Result<()> {
fn shows_behind() -> io::Result<()> {
let fixture_repo_dir = common::create_fixture_repo()?;
let repo_dir = common::new_tempdir()?.path().join("rocket");
@ -25,6 +25,35 @@ fn shows_behind_count() -> io::Result<()> {
.arg(repo_dir)
.output()?;
let actual = String::from_utf8(output.stdout).unwrap();
let expected = Color::Red.bold().paint(format!("[{}] ", "⇣")).to_string();
assert_eq!(expected, actual);
Ok(())
}
#[test]
#[ignore]
fn shows_behind_with_count() -> io::Result<()> {
let fixture_repo_dir = common::create_fixture_repo()?;
let repo_dir = common::new_tempdir()?.path().join("rocket");
Repository::clone(fixture_repo_dir.to_str().unwrap(), &repo_dir.as_path()).unwrap();
Command::new("git")
.args(&["reset", "--hard", "HEAD^"])
.current_dir(repo_dir.as_path())
.output()?;
let output = common::render_module("git_status")
.use_config(toml::toml! {
[git_status]
show_sync_count = true
})
.arg("--path")
.arg(repo_dir)
.output()?;
let actual = String::from_utf8(output.stdout).unwrap();
let expected = Color::Red
.bold()
.paint(format!("[{}] ", "⇣1"))
@ -37,7 +66,7 @@ fn shows_behind_count() -> io::Result<()> {
#[test]
#[ignore]
fn shows_ahead_count() -> io::Result<()> {
fn shows_ahead() -> io::Result<()> {
let fixture_repo_dir = common::create_fixture_repo()?;
let repo_dir = common::new_tempdir()?.path().join("rocket");
@ -55,6 +84,37 @@ fn shows_ahead_count() -> io::Result<()> {
.arg(repo_dir)
.output()?;
let actual = String::from_utf8(output.stdout).unwrap();
let expected = Color::Red.bold().paint(format!("[{}] ", "⇡")).to_string();
assert_eq!(expected, actual);
Ok(())
}
#[test]
#[ignore]
fn shows_ahead_with_count() -> io::Result<()> {
let fixture_repo_dir = common::create_fixture_repo()?;
let repo_dir = common::new_tempdir()?.path().join("rocket");
Repository::clone(fixture_repo_dir.to_str().unwrap(), &repo_dir.as_path()).unwrap();
File::create(repo_dir.join("readme.md"))?;
Command::new("git")
.args(&["commit", "-am", "Update readme"])
.current_dir(&repo_dir)
.output()?;
let output = common::render_module("git_status")
.use_config(toml::toml! {
[git_status]
show_sync_count = true
})
.arg("--path")
.arg(repo_dir)
.output()?;
let actual = String::from_utf8(output.stdout).unwrap();
let expected = Color::Red
.bold()
.paint(format!("[{}] ", "⇡1"))
@ -90,6 +150,42 @@ fn shows_diverged() -> io::Result<()> {
.arg(repo_dir)
.output()?;
let actual = String::from_utf8(output.stdout).unwrap();
let expected = Color::Red.bold().paint(format!("[{}] ", "⇕")).to_string();
assert_eq!(expected, actual);
Ok(())
}
#[test]
#[ignore]
fn shows_diverged_with_count() -> io::Result<()> {
let fixture_repo_dir = common::create_fixture_repo()?;
let repo_dir = common::new_tempdir()?.path().join("rocket");
Repository::clone(fixture_repo_dir.to_str().unwrap(), &repo_dir.as_path()).unwrap();
Command::new("git")
.args(&["reset", "--hard", "HEAD^"])
.current_dir(repo_dir.as_path())
.output()?;
fs::write(repo_dir.join("Cargo.toml"), " ")?;
Command::new("git")
.args(&["commit", "-am", "Update readme"])
.current_dir(repo_dir.as_path())
.output()?;
let output = common::render_module("git_status")
.use_config(toml::toml! {
[git_status]
show_sync_count = true
})
.arg("--path")
.arg(repo_dir)
.output()?;
let actual = String::from_utf8(output.stdout).unwrap();
let expected = Color::Red
.bold()
.paint(format!("[{}] ", "⇕⇡1⇣1"))