feat(KB-052): refactor GitHub integration to use gh CLI
- Create gh-cli utility module with auth detection and command execution - Refactor GitHubClient to use gh CLI commands with REST API fallback - Refactor PR Monitor to use gh CLI for PR operations - Add listIssues() and getIssue() methods to GitHubClient - Remove in-app GitHubRateLimiter (gh CLI handles rate limiting) - Update all tests for gh CLI implementation - Update AGENTS.md and extension docs for gh CLI auth preference
This commit is contained in:
206
packages/core/src/gh-cli.ts
Normal file
206
packages/core/src/gh-cli.ts
Normal file
@@ -0,0 +1,206 @@
|
||||
import { execFileSync, execFile } from "node:child_process";
|
||||
import type { ExecFileException } from "node:child_process";
|
||||
|
||||
export interface GhError extends Error {
|
||||
code: string | number | null;
|
||||
stderr: string;
|
||||
stdout: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the `gh` CLI is installed and available.
|
||||
*/
|
||||
export function isGhAvailable(): boolean {
|
||||
try {
|
||||
execFileSync("gh", ["--version"], {
|
||||
encoding: "utf-8",
|
||||
stdio: ["pipe", "pipe", "ignore"],
|
||||
});
|
||||
return true;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the `gh` CLI is authenticated with GitHub.
|
||||
* Returns true if authenticated, false if not.
|
||||
*/
|
||||
export function isGhAuthenticated(): boolean {
|
||||
try {
|
||||
const result = execFileSync("gh", ["auth", "status"], {
|
||||
encoding: "utf-8",
|
||||
stdio: ["pipe", "pipe", "ignore"],
|
||||
});
|
||||
// gh auth status returns 0 and outputs "Logged in" if authenticated
|
||||
return result.includes("Logged in") || result.includes("Authenticated");
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute a gh CLI command synchronously.
|
||||
* Throws GhError on failure with parsed error details.
|
||||
*/
|
||||
export function runGh(args: string[], cwd?: string): string {
|
||||
try {
|
||||
const result = execFileSync("gh", args, {
|
||||
encoding: "utf-8",
|
||||
stdio: ["pipe", "pipe", "pipe"],
|
||||
cwd,
|
||||
});
|
||||
return result;
|
||||
} catch (err: unknown) {
|
||||
const execErr = err as ExecFileException & { stdout?: Buffer | string; stderr?: Buffer | string };
|
||||
const error = new Error(`gh command failed: ${execErr.message}`) as GhError;
|
||||
error.code = execErr.code ?? null;
|
||||
error.stdout = execErr.stdout?.toString() ?? "";
|
||||
error.stderr = execErr.stderr?.toString() ?? "";
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute a gh CLI command asynchronously.
|
||||
* Returns a promise that resolves with the output or rejects with GhError.
|
||||
*/
|
||||
export function runGhAsync(args: string[], cwd?: string): Promise<string> {
|
||||
return new Promise((resolve, reject) => {
|
||||
execFile(
|
||||
"gh",
|
||||
args,
|
||||
{
|
||||
encoding: "utf-8",
|
||||
cwd,
|
||||
},
|
||||
(error, stdout, stderr) => {
|
||||
if (error) {
|
||||
const ghError = new Error(`gh command failed: ${error.message}`) as GhError;
|
||||
ghError.code = error.code ?? null;
|
||||
ghError.stdout = stdout ?? "";
|
||||
ghError.stderr = stderr ?? "";
|
||||
reject(ghError);
|
||||
} else {
|
||||
resolve(stdout ?? "");
|
||||
}
|
||||
}
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute a gh CLI command and parse the JSON output.
|
||||
* Requires the command to support --json flag.
|
||||
*/
|
||||
export function runGhJson<T>(args: string[], cwd?: string): T {
|
||||
const jsonArgs = args.includes("--json") ? args : [...args, "--json"];
|
||||
const output = runGh(jsonArgs, cwd);
|
||||
try {
|
||||
return JSON.parse(output) as T;
|
||||
} catch (err) {
|
||||
throw new Error(`Failed to parse gh JSON output: ${err instanceof Error ? err.message : String(err)}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute a gh CLI command asynchronously and parse the JSON output.
|
||||
* Requires the command to support --json flag.
|
||||
*/
|
||||
export async function runGhJsonAsync<T>(args: string[], cwd?: string): Promise<T> {
|
||||
const jsonArgs = args.includes("--json") ? args : [...args, "--json"];
|
||||
const output = await runGhAsync(jsonArgs, cwd);
|
||||
try {
|
||||
return JSON.parse(output) as T;
|
||||
} catch (err) {
|
||||
throw new Error(`Failed to parse gh JSON output: ${err instanceof Error ? err.message : String(err)}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a human-readable error message from a gh CLI error.
|
||||
* Extracts the most relevant error information.
|
||||
*/
|
||||
export function getGhErrorMessage(error: unknown): string {
|
||||
if (error instanceof Error) {
|
||||
// Check for common gh CLI error patterns
|
||||
const message = error.message;
|
||||
|
||||
// Authentication errors
|
||||
if (message.includes("not logged into") || message.includes("authentication required")) {
|
||||
return "GitHub CLI is not authenticated. Run 'gh auth login' to authenticate.";
|
||||
}
|
||||
|
||||
// Not found errors
|
||||
if (message.includes("not found") || message.includes("404")) {
|
||||
return "Resource not found. Check that the repository, PR, or issue exists and you have access.";
|
||||
}
|
||||
|
||||
// Rate limit errors
|
||||
if (message.includes("rate limit") || message.includes("403")) {
|
||||
return "GitHub API rate limit exceeded. Please try again later.";
|
||||
}
|
||||
|
||||
return message;
|
||||
}
|
||||
|
||||
return String(error);
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify gh CLI is available and authenticated.
|
||||
* Throws an error with helpful instructions if not.
|
||||
*/
|
||||
export function ensureGhAuth(): void {
|
||||
if (!isGhAvailable()) {
|
||||
throw new Error(
|
||||
"GitHub CLI (gh) is not installed. " +
|
||||
"Install it from https://github.com/cli/cli#installation"
|
||||
);
|
||||
}
|
||||
|
||||
if (!isGhAuthenticated()) {
|
||||
throw new Error(
|
||||
"GitHub CLI (gh) is not authenticated. " +
|
||||
"Run 'gh auth login' to authenticate with GitHub."
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract owner/repo from a GitHub remote URL.
|
||||
* Used to determine the current repository context.
|
||||
*/
|
||||
export function parseRepoFromRemote(remoteUrl: string): { owner: string; repo: string } | null {
|
||||
// HTTPS: https://github.com/owner/repo.git or https://github.com/owner/repo
|
||||
const httpsMatch = remoteUrl.match(/github\.com\/([^\/]+)\/([^\/\.]+)(?:\.git)?$/);
|
||||
if (httpsMatch) {
|
||||
return { owner: httpsMatch[1], repo: httpsMatch[2] };
|
||||
}
|
||||
|
||||
// SSH: git@github.com:owner/repo.git or git@github.com:owner/repo
|
||||
const sshMatch = remoteUrl.match(/github\.com:([^\/]+)\/([^\/\.]+)(?:\.git)?$/);
|
||||
if (sshMatch) {
|
||||
return { owner: sshMatch[1], repo: sshMatch[2] };
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the current repository context from git remote.
|
||||
* Returns null if not in a git repository or no GitHub remote.
|
||||
*/
|
||||
export function getCurrentRepo(cwd?: string): { owner: string; repo: string } | null {
|
||||
try {
|
||||
const remoteUrl = execFileSync("git", ["remote", "get-url", "origin"], {
|
||||
cwd,
|
||||
encoding: "utf-8",
|
||||
stdio: ["pipe", "pipe", "ignore"],
|
||||
}).trim();
|
||||
|
||||
return parseRepoFromRemote(remoteUrl);
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user