rbxts-tester

CLI test runner for roblox-ts packages. Runs compiled .test.luau files using Lune — no Roblox Studio needed.

Installation

npm install -g rbxts-tester

Or run directly with npx:

npx rbxts-tester .

Usage

# Run tests in the current directory
rbxts-tester .

# Run tests in a specific project
rbxts-tester ./my-roblox-ts-lib

# Run tests with a relative path
rbxts-tester ../other-package

The project directory must contain:

• tsconfig.json with compilerOptions.outDir set
• Compiled .test.luau files in the outDir

How It Works

1. Reads tsconfig.json to find outDir
2. Builds a virtual Roblox Instance tree from compiled .luau files
3. Lazily detects and mounts node_modules/@rbxts packages
4. Loads the real roblox-ts RuntimeLib.lua for TS.import, TS.getModule, etc.
5. Runs each .test.luau file with a jest-like test framework (test, expect, testInit, runTests)

Writing Tests

// src/tests/my.test.ts
import { test, expect, testInit, runTests } from "../test";
import { myFunction } from "../myModule";

testInit(() => {
  print("Setting up...");
});

test("myFunction adds numbers", () => {
  expect(myFunction(2, 3)).toBe(5);
});

runTests();

Supported Packages

• Packages with root init.luau (e.g. @rbxts/charm, @rbxts/services)
• Packages with out/init.luau (e.g. @rbxts/zlib, @rbxts/base64)

Platform Support

• Linux (x86_64, aarch64)
• macOS (x86_64, aarch64)
• Windows (x86_64, aarch64)

License

MIT