-
Notifications
You must be signed in to change notification settings - Fork 59
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
LUAFDN-1706 Add support for devtools #84
Merged
Merged
Conversation
This file contains 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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good so far. This should be easy to test, right?
…its/rodux into LUAFDN-1706/devtools-support
ZoteTheMighty
approved these changes
Aug 22, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work! Thanks for updating the CI :)
zovits
added a commit
to zovits/rodux
that referenced
this pull request
Aug 22, 2023
Co-authored-by: Paul Doyle <[email protected]>
ZoteTheMighty
added a commit
that referenced
this pull request
Aug 22, 2023
* LUAFDN-1706 Add support for devtools (#84) Co-authored-by: Paul Doyle <[email protected]> * Bump version * Don't add types * Run CI on anything * Add changelog * Just run tests please * Add test runners --------- Co-authored-by: Zack Ovits <[email protected]> Co-authored-by: zovits <[email protected]>
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.
(This PR also fixes up the CI since it was old and non-functional)
There is currently no proper way to log or profile Rodux store actions or performance. We need to provide insight into Rodux for our engineers to be able to write high quality Rodux usages.
This PR makes such a tool possible.
The fourth argument to
Store.new
takes a devtools object that you can optionally provide. A devtools object has only two requirements:devtools.__className
must be"Devtools"
anddevtools:_hookIntoStore(store)
must be a valid function call. Beyond that, your devtools can be anything you need it to be.Devtools can be very useful during development in gathering performance data, providing introspection, debugging, etc. We leave the devtools implementation up to the user in order to support any and all use cases, such as store modification in unit testing, live state inspection plugins, and whatever else you come up with.
A simple example of a devtools that profiles and logs: