@osdlc/repo-cleaner 0.19.0 → 0.20.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @osdlc/repo-cleaner
 
+## 0.20.0
+
+### Minor Changes
+
+- 9171850: Run with no target from a subdirectory of a checkout, `repo-cleaner` now sweeps that checkout instead of finding nothing and exiting 10. It widens only when the search below finds no checkout and the checkout around tracks files in the directory, so `~/Developer` under a home directory kept in git still sweeps the checkouts below it. A subdirectory named as a target is read as written, as before.
+
+## 0.19.1
+
+### Patch Changes
+
+- bfac1ae: The note that suggests `--provider none` now names what the provider lists ("if this remote has no PRs", or "no merge requests" for GitLab) instead of "if this remote has no forge", and the README drops "forge" the same way.
+
 ## 0.19.0
 
 ### Minor Changes

package/README.md

@@ -115,8 +115,15 @@ A target is what to sweep:
 
 No target is the same as naming the current directory: at a checkout's root
 it sweeps that repository, and in a directory of checkouts it sweeps each
-one. In a subdirectory of a checkout it searches below that subdirectory,
-like any other directory, so name the checkout instead.
+one. In a subdirectory of a checkout, such as `src/`, it sweeps the checkout
+around it. That happens when the search below finds no checkout and the
+checkout around tracks files in the directory (or git cannot say, in which
+case the report gives git's reason). So a directory of checkouts inside a
+checkout of its own, such as `~/Developer` under a home directory kept in
+git, still sweeps the checkouts below it, or reports that it found none, as
+long as the home repository tracks no file there. A search that finds
+checkouts it cannot read is reported as it is. A subdirectory named as a
+target is read as written and searched.
 What a target names is read off the disk rather than from how it is written:
 a path that is itself a checkout names that repository, and a path that is
 not is searched for the checkouts under it, descending through directories
@@ -597,7 +604,7 @@ a failed fetch costs the whole repository.
 | What failed | What you get |
 | --- | --- |
 | `gh pr list` / `glab api` (the PR listing) | Every row is judged on git evidence. Remote branches with no known PR need `--allow confirm-open-pr` to delete. One note on the repository. |
-| `gh` / `glab` not installed or not signed in | The provider is never asked, so this is treated like a failed listing: every row is judged on git evidence, remote branches with no known PR need `--allow confirm-open-pr` to delete, and a note on the repository says why. Pass `--provider none` if the remote has no forge, so there is nothing to check. |
+| `gh` / `glab` not installed or not signed in | The provider is never asked, so this is treated like a failed listing: every row is judged on git evidence, remote branches with no known PR need `--allow confirm-open-pr` to delete, and a note on the repository says why. Pass `--provider none` if the remote has no pull requests, so there is nothing to check. |
 | `git ls-remote`, after a fetch that worked | Remote branches are read from the refs that fetch just wrote. A note on the repository and on each remote row. |
 | `git ls-remote`, in `clean`'s re-check of an `--offline` plan | The run is refused before anything runs. The refs on disk are what the re-check is there to replace, and `clean` does not delete on a remote it cannot ask. |
 | `git fetch` | The repository is an error with no rows. Every row would otherwise be judged against an older default branch than the one you asked for. |
@@ -630,7 +637,7 @@ $ repo-cleaner --remote --offline
 2 to delete, 0 to review, across 1 repository.
 ```
 
-When the remote may not be on a forge at all, the note also suggests
+When the remote may have no pull requests at all, the note also suggests
 `--provider none`: for a host `auto` could only guess was GitHub, or a local
 path swept with `--provider github`. Under `auto`, a local path gets no
 provider in the first place.
@@ -656,8 +663,8 @@ status: complete
 The local branch went; the remote branch stayed. To go on, pick one:
 
 - Fix the lookup (install `gh`, sign in, check the remote URL) and run again.
-- Pass `--provider none` if this remote has no forge at all, so there is no
-  pull request to lose.
+- Pass `--provider none` if this remote has no pull requests at all, so there
+  is none to lose.
 - Check for open pull requests yourself, then pass `--allow confirm-open-pr`.
 
 The same happens when `gh` is not installed or not signed in. Nothing was
@@ -675,8 +682,8 @@ $ repo-cleaner --remote --offline
 2 to delete, 0 to review, across 1 repository.
 ```
 
-`--provider none` is how you say the remote has no forge: then there is no
-lookup, no note and no gate.
+`--provider none` is how you say the remote has no pull requests: then there
+is no lookup, no note and no gate.
 
 ### `--offline` reads what is already on disk
 
@@ -707,7 +714,7 @@ $ repo-cleaner --remote --offline --provider none     # now
 `--provider none` to judge with no network at all.
 
 The refs on disk can be stale. A remote-tracking ref stays until the next
-`git fetch --prune`, so a branch the forge deleted after its pull request
+`git fetch --prune`, so a branch the host deleted after its pull request
 merged still shows in the report, and a branch someone pushed to since shows
 its old tip. That is fine for a report, but `clean` deletes on the remote, so
 before it does, its re-check asks the remote itself with `git ls-remote`. A
@@ -779,7 +786,7 @@ is allowed.
 
 A `PrProvider` you write reports a failure by returning `null` or by
 throwing; either becomes `listError` and a note. Return an empty list only
-when the forge answered and there are no pull requests.
+when the provider answered and there are no pull requests.
 
 The decision behind this is
 [D-UVUH](docs/planning/decisions/D-UVUH-failed-lookups.md).
@@ -967,7 +974,7 @@ Not done yet:
 
 `git` on `PATH`, and `gh` (or `glab` for GitLab) for pull request evidence.
 Without it, deleting a remote branch needs `--allow confirm-open-pr`, or
-`--provider none` for a remote with no forge (see
+`--provider none` for a remote with no pull requests (see
 [When a lookup fails](#when-a-lookup-fails)). Authentication is the CLI's
 own — this package reads no token.
 

package/dist/reference.js

@@ -9,7 +9,8 @@ const TARGETS = `Targets
     a directory           every checkout found under it, three levels deep at most
     a remote URL          its remote branches only, through a clone kept in the cache
                           directory (https://, ssh://, file://, or user@host:path)
-  No target sweeps the directory you are in, read the same way.`;
+  No target sweeps the directory you are in, read the same way; in a subdirectory
+  the checkout around it tracks, where the search finds no checkout, that checkout.`;
 const SWEEP = `Sweep options (the report, plan and clean)
   --remote                Also judge remote branches. Turns on the network: fetches
                           each remote first and asks GitHub or GitLab about pull

package/dist/resolve.d.ts

@@ -8,9 +8,10 @@
  * covers everything under it — including a per-owner or per-client
  * directory — without listing any of them.
  *
- * A caller that passes no entries gets no repositories. The CLI's bare
- * invocation passes the directory it stands in, which resolves like any
- * other entry.
+ * A caller that passes no entries gets no repositories. `sweep` with no
+ * targets passes the directory it stands in, which resolves like any other
+ * entry; when that finds nothing in a directory the checkout around it tracks,
+ * `sweep` widens it to that checkout.
  */
 import { type Git } from '@osdlc/typed-git';
 import { type ScanStats, type UnresolvedEntry } from './types.ts';

package/dist/resolve.js

@@ -8,9 +8,10 @@
  * covers everything under it — including a per-owner or per-client
  * directory — without listing any of them.
  *
- * A caller that passes no entries gets no repositories. The CLI's bare
- * invocation passes the directory it stands in, which resolves like any
- * other entry.
+ * A caller that passes no entries gets no repositories. `sweep` with no
+ * targets passes the directory it stands in, which resolves like any other
+ * entry; when that finds nothing in a directory the checkout around it tracks,
+ * `sweep` widens it to that checkout.
  */
 import { homedir } from 'node:os';
 import { isAbsolute, join, resolve as resolvePath } from 'node:path';

package/dist/sweep.d.ts

@@ -67,7 +67,9 @@ export declare function sweptWith(targets: readonly string[], opts: Omit<SweepOp
 /**
  * Sweep `targets`: checkouts, directories to search for checkouts, or remote
  * URLs (swept through a clone kept in `cacheDir`, remote branches only). No
- * targets means `[cwd]`, resolved the same way.
+ * targets means `[cwd]`, resolved the same way, except that a `cwd` where the
+ * search finds no checkout, and whose checkout tracks files in it, sweeps
+ * that checkout.
  *
  * Never throws for a repository it cannot read: that one comes back with
  * `error` set, because a fan-out must not end on its first bad entry. Throws a

package/dist/sweep.js

@@ -8,7 +8,7 @@
  */
 import { existsSync, realpathSync } from 'node:fs';
 import { isAbsolute, resolve } from 'node:path';
-import { Git } from '@osdlc/typed-git';
+import { Git, checkoutRoot } from '@osdlc/typed-git';
 import { Gh } from '@osdlc/typed-gh';
 import { HELD_BY_WORKTREE, gatherLocalBranches, gatherRemoteBranches, resolveBranch, } from "./branches.js";
 import { discoverRepo } from "./discover.js";
@@ -103,10 +103,21 @@ export function sweptWith(targets, opts) {
         urls,
     };
 }
+/**
+ * Whether the checkout `dir` is in tracks any file under it. True as well when
+ * git cannot say: then widening to that checkout reports why it cannot be
+ * read, which says more than "no git checkouts under it".
+ */
+function tracksFilesIn(dir, git) {
+    const listed = git.at(dir).try.lsFiles({ cached: true });
+    return !listed.ok || listed.value.length > 0;
+}
 /**
  * Sweep `targets`: checkouts, directories to search for checkouts, or remote
  * URLs (swept through a clone kept in `cacheDir`, remote branches only). No
- * targets means `[cwd]`, resolved the same way.
+ * targets means `[cwd]`, resolved the same way, except that a `cwd` where the
+ * search finds no checkout, and whose checkout tracks files in it, sweeps
+ * that checkout.
  *
  * Never throws for a repository it cannot read: that one comes back with
  * `error` set, because a fan-out must not end on its first bad entry. Throws a
@@ -131,13 +142,26 @@ export function sweep(targets, opts = {}) {
             }
         }
     }
-    const resolution = entries.length === 0
+    const resolveOpts = {
+        git: new Git(cwd, { runner: opts.git }),
+        baseDir: cwd,
+        ...(opts.onWarn === undefined ? {} : { onWarn: opts.onWarn }),
+    };
+    let resolution = entries.length === 0
         ? { repos: [], unresolved: [], scan: emptyScan() }
-        : resolveEntries(entries, {
-            git: new Git(cwd, { runner: opts.git }),
-            baseDir: cwd,
-            ...(opts.onWarn === undefined ? {} : { onWarn: opts.onWarn }),
-        });
+        : resolveEntries(entries, resolveOpts);
+    // With no target, a directory the checkout around it tracks files in means
+    // that checkout, as it does for git itself. The search comes first, and a
+    // directory the checkout tracks nothing in is not part of it: a home
+    // directory kept in git does not track ~/Developer, so a search there that
+    // finds nothing is reported as it is. So is a search that found checkouts
+    // it could not read.
+    const around = targets.length === 0 && resolution.repos.length === 0 && resolution.scan.checkoutsFound === 0
+        ? checkoutRoot(cwd)
+        : null;
+    if (around !== null && around !== resolve(cwd) && tracksFilesIn(cwd, resolveOpts.git)) {
+        resolution = resolveEntries([around], resolveOpts);
+    }
     if (branch !== undefined && resolution.repos.length > 1) {
         throw new RepoCleanerError('conflict', `--branch sweeps one repository; ${resolution.repos.length} found under ${entries[0]}`);
     }
@@ -182,7 +206,7 @@ function providerNote(repo, kinds, choice) {
     // is a forge: there the cause is access, not the provider.
     const hint = status.host === null ||
         (choice === 'auto' && status.name === 'github' && status.host !== 'github.com')
-        ? ' Pass `--provider none` if this remote has no forge.'
+        ? ` Pass \`--provider none\` if this remote has no ${status.noun}s.`
         : '';
     if (unchecked.kind === 'list-failed') {
         return `Listing ${status.noun}s with \`${status.listing}\` failed (${status.listError}); judged on git evidence alone.${hint}`;

package/dist/version.generated.d.ts

@@ -1,2 +1,2 @@
 /** This package's version, from its package.json when it was built. */
-export declare const VERSION = "0.19.0";
+export declare const VERSION = "0.20.0";

package/dist/version.generated.js

@@ -1,3 +1,3 @@
 // Generated by cli-tool-stamp-version from package.json. Do not edit.
 /** This package's version, from its package.json when it was built. */
-export const VERSION = '0.19.0';
+export const VERSION = '0.20.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osdlc/repo-cleaner",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "description": "What has been merged into the default branch, and what can go away. Inventories local branches, worktrees and remote branches across one repository or many, classifying each with the evidence behind the verdict and the command that would act on it. Plans and applies approved deletes, compare-and-swap.",
   "license": "MIT OR Apache-2.0",
   "author": "sksizer",
@@ -50,9 +50,9 @@
   "dependencies": {
     "zod": "^4.6.6",
     "@osdlc/cli-tool": "^0.17.0",
+    "@osdlc/command-seam": "^0.14.0",
     "@osdlc/path-guard": "^0.3.1",
     "@osdlc/typed-gh": "^0.16.1",
-    "@osdlc/command-seam": "^0.14.0",
     "@osdlc/ux": "^0.1.1",
     "@osdlc/typed-git": "^0.13.0"
   },
@@ -63,8 +63,8 @@
     "prettier": "3.9.6",
     "typescript": "~6.0.3",
     "vitest": "^5.0.5",
-    "@osdlc/prettier-config": "^0.3.1",
-    "@osdlc/tsconfig": "^0.4.1"
+    "@osdlc/tsconfig": "^0.4.1",
+    "@osdlc/prettier-config": "^0.3.1"
   },
   "scripts": {
     "build": "cli-tool-stamp-version && tsc -p tsconfig.build.json",