jsdotlua / legacy-jest-lua Goto Github PK

PrettyFormat currently depends on ReactIs, but that package is not yet published.

The utils.lua file in jest-snapshot defines a function for saving snapshot files to disk. However, this method depends on FileSystemService, which is an internal-only Roblox service. We should update this file to support the desired behaviour in more environments.

Before Jest can run in Lua environments other than Roblox's, it has to be decoupled from the Roblox datamodel. Primarily, this means:

• All require calls should have their Instance paths replaced with file system strings.
• Darklua should be used during the build/release pipeline to convert the string requires back to Instances for Roblox users.
• Once the string requires work and pass all tests, internal structures in Jest should then be decoupled from the datamodel. This is a much larger effort, as Roblox changed all file system references to their datamodel equivalent. Whatever solution we come up with here needs to be backwards-compatible for Roblox users. All environments must be supported (command line and Roblox).

This is a major goal for this project, as many Lua users outside of Roblox would benefit from the full Jest testing suite. Contributors are welcome and appreciated for parts of this issue.

Snapshot tests currently depend on CoreScriptSyncService and FileSystemService to read/write files and resolve the file path of scripts in the datamodel. These are internal Roblox services that developers typically don't have access to. This behaviour should be replaced by something else, but it's not clear what.

Snapshot Testing is completely unavailable until Roblox's internal behaviour is pulled out and replaced. Currently, Snapshot Tests can only run via roblox-cli, a command line tool only available to Roblox engineers.