Skip to content

Improve gh fig spec #263262

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

Merged
merged 3 commits into from
Aug 25, 2025
Merged

Improve gh fig spec #263262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4600226
Fork gh spec into vscode
Tyriar Aug 25, 2025
7642e8d
Pull in gh updates from withfig/autocomplete#2600
Tyriar Aug 25, 2025
72a0301
Add PR icons and support display name
Tyriar Aug 25, 2025
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
244 changes: 209 additions & 35 deletions ...al-suggest/src/completions/upstream/gh.ts → ...ns/terminal-suggest/src/completions/gh.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
import { filepaths } from '../../helpers/filepaths'; import { keyValue } from '../../helpers/keyvalue';
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/

/* eslint-disable local/code-no-unexternalized-strings */

import * as vscode from 'vscode';
import { filepaths } from '../helpers/filepaths';
import { keyValue } from '../helpers/keyvalue';

const filterMessages = (out: string): string => {
return out.startsWith("warning:") || out.startsWith("error:")
Expand Down Expand Up @@ -29,6 +38,7 @@ const postProcessRemoteBranches: Fig.Generator["postProcess"] = (out) => {
name: elm.replace("*", "").trim(),
description: "Current branch",
priority: 100,
// allow-any-unicode-next-line
icon: "⭐️",
};
} else if (parts[0] === "+") {
Expand All @@ -40,7 +50,7 @@ const postProcessRemoteBranches: Fig.Generator["postProcess"] = (out) => {
return {
name,
description: "Branch",
icon: "vscode://icon?type=11",
icon: `vscode://icon?type=${vscode.TerminalCompletionItemKind.Branch}`,
priority: 75,
};
});
Expand All @@ -56,6 +66,7 @@ const listRepoMapFunction = (repo: RepoDataType) => ({
name: repo.nameWithOwner,
description: repo.description ?? undefined,
//be able to see if the repo is private at a glance
// allow-any-unicode-next-line
icon: repo.isPrivate ? "🔒" : "👀",
});

Expand All @@ -68,7 +79,9 @@ const ghGenerators: Record<string, Fig.Generator> = {
const last = tokens.pop();

//gatekeeper
if (!last) return [];
if (!last) {
return [];
}

/**
* this turns this input:
Expand All @@ -80,13 +93,17 @@ const ghGenerators: Record<string, Fig.Generator> = {
const userRepoSplit = last.split("/");

// make sure it has some length.
if (userRepoSplit.length === 0) return [];
if (userRepoSplit.length === 0) {
return [];
}

//get first element of arr
const userOrOrg = userRepoSplit.shift();

// make sure it has some existence.
if (!userOrOrg) return [];
if (!userOrOrg) {
return [];
}

//run `gh repo list` cmd
const { stdout, status } = await execute({
Expand All @@ -103,7 +120,9 @@ const ghGenerators: Record<string, Fig.Generator> = {
});

// make sure it has some existence.
if (status !== 0) return [];
if (status !== 0) {
return [];
}

//parse the JSON string output of the command
const repoArr: RepoDataType[] = JSON.parse(stdout);
Expand Down Expand Up @@ -171,7 +190,7 @@ const ghGenerators: Record<string, Fig.Generator> = {
name: number.toString(),
displayName: title,
description: `#${number} | ${headRefName}`,
icon: state === "OPEN" ? "✅" : "☑️",
icon: `vscode://icon?type=${state === "OPEN" ? vscode.TerminalCompletionItemKind.PullRequest : vscode.TerminalCompletionItemKind.PullRequestDone}`,
};
});
},
Expand Down Expand Up @@ -319,27 +338,124 @@ const completionSpec: Fig.Spec = {
],
},
],
}, {
name: "api",
description: "Make an authenticated GitHub API request",
args: {
name: "<endpoint> [flags]a",
},
options: [
{
name: "--cache",
description: 'Cache the response, e.g. "3600s", "60m", "1h"',
args: { name: "duration" },
},
{
name: ["-F", "--field"],
description: "Add a typed parameter in key=value format",
args: { name: "key:value" },
},
{
name: "--hostname",
description:
'The GitHub hostname for the request (default "github.com")',
args: {
name: "string",
},
},
{
name: ["-i", "--include"],
description:
"Include HTTP response status line and headers in the output",
},
{
name: "--input",
description:
'The file to use as body for the HTTP request (use "-" to read from standard input)',
args: { name: "file" },
},
{
name: ["-q", "--jq"],
description:
"Query to select values from the response using jq syntax",
args: { name: "string" },
},
{
name: ["-X", "--method"],
description: "The HTTP method for the request",
args: { name: "string", description: '(default "GET")' },
},
{
name: "--paginate",
description:
"Make additional HTTP requests to fetch all pages of results",
},
{
name: ["-p", "--preview"],
description:
'GitHub API preview names to request (without the "-preview" suffix)',
args: { name: "names" },
},
{
name: ["-f", "--raw-field"],
description: "Add a string parameter in key=value format",
args: { name: "key=value" },
},
{
name: "--silent",
description: "Do not print the response body",
},
{
name: "--slurp",
description:
'Use with "--paginate" to return an array of all pages of either JSON arrays or objects',
},
{
name: ["-t", "--template"],
description:
'Format JSON output using a Go template; see "gh help formatting"',
args: { name: "string" },
},
{
name: "--verbose",
description: "Include full HTTP request and response in the output",
},
],
},
{ name: "api", description: "Make an authenticated GitHub API request" },
{
name: "auth",
description: "Login, logout, and refresh your authentication",
description: "Authenticate gh and git with GitHub",

subcommands: [
{
name: "login",
description: "Authenticate with a GitHub host",
description: "Gh auth login [flags]",
options: [
{
name: ["-p", "--git-protocol"],
description:
"The protocol to use for git operations on this host: {ssh|https}",
args: { name: "string" },
},
{
name: ["-h", "--hostname"],
description:
"The hostname of the GitHub instance to authenticate with",
args: { name: "hostname" },
args: { name: "string" },
},
{
name: "--insecure-storage",
description:
"Save authentication credentials in plain text instead of credential store",
},
{
name: ["-s", "--scopes"],
description: "Additional authentication scopes for gh to have",
args: { name: "scopes" },
description: "Additional authentication scopes to request",
args: { name: "strings" },
},
{
name: "--skip-ssh-key",
description: "Skip generate/upload SSH key prompt",
},
{
name: ["-w", "--web"],
Expand All @@ -348,65 +464,123 @@ const completionSpec: Fig.Spec = {
{
name: "--with-token",
description: "Read token from standard input",
args: { name: "token" },
},
],
},
{
name: "logout",
description: "Log out of a GitHub host",
description: "Gh auth logout [flags]",
options: [
{
name: ["-h", "--hostname"],
description:
"The hostname of the GitHub instance to authenticate with",
args: { name: "hostname" },
description: "The hostname of the GitHub instance to log out of",
args: { name: "string" },
},
{
name: ["-u", "--user"],
description: "The account to log out of",
args: { name: "string" },
},
],
},
{
name: "refresh",
description: "Refresh stored authentication credentials",
description: "Gh auth refresh [flags]",
options: [
{
name: ["-h", "--hostname"],
description: "The GitHub host to use for authentication",
args: { name: "string" },
},
{
name: "--insecure-storage",
description:
"The hostname of the GitHub instance to authenticate with",
args: { name: "hostname" },
"Save authentication credentials in plain text instead of credential store",
},
{
name: ["-r", "--remove-scopes"],
description: "Authentication scopes to remove from gh",
args: { name: "strings" },
},
{
name: "--reset-scopes",
description:
"Reset authentication scopes to the default minimum set of scopes",
},
{
name: ["-s", "--scopes"],
description: "Additional authentication scopes for gh to have",
args: { name: "scopes" },
args: { name: "strings" },
},
],
},
{
name: "setup-git",
description: "Configure git to use GitHub CLI as a credential helper",
description: "Gh auth setup-git [flags]",
options: [
{
name: ["-h", "--hostname"],
name: ["-f", "--force"],
description:
"The hostname of the GitHub instance to authenticate with",
args: { name: "hostname" },
"Force setup even if the host is not known. Must be used in conjunction with --hostname",
args: { name: "--hostname" },
},
{
name: ["-h", "--hostname"],
description: "The hostname to configure git for",
args: { name: "string" },
},
],
},
{
name: "status",
description: "View authentication status",
options: [
{
name: ["-a", "--active"],
description: "Display the active account only",
},
{
name: ["-h", "--hostname"],
description: "Check only a specific hostname's auth status",
args: { name: "string" },
},
{
name: ["-t", "--show-token"],
description: "Display the auth token",
},
],
},
{
name: "switch",
description: "Switch the active account for a GitHub host",
options: [
{
name: ["-h", "--hostname"],
description:
"The hostname of the GitHub instance to authenticate with",
args: { name: "hostname" },
"The hostname of the GitHub instance to switch account for",
args: { name: "string" },
},
{
name: "--with-token",
description: "Read token from standard input",
args: { name: "token" },
name: ["-u", "--user"],
description: "The account to switch to",
args: { name: "string" },
},
],
},
{
name: "token",
description: "Gh auth token [flags]",
options: [
{
name: ["-h", "--hostname"],
description:
"The hostname of the GitHub instance authenticated with",
args: { name: "string" },
},
{
name: ["-u", "--user"],
description: "The account to output the token for",
args: { name: "string" },
},
],
},
Expand Down Expand Up @@ -1574,8 +1748,8 @@ Pass additional 'git clone' flags by listing them after '--'`,
To create a repository interactively, use 'gh repo create' with no arguments.
To create a remote repository non-interactively, supply the repository name and one of '--public', '--private', or '--internal'.
Pass '--clone' to clone the new repository locally.
To create a remote repository from an existing local repository, specify the source directory with '--source'.
By default, the remote repository name will be the name of the source directory.
To create a remote repository from an existing local repository, specify the source directory with '--source'.
By default, the remote repository name will be the name of the source directory.
Pass '--push' to push any local commits to the new repository`,
args: {
name: "name",
Expand Down Expand Up @@ -1726,7 +1900,7 @@ Pass '--push' to push any local commits to the new repository`,
name: "delete",
description: `Delete a GitHub repository.
With no argument, deletes the current repository. Otherwise, deletes the specified repository.
Deletion requires authorization with the "delete_repo" scope.
Deletion requires authorization with the "delete_repo" scope.
To authorize, run "gh auth refresh -s delete_repo"`,
isDangerous: true,
args: {
Expand Down Expand Up @@ -2003,7 +2177,7 @@ By default, this renames the current repository; otherwise renames the specified
of the source repository to update the matching branch on the destination
repository so they are equal. A fast forward update will be used execept when the
'--force' flag is specified, then the two branches will
by synced using a hard reset.
by synced using a hard reset.
Without an argument, the local repository is selected as the destination repository.
The source repository is the parent of the destination repository by default.
This can be overridden with the '--source' flag`,
Expand Down
Loading
Loading