Skip to content

Add git update-ref completions #286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SkyNotSilent wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add git update-ref completions #286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 85 additions & 0 deletions command-signatures/json/git.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6602,6 +6602,91 @@
]
}
},
{
"name": "update-ref",
"description": "Update the object name stored in a ref safely",
"options": [
{
"name": "-m",
"description": "Record the reason for the update in the ref log",
"args": {
"name": "reason"
}
},
{
"name": "-d",
"description": "Delete the named ref after verifying the old value"
},
{
"name": "--no-deref",
"description": "Update the ref itself instead of the one it points to"
},
{
"name": "--deref",
"description": "Follow symbolic refs before updating"
},
{
"name": "-z",
"description": "Read NUL-terminated arguments from stdin"
},
{
"name": [
"--stdin",
"--no-stdin"
],
"description": "Read updates from stdin"
},
{
"name": [
"--create-reflog",
"--no-create-reflog"
],
"description": "Create a reflog for the ref"
},
{
"name": [
"-0",
"--batch-updates",
"--no-batch-updates"
],
"description": "Batch reference updates"
}
],
"args": [
{
"name": "ref",
"description": "Reference to update",
"generatorName": "refs",
"suggestions": [
"HEAD"
]
},
{
"name": "new-value",
"description": "New object name or reference",
"isOptional": true,
"generatorName": [
"refs",
"commits"
],
"suggestions": [
"HEAD"
]
},
{
"name": "old-value",
"description": "Expected old object name or reference",
"isOptional": true,
"generatorName": [
"refs",
"commits"
],
"suggestions": [
"HEAD"
]
}
]
},
{
"name": "branch",
"description": "List, create, or delete branches",
Expand Down
58 changes: 57 additions & 1 deletion command-signatures/src/generators/git.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,10 +539,25 @@ fn tags_command() -> CommandBuilder {
CommandBuilder::single_command("git --no-optional-locks tag --list --sort=-creatordate")
}

fn refs_command() -> CommandBuilder {
CommandBuilder::single_command(
r#"git --no-optional-locks for-each-ref --format="%(refname)" --sort="refname" "refs/**""#,
)
}

pub fn local_branches_generator() -> Generator {
Generator::script(local_branches_command(), post_process_branches)
}

fn post_process_refs(output: &str) -> GeneratorResults {
output
.lines()
.unique()
.filter(|line| !line.is_empty())
.map(|line| Suggestion::with_description(line.trim(), "Ref").with_icon(IconType::GitBranch))
.collect_ordered_results()
}

fn post_process_tags(output: &str) -> GeneratorResults {
output
.lines()
Expand Down Expand Up @@ -806,6 +821,7 @@ pub fn generator() -> CommandSignatureGenerators {
post_process_git_for_each_ref,
),
)
.add_generator("refs", Generator::script(refs_command(), post_process_refs))
.add_generator("local_branches", local_branches_generator())
.add_generator(
"remotes",
Expand Down Expand Up @@ -961,7 +977,8 @@ mod tests {
use crate::generators::git::{
detect_refspec_prefix, files_for_staging_command, post_process_branches,
post_process_files_for_staging, post_process_push_refspec_branches,
post_process_push_refspec_tags, post_process_tags, post_process_tracked_files,
post_process_push_refspec_tags, post_process_refs, post_process_tags,
post_process_tracked_files,
};
use warp_completion_metadata::{
GeneratorResults, IconType, Importance, Order, Priority, Shell, Suggestion,
Expand Down Expand Up @@ -1195,6 +1212,45 @@ mod tests {
assert_eq!(post_process_tags(command_output).suggestions.len(), 2);
}

#[test]
fn test_post_process_refs() {
let command_output =
"refs/heads/main\nrefs/remotes/origin/main\n\nrefs/tags/v1.0.0\nrefs/heads/main\n";

assert_eq!(
post_process_refs(command_output),
GeneratorResults {
suggestions: vec![
Suggestion {
exact_string: "refs/heads/main".to_owned(),
display_name: None,
description: Some("Ref".to_owned()),
priority: Priority::Default,
icon: Some(IconType::GitBranch),
is_hidden: false,
},
Suggestion {
exact_string: "refs/remotes/origin/main".to_owned(),
display_name: None,
description: Some("Ref".to_owned()),
priority: Priority::Default,
icon: Some(IconType::GitBranch),
is_hidden: false,
},
Suggestion {
exact_string: "refs/tags/v1.0.0".to_owned(),
display_name: None,
description: Some("Ref".to_owned()),
priority: Priority::Default,
icon: Some(IconType::GitBranch),
is_hidden: false,
},
],
is_ordered: true,
}
);
}

#[test]
fn test_detect_refspec_prefix() {
assert_eq!(
Expand Down
Loading