feat: tell the user how to run suggested assertions#64
Merged
Conversation
After `suggest` writes the assertions file, print a follow-up hint line showing the exact `bioassert run <path>` command, with a nudge to review and tighten the heuristic suggestions first. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the UX of bioassert suggest <file> by printing an explicit next-step hint after writing the generated assertions file, and updates the suggest specification to document the new two-line success output.
Changes:
- Add a follow-up
println!inrun_suggestthat tells users exactly how to run the generated assertions file. - Update
specs/suggest.mdto document the new hint line in the success message format.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
src/main.rs |
Prints an additional success hint showing the exact bioassert run <path> command after generating assertions. |
specs/suggest.md |
Documents the updated stdout message format to include the new hint line. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+125
to
+128
| println!( | ||
| "Review and tighten them, then run: bioassert run {}", | ||
| output_path.display() | ||
| ); |
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.
What
After
bioassert suggest <file>writes the assertions file, it now prints a follow-up hint line showing exactly how to run the result:Previously it only printed the
Wrote N assertions to <path>line, leaving the next step implicit. The hint also nudges the author to review and tighten the heuristic suggestions before relying on them, matching the design philosophy that suggestions are guesses from the current file rather than verified expectations.Changes
src/main.rs— add a secondprintln!after the "Wrote" line inrun_suggest.specs/suggest.md— document the new hint line in the message-format sections.Testing
cargo buildclean.cargo test suggest— all 5 suggest integration tests pass. The success message is not snapshotted, so no snapshots needed updating.🤖 Generated with Claude Code