@osdlc/repo-cleaner 0.9.2 → 0.10.1

package/dist/branches.js

@@ -59,6 +59,14 @@ export function gapSentence(pr, gap, repo) {
         ? `PR #${pr.number} merged into \`${pr.baseRef}\`, not \`${repo.mainBranch}\`, so it is not landing proof (other-base).`
         : `PR #${pr.number} merged at head ${pr.headOid ?? '(unknown)'}, which is not this tip, so it is not landing proof (head-moved).`;
 }
+/**
+ * `facts.merged`: the work is on the default branch, by an exact-head merged
+ * PR, by ancestry or by a patch match. Every category records it this way, so
+ * `summary` counts one definition.
+ */
+export function mergedFact(e) {
+    return e.landed || e.ancestor || e.patchLanded;
+}
 /** What deleting a branch needs: its unlanded commits, and its open PR. */
 function branchRequires(unmerged, pr) {
     return authorizationsFor({
@@ -95,10 +103,11 @@ export function remoteDeleteCommand(remote, name, sha) {
     ]);
 }
 // ── local branches ─────────────────────────────────────────────────────────
-export function gatherLocalBranches(repo, prs, worktreeBranches, git, only) {
+export function gatherLocalBranches(repo, prs, worktreeBranches, git, only, tick) {
     const rows = git.at(repo.root).forEachRef('refs/heads/', { format: LOCAL_FORMAT });
     const items = [];
-    for (const line of rows) {
+    for (const [i, line] of rows.entries()) {
+        tick?.(i, rows.length);
         const parts = line.split('\t');
         if (parts.length !== 5)
             continue;
@@ -140,10 +149,24 @@ export function classifyLocalBranch(opts) {
     const pinned = (reason) => keep(reason, { deletable: false });
     if (name === repo.mainBranch)
         return pinned('default branch');
-    if (name === repo.currentBranch)
-        return pinned('current HEAD');
-    if (worktreeBranches.has(name))
-        return pinned('checked out in a worktree (handle via that worktree)');
+    const held = name === repo.currentBranch
+        ? 'current HEAD'
+        : worktreeBranches.has(name)
+            ? 'checked out in a worktree (handle via that worktree)'
+            : null;
+    if (held !== null) {
+        // Never deletable here, but still counted as merged or not: by ancestry or
+        // an exact-head merged PR, without the patch checks a deletable row gets.
+        // `soft`: a missing default ref reads as not merged.
+        const pr = prs.get(name);
+        const { landed } = recordPr(facts, pr, sha, repo);
+        facts['merged'] = mergedFact({
+            landed,
+            ancestor: git.at(repo.root).soft.isAncestor(sha, landedRef(repo)),
+            patchLanded: false,
+        });
+        return pinned(held);
+    }
     // Work merged only into an unpushed local default has not landed. A missing
     // remote-tracking ref exits 128: ancestry unknown (null).
     const compareRef = landedRef(repo);
@@ -161,6 +184,7 @@ export function classifyLocalBranch(opts) {
         recordLanding(facts, patch);
     const patchLanded = patch !== null && patch.check !== null;
     const unmerged = !landed && !isAncestor && !landingConfirmed(patch);
+    facts['merged'] = mergedFact({ landed, ancestor: isAncestor, patchLanded });
     if (!landed && !isAncestor) {
         facts['unique_commits'] = git.at(repo.root).aheadBehind(repo.mainBranch, sha).ahead;
     }
@@ -230,7 +254,7 @@ export function classifyLocalBranch(opts) {
     });
 }
 // ── remote branches ────────────────────────────────────────────────────────
-export function gatherRemoteBranches(repo, prs, localBranchNames, git, only) {
+export function gatherRemoteBranches(repo, prs, localBranchNames, git, only, tick) {
     if (repo.remote === null)
         return [];
     // Default door: an unreachable remote throws rather than rendering as "the
@@ -238,7 +262,8 @@ export function gatherRemoteBranches(repo, prs, localBranchNames, git, only) {
     const pattern = only === undefined ? undefined : `refs/heads/${only}`;
     const rows = git.at(repo.root).lsRemote(repo.remote, pattern, { heads: true });
     const items = [];
-    for (const { sha, ref } of rows) {
+    for (const [i, { sha, ref }] of rows.entries()) {
+        tick?.(i, rows.length);
         if (!ref.startsWith('refs/heads/'))
             continue;
         const name = ref.slice('refs/heads/'.length);
@@ -283,6 +308,7 @@ export function classifyRemoteBranch(opts) {
         recordLanding(facts, patch);
     const patchLanded = patch !== null && patch.check !== null;
     const unmerged = !landed && !isAncestor && !landingConfirmed(patch);
+    facts['merged'] = mergedFact({ landed, ancestor: isAncestor, patchLanded });
     if (!landed && !isAncestor) {
         // Unknown (null) when the clone lacks `sha` or `remoteMain`, as above.
         const counted = git.at(repo.root).try.aheadBehind(remoteMain, sha);

package/dist/cli.d.ts

@@ -1,19 +1,38 @@
 /**
  * `repo-cleaner` — what has been merged, and what can go away.
  *
- * Two commands. A bare invocation sweeps: it inventories, fetching each
- * remote first unless `--no-fetch`, and writes nothing but an optional plan.
- * `repo-cleaner apply` deletes the rows of a plan that were selected and
- * authorized. Scope is opt-in: the sweep covers the repository you are
- * standing in unless `--all` or a path says otherwise.
+ * Four verbs over one set of sweep filters:
+ *
+ *   status  (the default) inventory and classify; read-only but for the fetch
+ *   summary the same sweep as counts: totals, merged, delete, review, keep
+ *   plan    write the deletable rows as a plan, to stdout or a file
+ *   apply   re-check, show the steps, ask, then delete
+ *
+ * `apply` works from a saved plan (`--plan`) or sweeps first. Either way it
+ * re-checks every row, prints the steps it would run and asks before deleting;
+ * `--yes` skips the question. Without a terminal and without `--yes` it
+ * refuses rather than deleting. Scope is opt-in: the sweep covers the
+ * repository you are standing in unless a path says otherwise.
  *
  * Exit codes:
- *   0   swept; or every selected row was applied or dropped with a reason
+ *   0   swept; or apply ran, was declined, or had nothing to run
  *   1   failed against the state it found
  *   2   cannot run as typed
  *   10  nothing to sweep: no entry named a repository
  *   11  apply stopped at a failed step; the receipt says which
  */
 import { type CliContext } from '@osdlc/cli-tool';
+/**
+ * Asks a yes/no question, or returns null when there is no one to ask. `main`
+ * takes it as a parameter so a test can answer.
+ */
+export type Confirm = (question: string) => boolean | null;
+export interface MainDeps {
+    confirm?: Confirm;
+    /** Reads `--plan -`. Defaults to stdin. */
+    readStdin?: () => string;
+    /** Whether stderr is a terminal, so a status line may be drawn. Defaults to `isatty(2)`. */
+    stderrIsTerminal?: boolean;
+}
 /** `main(argv, ctx)`: returns an exit code, never exits. */
-export declare function main(argv: readonly string[], ctx: CliContext): number;
+export declare function main(argv: readonly string[], ctx: CliContext, deps?: MainDeps): number;