jest

Automate Roblox Luau testing with Jest Roblox mocks and assertions.

Updated Feb 12, 2026
One-click install
npx skills add https://github.com/christopher-buss/rbxts-transformer-jest --skill jest-christopher-buss
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: jest
Source: https://github.com/christopher-buss/rbxts-transformer-jest/tree/main/.agents/skills/jest
Command: npx skills add https://github.com/christopher-buss/rbxts-transformer-jest --skill jest-christopher-buss

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Roblox Lua testing often lacks a cohesive framework that respects Luau's quirks and Roblox platform constraints. Jest Roblox provides a Jest-like testing experience adapted for Luau, offering mocks, assertions, and test structure that align with Roblox development workflows.

Core Features & Use Cases

  • Jest-style APIs (jest.fn, expect, describe/it) tailored for Luau and Roblox projects.
  • Handles Luau deviations such as .never vs .not and two-value returns from jest.fn, plus explicit imports from @rbxts/jest-globals.
  • Use cases include unit testing modules, mocking dependencies, validating game logic, and building robust test suites for Roblox experiences.

Quick Start

Install and configure Jest Roblox in your project, then start writing tests with describe and it blocks using expect.

Frequently Asked Questions about jest

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write unit tests for Roblox Luau modules using a Jest-style framework?

To test Roblox Luau modules, use Jest Roblox to structure tests with describe and it blocks, apply expect assertions, and import testing functions explicitly from @rbxts/jest-globals to validate game logic and module behavior.

What Luau-specific deviations does Jest Roblox handle compared to standard Jest?

Jest Roblox accommodates Luau deviations by replacing .not with .never for negated assertions and supporting two-value returns from jest.fn, ensuring the testing framework aligns with Luau syntax and Roblox platform constraints.

How do I mock dependencies in Roblox Lua integration tests?

Mock dependencies in Roblox Lua integration tests by using jest.fn from Jest Roblox, which returns two values tailored for Luau, allowing you to isolate modules, simulate interactions, and validate function calls within your test suites.

Can I use standard Jest matchers for assertions in a Roblox testing environment?

You can use Jest-style expect assertions and custom matchers adapted for Luau rather than standard Jest matchers. Jest Roblox provides these tailored APIs to satisfy Roblox platform constraints, including specific deviations like using .never instead of .not.

What do I need to set up before running Roblox Luau testing with Jest Roblox?

Before running Roblox Luau testing, you must install and configure Jest Roblox in your project and use explicit imports from @rbxts/jest-globals to access the required testing APIs, mocks, and assertions for your test suites.