feat(repo): only suggest remote delete if branch exists

Author: VChet

src/helpers.ts

@@ -0,0 +1,7 @@
+export function logError(prefix: string, error: unknown): void {
+  if (error instanceof Error) {
+    console.warn(`${prefix}: ${error.message}`);
+  } else {
+    console.warn(`${prefix}: ${String(error)}`);
+  }
+}

src/index.ts

@@ -1,6 +1,7 @@
 import process from "node:process";
 import { getConfig, getDefaultTargetBranch, getMergedBranches, isDetachedHead, isGitRepo } from "./repo.js";
 import { outputMergedBranches } from "./output.js";
+import { logError } from "./helpers.js";
 
 function main(): void {
   if (!isGitRepo()) {
@@ -21,7 +22,7 @@ function main(): void {
     const mergedBranches = getMergedBranches(targetBranch);
     outputMergedBranches(mergedBranches, targetBranch, getConfig());
   } catch (error) {
-    console.error("Error executing 'git-merged-branches' command`:", error);
+    logError("Error executing 'git-merged-branches' command", error);
     process.exit(1);
   }
 }

src/output.ts

@@ -1,4 +1,4 @@
-import { GitMergedConfig } from "./repo.js";
+import { fetchRemoteBranches, GitMergedConfig } from "./repo.js";
 import { isValidURL } from "./validate.js";
 
 function formatSingleBranch(
@@ -35,13 +35,17 @@ export function formatTaskBranches(branches: string[], { issueUrlFormat, issueUr
 }
 
 export function outputMergedBranches(branches: string[], targetBranch: string, config: GitMergedConfig): void {
-  if (branches.length) {
-    console.info(`Branches merged into '${targetBranch}':`)
-    console.info(formatTaskBranches(branches, config).join("\n"));
-
-    console.info("\nRun the following to delete branches locally and remotely:");
-    console.info(`git branch --delete ${branches.join(" ")} && git push origin --delete ${branches.join(" ")}`);
-  } else {
-    console.info(`No branches merged into '${targetBranch}'.`);
+  if (!branches.length) {
+    return console.info(`No branches merged into '${targetBranch}'.`);
   }
+
+  console.info(`Branches merged into '${targetBranch}':`)
+  console.info(formatTaskBranches(branches, config).join("\n"));
+
+  const remoteBranches = fetchRemoteBranches("origin");
+  const remoteMerged = branches.filter(branch => remoteBranches.includes(branch));
+
+  console.info("\nRun the following to delete branches:");
+  console.info(`locally:\n  git branch --delete ${branches.join(" ")}`);
+  if (remoteMerged.length) { console.info(`remotely:\n  git push origin --delete ${remoteMerged.join(" ")}`); }
 }

src/repo.ts

@@ -1,6 +1,7 @@
 import { execSync } from "node:child_process";
 import { readFileSync } from "node:fs";
 import { join } from "node:path";
+import { logError } from "./helpers";
 
 export function isGitRepo(): boolean {
   try {
@@ -49,6 +50,20 @@ export function getMergedBranches(targetBranch: string): string[] {
   }, []);
 }
 
+export function fetchRemoteBranches(remote = "origin"): string[] {
+  try {
+    const output = execSync(`git ls-remote --heads ${remote}`, { encoding: "utf-8" });
+    return output
+      .split("\n")
+      .map(line => line.split("\t")[1])
+      .filter(ref => ref?.startsWith("refs/heads/"))
+      .map(ref => ref.replace("refs/heads/", ""));
+  } catch (error) {
+    logError(`Could not fetch remote branches from '${remote}'`, error);
+    return [];
+  }
+}
+
 export interface GitMergedConfig {
   issueUrlFormat?: string;
   issueUrlPrefix?: string[];
@@ -59,7 +74,8 @@ export function getConfig(): GitMergedConfig {
     const pkgPath = join(process.cwd(), "package.json");
     const pkg = JSON.parse(readFileSync(pkgPath, "utf-8"));
     return pkg["git-merged-branches"] || {};
-  } catch {
+  } catch (error) {
+    logError("Could not read package.json", error);
     return {};
   }
 }

src/tests/output.test.ts

@@ -1,6 +1,7 @@
 import { describe, it, expect, vi, beforeEach } from "vitest";
 import { formatTaskBranches, outputMergedBranches } from "../output";
 import { GitMergedConfig } from "../repo";
+import * as repoMethods from "../repo";
 
 const DEFAULT_CONFIG: GitMergedConfig = {
   issueUrlFormat: "https://test-instance.org/browse/{{prefix}}{{id}}",
@@ -72,7 +73,7 @@ describe("outputMergedBranches", () => {
     warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
   });
 
-  it("should log the correct branches when there are merged branches", () => {
+  it("should log the correct branches when there are local merged branches", () => {
     const branches = ["feat/TOKEN-800_new-feature", "fix/TOKEN-123_some-fix"];
 
     outputMergedBranches(branches, "master", DEFAULT_CONFIG);
@@ -84,13 +85,33 @@ describe("outputMergedBranches", () => {
     expect(infoSpy).toHaveBeenNthCalledWith(2, branchOutput.join("\n"));
 
     const localDelete = `git branch --delete ${branches.join(" ")}`;
-    const remoteDelete = `git push origin --delete ${branches.join(" ")}`;
-    expect(infoSpy).toHaveBeenNthCalledWith(3, "\nRun the following to delete branches locally and remotely:");
-    expect(infoSpy).toHaveBeenNthCalledWith(4, `${localDelete} && ${remoteDelete}`);
+    expect(infoSpy).toHaveBeenNthCalledWith(3, "\nRun the following to delete branches:");
+    expect(infoSpy).toHaveBeenNthCalledWith(4, `locally:\n  ${localDelete}`);
     expect(infoSpy).toHaveBeenCalledTimes(4);
     expect(warnSpy).not.toHaveBeenCalled();
   });
 
+  it("should log the correct branches when there are remote merged branches", () => {
+    const branches = ["feat/TOKEN-800_new-feature", "fix/TOKEN-123_some-fix"];
+    vi.spyOn(repoMethods, "fetchRemoteBranches").mockReturnValue(branches);
+
+    outputMergedBranches(branches, "master", DEFAULT_CONFIG);
+    expect(infoSpy).toHaveBeenNthCalledWith(1, "Branches merged into 'master':");
+    const branchOutput = [
+      "feat/TOKEN-800_new-feature <https://test-instance.org/browse/TOKEN-800>",
+      "fix/TOKEN-123_some-fix <https://test-instance.org/browse/TOKEN-123>"
+    ]
+    expect(infoSpy).toHaveBeenNthCalledWith(2, branchOutput.join("\n"));
+
+    const localDelete = `git branch --delete ${branches.join(" ")}`;
+    const remoteDelete = `git push origin --delete ${branches.join(" ")}`;
+    expect(infoSpy).toHaveBeenNthCalledWith(3, "\nRun the following to delete branches:");
+    expect(infoSpy).toHaveBeenNthCalledWith(4, `locally:\n  ${localDelete}`);
+    expect(infoSpy).toHaveBeenNthCalledWith(5, `remotely:\n  ${remoteDelete}`);
+    expect(infoSpy).toHaveBeenCalledTimes(5);
+    expect(warnSpy).not.toHaveBeenCalled();
+  });
+
   it("should log a message when no branches are merged", () => {
     outputMergedBranches([], "master", DEFAULT_CONFIG);
     expect(infoSpy).toHaveBeenCalledWith("No branches merged into 'master'.");