TypeScript type definitions for Jest Lua and roblox-ts, sourced from the official Jest types. Currently, jest and jest-globals are ported, while jest-benchmark is not yet available.

See the Jest Lua documentation for more information on how to use Jest Lua.

Setup

Install Jest and Jest Globals with your package manager of choice:

npm install @rbxts/jest @rbxts/jest-globals
yarn add @rbxts/jest @rbxts/jest-globals
pnpm add @rbxts/jest @rbxts/jest-globals # 🛑 See below

Then, add the following to your Rojo project file, under the node_modules folder:

"node_modules": {
  "$className": "Folder",
  "@rbxts": {
    "$path": "node_modules/@rbxts"
  },
  "@rbxts-js": {
    "$path": "node_modules/@rbxts-js"
  }
}

Usage with pnpm

If you're using pnpm as your package manager, you'll need to create a .npmrc file in the root of your project with the following content:

node-linker=hoisted

License

This project is licensed under the MIT license.