@osdlc/repo-cleaner 0.0.1-stage → 0.6.0

package/CHANGELOG.md

@@ -0,0 +1,202 @@
+# @osdlc/repo-cleaner
+
+## 0.6.0
+
+### Minor Changes
+
+- bb61f10: `--version` prints the package version and exits 0.
+
+### Patch Changes
+
+- Updated dependencies [bb61f10]
+  - @osdlc/cli-tool@0.11.0
+
+## 0.5.2
+
+### Patch Changes
+
+- Updated dependencies [da5e6a3]
+- Updated dependencies [da5e6a3]
+- Updated dependencies [da5e6a3]
+  - @osdlc/command-seam@0.14.0
+  - @osdlc/typed-gh@0.11.0
+  - @osdlc/typed-git@0.10.0
+  - @osdlc/cli-tool@0.10.1
+
+## 0.5.1
+
+### Patch Changes
+
+- Updated dependencies [b835ae4]
+- Updated dependencies [b835ae4]
+- Updated dependencies [b835ae4]
+- Updated dependencies [b835ae4]
+- Updated dependencies [b835ae4]
+- Updated dependencies [fdef74f]
+  - @osdlc/cli-tool@0.10.0
+  - @osdlc/command-seam@0.13.0
+  - @osdlc/config-layers@0.8.0
+  - @osdlc/typed-gh@0.10.0
+  - @osdlc/typed-git@0.9.0
+
+## 0.5.0
+
+### Minor Changes
+
+- c3f0d1d: The first release of `@osdlc/repo-cleaner` on npm. It finds what has been merged into the default branch and can go away: local branches, worktrees and remote branches, across one repository or many.
+  
+  - `sweepRepo` and `sweepRepos` classify each item `safe-to-delete`, `safe-to-keep` or `needs-investigation`, with the evidence behind the verdict and the command that would act on it. A merged pull request whose head is the branch tip, or a tip reachable from `<remote>/<default>`, settles most items. A sweep deletes nothing.
+  - `planRepo`, `writePlan`, `readPlan` and `applyPlan` write the deletable rows as a plan and apply the ones a person approves. Each delete is compare-and-swap on the judged sha, each step is verified, the first failure stops the run and a receipt records every step. Rows that need `abandon-unmerged`, `discard-changes` or `confirm-open-pr` are dropped without that grant.
+  - The `repo-cleaner` command sweeps the repository you are in, or a path, or the repositories in `<config-home>/repo-cleaner/config.yaml` with `--all`. `repo-cleaner apply` applies a plan. The directories are named `repo-cleaner`, moved by the `REPO_CLEANER_*` environment variables.
+  - ESM only, compiled JavaScript with `.d.ts`, Node 22 or newer. `git` is required; `gh` is optional and `--no-gh` skips it. Licence `MIT OR Apache-2.0`.
+- b3b7ecc: A worktree lock held by a dead process no longer blocks removal, and a live process inside a worktree now does.
+  
+  - A lock reason with a `pid <N>` token (optionally `start <time>`) is read as an owner claim. When that process is dead, or its start time (a timestamp precise to the second) differs from the lock's, the lock is stale: the worktree gets `facts.stale_lock`, no `locked-worktree` blocker, and `apply` runs a new `unlock-worktree` step before the remove. It checks the owner and the directory again just before the unlock and the remove, and `stale_lock` is part of the worktree fingerprint. A lock with no `pid` token, or a live owner, still blocks.
+  - A new `live-process` blocker covers any process other than an idle shell (`sh`, `bash`, `zsh`, `fish` with no child processes) whose working directory is inside the worktree. Idle shells are listed in `facts.idle_shells`. When the process table cannot be read, the worktree gets a `process-probe-failed` blocker instead.
+  - New `ProcessProbe` port (`alive`, `holders`; `probe` is required on `gatherWorktrees` and `classifyWorktree`) with a default over `ps` and `lsof` run through `@osdlc/command-seam`. Pass `probe` to `sweepRepo`, `sweepRepos`, `applyPlan`, `gatherWorktrees` or `classifyWorktree` to replace it. Exports: `defaultProcessProbe`, `parseLockOwner`, `parseLsofCwd`, `isIdleShell`, `worktreeUnlockCommand` and the types.
+  - The receipt's step `action` gains `unlock-worktree`. Uses `worktreeUnlock` from `@osdlc/typed-git`.
+
+### Patch Changes
+
+- Updated dependencies [7addea1]
+- Updated dependencies [f013f38]
+- Updated dependencies [3d6d087]
+- Updated dependencies [f013f38]
+  - @osdlc/cli-tool@0.9.1
+  - @osdlc/command-seam@0.12.1
+  - @osdlc/typed-gh@0.9.6
+  - @osdlc/typed-git@0.8.2
+
+## History before the first public release
+
+These versions were never published. The first release of `@osdlc/repo-cleaner` on
+npm is 0.5.0, and the entry for it is added above this section when it is released.
+
+### [0.4.3] (unpublished)
+
+#### Added
+
+- `VENDOR_DIRS` export.
+
+#### Changed
+
+- Stops depending on an internal wrapper for its directory names.
+- The directory vendor is `repo-cleaner` and the override variables are `REPO_CLEANER_*`, in place of an internal vendor name.
+- The `FLEET_ROOT`, `FLEET_*` and `FLEET_MACHINE_CONFIG` variables are no longer read; there is no fallback, and the replacements are `REPO_CLEANER_ROOT`, `REPO_CLEANER_*` and `REPO_CLEANER_MACHINE_CONFIG`. The config directory paths themselves do not change.
+- Compiled JavaScript with `.d.ts` for Node, in place of TypeScript source for Bun.
+
+#### Fixed
+
+- The current-worktree check uses `@osdlc/path-guard`: a cwd is placed by its real path, `..` taken
+  through a symlink included, and a cwd that no longer exists below a symlinked parent still counts.
+- Git reads use the typed git client's soft door and its new API.
+- Path containment is separator-aware, so a sibling directory that shares a path prefix is not
+  counted as inside.
+
+### [0.3.0] - 2026-10-06 (unpublished)
+
+#### Added
+
+- **Plan and apply.** `planRepo`, `writePlan` and `readPlan` write and read the
+  deletable rows of a sweep with a fingerprint of each. `applyPlan` sweeps
+  again, drops rows that moved or lack an authorization, deletes
+  compare-and-swap, verifies each step and writes a receipt. A host passes its
+  re-ranking as the `annotate` hook.
+- **`repo-cleaner apply`, `--branch`, `--write-plan`, `--plan-out`.** The CLI
+  plans and applies on its own, and runs on `defineCli`/`runMain`.
+- **`worktreeRemoveCommand` / `worktreePruneCommand`.**
+
+#### Changed
+
+- Every emitted command quotes its words for the shell, so a path with a space
+  pastes as one argument.
+- **BREAKING:** "Nothing to sweep" exits `10`, not `2`, which means a malformed
+  command.
+
+### [0.2.0] - 2026-10-05 (unpublished)
+
+#### Added
+
+- **Worktree blockers.** A worktree that is locked, has files flagged
+  skip-worktree or assume-unchanged, holds a nested repository in an
+  untracked or ignored directory, or shares its branch with another worktree
+  is `needs-investigation` with no command and `deletable: false`.
+  `facts.blockers` names each one, and the investigation parts say what to
+  do about it.
+- **Named authorizations on every row.** `requires` lists what a delete of
+  the row needs approved: `abandon-unmerged` (commits not on the default
+  branch or an exact-head merged PR, counted in `facts.unique_commits`),
+  `discard-changes` (a dirty worktree), `confirm-open-pr`. `deletable: false`
+  marks rows kept for structure. `requiresNote` renders them.
+  `proposedCommands` (`--commands`) leaves out rows that need one.
+- **Fetch before classifying.** `SweepOptions.fetch` runs
+  `git fetch --prune --quiet --no-write-fetch-head <remote>` first; a failed
+  fetch makes that repository an error row. `RepoInfo.fetched` records it. The
+  CLI fetches by default; `--no-fetch` turns it off.
+
+#### Changed
+
+- **BREAKING: `investigation_prompt` became `investigationParts`.** A list of
+  sentences rather than one string, so a host can append its own before
+  rendering.
+- **BREAKING: task-derived verdicts are gone.** A host applies them to
+  the returned rows. Every git-derived verdict already outranked them, so
+  nothing in the ladder moved.
+- **PR state reads through the typed GitHub client** rather than a hand-rolled
+  `gh pr list --json` and `JSON.parse`.
+- **A merged PR is landing proof only on an exact head match.** It must come
+  from this repository, target the default branch, and have the branch tip as
+  its head commit. Otherwise `facts.pr.evidence` names the gap (`head-moved`,
+  `other-base`) and the row needs investigation. Fork PRs are ignored.
+  Local-branch `facts.sha` is the full sha.
+- **BREAKING: local-branch ancestry is measured against `<remote>/<default>`.**
+  A branch merged only into an unpushed local default branch is no longer
+  `safe-to-delete`. The local default is used only when there is no remote,
+  and a missing remote-tracking ref leaves ancestry unknown. The fact is
+  renamed `ancestor_of_remote_main`, and `facts.compare_against` names the ref.
+- **BREAKING: branch deletes are compare-and-swap on the judged sha.** Local
+  rows propose `git update-ref -d refs/heads/<b> <sha>` in place of
+  `branch -d` / `-D`; remote rows propose
+  `git push --force-with-lease=refs/heads/<b>:<sha> <remote> :refs/heads/<b>`
+  in place of `push --delete`. Both refuse when the branch moved after the
+  sweep. `localDeleteCommand` / `remoteDeleteCommand` are exported.
+
+#### Fixed
+
+- A slashed default branch name is read whole: `release/v2` stays
+  `release/v2` rather than becoming `v2`.
+
+### [0.1.0] - 2026-09-13 (unpublished)
+
+The sweep was extracted into a standalone package; a host's own knowledge
+stays outside it, as an annotation over the returned inventory.
+
+#### Added
+
+- **`sweepRepo` / `sweepRepos`.** A repository's local branches, worktrees and
+  remote branches, classified `safe-to-delete` / `safe-to-keep` /
+  `needs-investigation`, each row carrying the evidence behind its verdict and
+  the command that would act on it. Read-only.
+- **Multi-repository resolution.** What an entry names is read off the disk:
+  a checkout names that repository, anything else is searched for the
+  checkouts under it. The report says what that search cost — entries
+  searched, directories read, checkouts found — and an enormous tree says so
+  on stderr mid-walk rather than after it. Candidates de-duplicate on the main
+  checkout, so a linked worktree collapses into the repository it belongs to.
+  An entry that resolves to nothing is reported, never dropped.
+- **Duplicate checkouts.** `SweepResult.duplicates` lists each remote that
+  two or more separate main checkouts share, and the text report opens with a
+  "Duplicate checkouts" section. A linked worktree is not a duplicate. Report
+  only.
+- **Per-repository error containment.** A repository that cannot be read
+  becomes an `error` row and the sweep continues. Single-repository callers
+  check the field.
+- **The config file is `@osdlc/config-layers`'s machine file** —
+  `<config-home>/repo-cleaner/config.yaml`, Zod as the contract, never
+  throws, relocated by `REPO_CLEANER_MACHINE_CONFIG` or `--config`. It
+  carries `paths:` as well, so a `repos:` entry says `{dev}` instead of
+  spelling a directory twice.
+- **The `repo-cleaner` CLI.** Scope is opt-in: a bare invocation sweeps the
+  repository you are standing in, `--all` reaches the config file, and
+  positional paths name repositories directly. `--output json`, `--commands`,
+  `--scope`, `--no-gh`, `--keep`.

package/CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# Contributing
+
+Thanks for your interest in `@osdlc/repo-cleaner`.
+
+## Issues
+
+Report bugs and ask for features in the
+[issue tracker](https://github.com/osdlc/osdlc/issues). For a bug, include the
+library version, your runtime and its version, your operating system, and
+the call and inputs that misbehave. Report security
+problems privately. See [SECURITY.md](./SECURITY.md).
+
+## Pull requests
+
+This package lives in [osdlc/osdlc](https://github.com/osdlc/osdlc) under
+`packages/ts/repo-cleaner`. Open pull requests there. They are reviewed and merged
+there.
+
+## Running the tests
+
+The repository is a pnpm workspace. Install from the repository root, then
+work in the package directory. The tests run on [Vitest](https://vitest.dev)
+under Node 22.22.2 or later. They run offline and need `git` on the PATH. Some
+tests build throwaway repositories in a temp directory, and a canned `gh`
+stands in for GitHub, so the tests need no network and no login. The package
+imports its sibling libraries through their built `dist/`, so run
+`pnpm run build` at the repository root first.
+
+```sh
+pnpm install
+pnpm run build
+cd packages/ts/repo-cleaner
+pnpm test
+```
+
+To run the CLI from a checkout, build the package and run
+`node bin/repo-cleaner.js --help`.
+
+Other checks:
+
+```sh
+pnpm run typecheck
+pnpm run lint
+pnpm run format:check
+```
+
+## Code style
+
+- TypeScript, ES modules, and explicit `.ts` import paths.
+- Prettier formats the code and oxlint checks it. Run `pnpm run format` and
+  `pnpm run lint` before you commit.
+- Add a test for each behaviour change or bug fix. Test against a throwaway
+  repository or a fake runner and check what ran.
+- Shell out only through the command seam, never with a raw `child_process`
+  call.
+- For a change users can see, add a changeset: run `pnpm changeset` at the
+  repository root. Start a breaking change's summary with `**Breaking:**`.
+  Do not edit `CHANGELOG.md` or `version` by hand. The release writes them.
+  See [packages/README.md](https://github.com/osdlc/osdlc/blob/main/packages/README.md).

package/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 sksizer
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 sksizer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.