-
Notifications
You must be signed in to change notification settings - Fork 7
Comments
Update setup instructions to be clear and add an example project#17
Update setup instructions to be clear and add an example project #17YetAnotherClown wants to merge 6 commits intojsdotlua:main from
Conversation
Documentation now provides clear instructions on how to use Jest Lua
...te-docs-add-example-game
@grilme99
grilme99
left a comment
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.
Thank you for this! Requested some changes.
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.
This isn't technically related to your PR, but debug.loadmodule is no longer necessary to run Jest, so that whole line can just be removed. Alternatively, you could add an info block that it is necessary in older versions.
run-in-roblox also isn't necessary anymore thanks to Open Cloud execution. Not sure if this is the best time to change that line though since we don't have a good out-of-the-box story for running Jest in Open Cloud yet. Thoughts?
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.
Oh, that's cool. I didn't know debug.loadmodule was no longer needed, I guess I need to update my dependencies.
As for run-in-roblox, I think we leave it for now and decide again on this in the future. I do think we could expand the documentation and provide the different options users have for running Jest in the future though.
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.
Could you change the example project to not be using Darklua? It complicates a minimal example and we'll also eventually be moving away from it for most Roblox code thanks to native string requires (though Jest doesn't support this yet.)
The current documentation provides setup instructions for Roblox Employees, this has been updated to provide usable examples for members of the community.
An example game has also been added in which the setup examples are used in, this provides a clear and usable example of how to use Jest Lua for a Roblox library.