cli: add --watch-cleanup to remove output file on exit - #2788
Open
25hash wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a
--watch-cleanupflag ford2 --watch.When the flag is enabled, exiting watch mode with
Ctrl-Cremoves the generated output file. Without the flag, watch mode keeps the current behavior and leaves the output in place.Example:
Motivation
When using
d2 --watch, the generated.svgis often just a temporary preview artifact. Today it remains on disk after watch mode exits, which can leave behind files the user did not intend to keep.This change makes cleanup explicit and opt-in:
d2 --watch ...keeps the outputd2 --watch --watch-cleanup ...removes the output on exitChanges
--watch-cleanupCLI flagpress Ctrl-C to quitpress Ctrl-C to quit and remove ...when cleanup is enabledCtrl-C+ cleanup behaviorBehavior
Default behavior
Ctrl-Cout.svgremains on diskCleanup behavior
Ctrl-Cout.svgis removed on exitNotes
This is intentionally opt-in so existing workflows do not change.
Testing
Ran: