littensy / rbxts-jest

Delightful testing for Roblox TypeScript.

@rbxts/jest

TypeScript type definitions for Jest Lua.
npm package →

TypeScript type definitions for Jest Lua and roblox-ts, sourced from the official Jest types.

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

Note

Currently, installing @rbxts/jest will also install @rbxts/react-vendor as a dependency. While Jest Lua does not need React Lua to run, @rbxts/jest reuses the React vendor package to avoid duplicating React and other internal modules. This may change in the future.

Setup

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

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

Examples

TODO

License

This project is licensed under the MIT license.