Skip to content

jsdotlua/jest-lua

 
 

Repository files navigation

Jest Lua

Delightful Lua Testing.

Tests Docs


Jest Lua can currently only run inside of Roblox. Help is wanted to get it running in other Lua environments, such as Lune or Luvit. See issue #2.

Roblox uses Jest Lua internally for testing their apps, in-game core scripts, built-in Roblox Studio plugins, as well as libraries like Roact Navigation. This library should be considered battle-tested and ready for production use.


Installation

Add this package to your dev-dependencies in your wally.toml, for example:

JestGlobals = "jsdotlua/jest-globals@3.6.1-rc.2"

Then, require anything you need from JestGlobals:

local JestGlobals = require("@Packages/JestGlobals")
local expect = JestGlobals.expect

Inspiration and Prior Work

Jest Lua is a Lua port of the open source JavaScript testing framework Jest. Modules in the modules directory are aligned to v27.4.7 of Jest.

Contributing

Contributions are welcome! See CONTRIBUTING.md for information.

License

Jest Lua is available under the MIT license. See LICENSE for details.