feat: add --events option to diagram CLI#593
Merged
Conversation
The diagram CLI now supports `--events event1 event2 ...` to instantiate the machine and send events before rendering, matching the Sphinx directive's `:events:` option. The pre-commit hook uses this to generate the README diagram with the green state active.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #593 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 39 39
Lines 4591 4597 +6
Branches 732 734 +2
=========================================
+ Hits 4591 4597 +6
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
The YAML `>-` folding inserted a space in the `files:` regex, preventing the hook from matching `statemachine/contrib/diagram/` paths. Use a single-line string instead. Regenerate the README diagram with the green state highlighted.
|
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
1 participant
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
--eventsoption topython -m statemachine.contrib.diagramCLI to instantiate the machine and send events before rendering, highlighting the current active state--events cycle cycle cycleso the README TrafficLightMachine diagram shows the green state as active