leanprover / leanprover/lean4

RFC: Add lake clean --dry-run

Open
#2,740 0 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Lake P-medium RFC
Dominant language
Lean
Stars
9.2k
Forks
990
Avg merge
1d 17h
Merged PRs (30d)
175

Description

Proposal

lake clean (permanently) removes files off the filesystem.

Tools which do so often offer a --dry-run option so that the user can confirm they are removing what they expect, and only what they expect, gaining confidence that no bug or typo has snuck in.

For prior art, see git clean -n argument, which will print out the target files (and not remove anything).

lake clean --dry-run should do the same, simply printing without removing.

Community Feedback

Previously discussed here

Impact

Add 👍 to issues you consider important. If others benefit from the changes in this proposal being added, please ask them to add 👍 to it.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the lake clean CLI entry point and inspect how it identifies and removes target files, using the referenced git clean -n behavior as a comparison. Done means lake clean --dry-run prints the files that would be removed without changing the filesystem.

Written by the indexing model from the issue text.

Assessment

Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.