@isentinel/jest-roblox 0.0.3 → 0.0.4

package/dist/cli.d.mts

@@ -1,8 +1,8 @@
-import { t as CliOptions } from "./schema-hhbEFVXy.mjs";
+import { t as CliOptions } from "./schema-ua9HqdbX.mjs";
 
 //#region src/cli.d.ts
-declare function main(): Promise<void>;
 declare function parseArgs(args: Array<string>): CliOptions;
 declare function run(args: Array<string>): Promise<number>;
+declare function main(): Promise<void>;
 //#endregion
 export { main, parseArgs, run };

package/dist/cli.mjs

@@ -1,4 +1,4 @@
-import { g as createOpenCloudBackend, i as execute, m as createStudioBackend, n as parseGameOutput, o as writeJsonFile, r as writeGameOutput, t as formatGameOutputNotice, u as loadConfig, y as LuauScriptError } from "./game-output--EpqHGEr.mjs";
+import { S as LuauScriptError, _ as createStudioBackend, a as execute, d as loadConfig, h as isValidBackend, i as runTypecheck, m as VALID_BACKENDS, n as parseGameOutput, r as writeGameOutput, s as writeJsonFile, t as formatGameOutputNotice, y as createOpenCloudBackend } from "./game-output-DO5fOpW3.mjs";
 import * as path$1 from "node:path";
 import process from "node:process";
 import { parseArgs as parseArgs$1 } from "node:util";
@@ -6,7 +6,7 @@ import { WebSocketServer } from "ws";
 import * as fs from "node:fs";
 
 //#region package.json
-var version = "0.0.3";
+var version = "0.0.4";
 
 //#endregion
 //#region src/backends/auto.ts
@@ -38,17 +38,20 @@ async function probeStudioPlugin(port, timeoutMs, createServer = (wsPort) => {
 		const wss = createServer(port);
 		const timer = setTimeout(() => {
 			wss.close();
-			resolve(false);
+			resolve({ detected: false });
 		}, timeoutMs);
-		wss.on("connection", () => {
+		wss.on("connection", (ws) => {
 			clearTimeout(timer);
-			wss.close();
-			resolve(true);
+			resolve({
+				detected: true,
+				server: wss,
+				socket: ws
+			});
 		});
 		wss.on("error", () => {
 			clearTimeout(timer);
 			wss.close();
-			resolve(false);
+			resolve({ detected: false });
 		});
 	});
 }
@@ -58,10 +61,15 @@ async function resolveBackend(config, probe = probeStudioPlugin) {
 		timeout: config.timeout
 	});
 	if (config.backend === "open-cloud") return createOpenCloudBackend();
-	if (await probe(config.port, 500)) {
+	const probeResult = await probe(config.port, 500);
+	if (probeResult.detected) {
 		process.stderr.write("Backend: studio (plugin detected)\n");
 		const studio = createStudioBackend({
 			port: config.port,
+			preConnected: {
+				server: probeResult.server,
+				socket: probeResult.socket
+			},
 			timeout: config.timeout
 		});
 		if (hasOpenCloudCredentials()) return new StudioWithFallback(studio);
@@ -77,40 +85,6 @@ function hasOpenCloudCredentials() {
 	return process.env["ROBLOX_OPEN_CLOUD_API_KEY"] !== void 0 && process.env["ROBLOX_UNIVERSE_ID"] !== void 0 && process.env["ROBLOX_PLACE_ID"] !== void 0;
 }
 
-//#endregion
-//#region src/patch.ts
-const PATCH_MARKER = "-- jest-roblox-cli patch: enable snapshot mock override";
-const PATCH_LINES = `${PATCH_MARKER}
-if _G.__mockGetDataModelService then
-\treturn _G.__mockGetDataModelService
-end
-
-`;
-const PACKAGE_SUBPATH = path$1.join("node_modules", "@rbxts-js", "roblox-shared", "src", "getDataModelService.lua");
-function patchGetDataModelService(rootDirectory) {
-	const filePath = findSourceFile(rootDirectory);
-	const content = fs.readFileSync(filePath, "utf-8");
-	if (content.includes(PATCH_MARKER)) return {
-		filePath,
-		status: "already-patched"
-	};
-	fs.writeFileSync(filePath, PATCH_LINES + content);
-	return {
-		filePath,
-		status: "patched"
-	};
-}
-function findSourceFile(rootDirectory) {
-	let current = path$1.resolve(rootDirectory);
-	const { root } = path$1.parse(current);
-	while (current !== root) {
-		const candidate = path$1.join(current, PACKAGE_SUBPATH);
-		if (fs.existsSync(candidate)) return candidate;
-		current = path$1.dirname(current);
-	}
-	throw new Error(`Cannot find @rbxts-js/roblox-shared. Searched from ${rootDirectory} to filesystem root.`);
-}
-
 //#endregion
 //#region src/utils/glob.ts
 function globSync(pattern, options = {}) {
@@ -138,6 +112,7 @@ function walkDirectory(directoryPath, baseDirectory) {
 
 //#endregion
 //#region src/cli.ts
+const TYPE_TEST_PATTERN = /\.(test-d|spec-d)\.ts$/;
 const HELP_TEXT = `
 Usage: jest-roblox [options] [files...]
 
@@ -164,6 +139,9 @@ Options:
   --setupFiles <path...>    DataModel paths to setup scripts
   --setupFilesAfterEnv <path...>  DataModel paths to post-env setup scripts
   --no-show-luau            Hide Luau code in failure output
+  --typecheck               Enable type testing (*.test-d.ts, *.spec-d.ts)
+  --typecheckOnly           Run only type tests, skip runtime tests
+  --typecheckTsconfig <path>  tsconfig for type testing
   --help                    Show this help message
   --version                 Show version number
 
@@ -179,10 +157,6 @@ Examples:
   jest-roblox -t "should spawn"       Run tests matching pattern
   jest-roblox --json --outputFile results.json
 `;
-async function main() {
-	const exitCode = await run(process.argv.slice(2));
-	process.exit(exitCode);
-}
 function parseArgs(args) {
 	const { positionals, values } = parseArgs$1({
 		allowPositionals: true,
@@ -228,6 +202,9 @@ function parseArgs(args) {
 			},
 			"testPathPattern": { type: "string" },
 			"timeout": { type: "string" },
+			"typecheck": { type: "boolean" },
+			"typecheckOnly": { type: "boolean" },
+			"typecheckTsconfig": { type: "string" },
 			"updateSnapshot": {
 				short: "u",
 				type: "boolean"
@@ -245,7 +222,7 @@ function parseArgs(args) {
 	const port = values.port !== void 0 ? Number.parseInt(values.port, 10) : void 0;
 	const timeout = values.timeout !== void 0 ? Number.parseInt(values.timeout, 10) : void 0;
 	return {
-		backend: values.backend,
+		backend: validateBackend(values.backend),
 		cache: values["no-cache"] === true ? false : values.cache,
 		color: values["no-color"] === true ? false : values.color,
 		compact: values.compact,
@@ -268,6 +245,9 @@ function parseArgs(args) {
 		testNamePattern: values.testNamePattern,
 		testPathPattern: values.testPathPattern,
 		timeout,
+		typecheck: values.typecheckOnly === true ? true : values.typecheck,
+		typecheckOnly: values.typecheckOnly,
+		typecheckTsconfig: values.typecheckTsconfig,
 		updateSnapshot: values.updateSnapshot,
 		verbose: values.verbose,
 		version: values.version
@@ -281,6 +261,10 @@ async function run(args) {
 		return 2;
 	}
 }
+async function main() {
+	const exitCode = await run(process.argv.slice(2));
+	process.exit(exitCode);
+}
 function printError(err) {
 	if (err instanceof LuauScriptError) {
 		const hint = getLuauErrorHint(err.message);
@@ -290,8 +274,33 @@ function printError(err) {
 	} else if (err instanceof Error) console.error(`Error: ${err.message}`);
 	else console.error("An unknown error occurred");
 }
+async function executeRuntimeTests(config, testFiles, totalFiles) {
+	if (!config.silent && (!config.compact || config.verbose) && !config.json && testFiles.length !== totalFiles) process.stderr.write(`Running ${String(testFiles.length)} of ${String(totalFiles)} test files\n`);
+	return execute({
+		backend: await resolveBackend(config),
+		config,
+		testFiles,
+		version
+	});
+}
+function writeGameOutputIfConfigured(config, gameOutput, options) {
+	if (config.gameOutput === void 0) return;
+	const entries = parseGameOutput(gameOutput);
+	writeGameOutput(config.gameOutput, entries);
+	if (!config.silent && options.hintsShown !== true) {
+		const notice = formatGameOutputNotice(config.gameOutput, entries.length);
+		if (notice) console.error(notice);
+	}
+}
+async function outputResults(config, typecheckResult, runtimeResult) {
+	const mergedResult = mergeResults(typecheckResult, runtimeResult?.result);
+	if (runtimeResult !== void 0 && runtimeResult.output !== "") console.log(runtimeResult.output);
+	if (typecheckResult !== void 0 && !config.silent) printTypecheckSummary(typecheckResult);
+	if (config.outputFile !== void 0) await writeJsonFile(mergedResult, config.outputFile);
+	if (runtimeResult !== void 0) writeGameOutputIfConfigured(config, runtimeResult.gameOutput, { hintsShown: !mergedResult.success });
+	return mergedResult.success ? 0 : 1;
+}
 async function runInner(args) {
-	if (args[0] === "patch") return runPatch();
 	const cli = parseArgs(args);
 	if (cli.help === true) {
 		console.log(HELP_TEXT);
@@ -307,32 +316,24 @@ async function runInner(args) {
 		console.error("No test files found");
 		return 2;
 	}
-	if (!config.silent && !config.compact && !config.json && discovery.files.length !== discovery.totalFiles) process.stderr.write(`Running ${discovery.files.length} of ${discovery.totalFiles} test files\n`);
-	const result = await execute({
-		backend: await resolveBackend(config),
-		config,
-		testFiles: discovery.files,
-		version
-	});
-	if (result.output) console.log(result.output);
-	if (config.outputFile !== void 0) await writeJsonFile(result.result, config.outputFile);
-	writeGameOutputIfConfigured(config, result.gameOutput);
-	return result.exitCode;
-}
-function writeGameOutputIfConfigured(config, gameOutput) {
-	if (config.gameOutput === void 0) return;
-	const entries = parseGameOutput(gameOutput);
-	writeGameOutput(config.gameOutput, entries);
-	if (!config.silent) {
-		const notice = formatGameOutputNotice(config.gameOutput, entries.length);
-		if (notice) console.error(notice);
+	const typeTestFiles = config.typecheck ? discovery.files.filter((file) => TYPE_TEST_PATTERN.test(file)) : [];
+	const runtimeTestFiles = config.typecheckOnly ? [] : discovery.files.filter((file) => !TYPE_TEST_PATTERN.test(file));
+	if (typeTestFiles.length === 0 && runtimeTestFiles.length === 0) {
+		console.error("No test files found for the selected mode");
+		return 2;
 	}
+	return outputResults(config, typeTestFiles.length > 0 ? runTypecheck({
+		files: typeTestFiles,
+		rootDir: config.rootDir,
+		tsconfig: config.typecheckTsconfig
+	}) : void 0, runtimeTestFiles.length > 0 ? await executeRuntimeTests(config, runtimeTestFiles, discovery.totalFiles) : void 0);
 }
 const LUAU_ERROR_HINTS = [
 	[/Failed to find Jest instance in ReplicatedStorage/, "Set \"jestPath\" in your config to specify the Jest module location, e.g. \"ReplicatedStorage/rbxts_include/node_modules/@rbxts/jest/src\""],
 	[/Failed to find Jest instance at path/, "The configured jestPath does not resolve to a valid instance. Verify the path matches your Rojo project tree."],
 	[/Failed to find service/, "The first segment of jestPath must be a valid Roblox service name (e.g. ReplicatedStorage, ServerScriptService)."],
-	[/No projects configured/, "Set \"projects\" in jest.config.ts (e.g. [\"ReplicatedStorage/client\", \"ServerScriptService/server\"]) or pass --projects."]
+	[/No projects configured/, "Set \"projects\" in jest.config.ts (e.g. [\"ReplicatedStorage/client\", \"ServerScriptService/server\"]) or pass --projects."],
+	[/Infinite yield detected/, "A :WaitForChild() call is waiting for an instance that doesn't exist. Check your DataModel paths and Rojo project configuration."]
 ];
 function discoverTestFiles(config, cliFiles) {
 	if (cliFiles && cliFiles.length > 0) {
@@ -362,6 +363,14 @@ function discoverTestFiles(config, cliFiles) {
 		totalFiles
 	};
 }
+function validateBackend(value) {
+	if (value === void 0) return;
+	if (!isValidBackend(value)) {
+		const valid = [...VALID_BACKENDS].join(", ");
+		throw new Error(`Invalid backend "${value}". Must be one of: ${valid}`);
+	}
+	return value;
+}
 function getLuauErrorHint(message) {
 	for (const [pattern, hint] of LUAU_ERROR_HINTS) if (pattern.test(message)) return hint;
 }
@@ -388,18 +397,41 @@ function mergeCliWithConfig(cli, config) {
 		testNamePattern: cli.testNamePattern ?? config.testNamePattern,
 		testPathPattern: cli.testPathPattern ?? config.testPathPattern,
 		timeout: cli.timeout ?? config.timeout,
+		typecheck: cli.typecheck ?? config.typecheck,
+		typecheckOnly: cli.typecheckOnly ?? config.typecheckOnly,
+		typecheckTsconfig: cli.typecheckTsconfig ?? config.typecheckTsconfig,
 		updateSnapshot: cli.updateSnapshot ?? config.updateSnapshot,
 		verbose: cli.verbose ?? config.verbose
 	};
 }
-function runPatch() {
-	const result = patchGetDataModelService(process.cwd());
-	if (result.status === "already-patched") console.log(`Already patched: ${result.filePath}`);
-	else {
-		console.log(`Patched: ${result.filePath}`);
-		console.log("Rebuild your .rbxl to include the patch.");
+function mergeResults(typecheck, runtime) {
+	if (typecheck !== void 0 && runtime !== void 0) return {
+		numFailedTests: typecheck.numFailedTests + runtime.numFailedTests,
+		numPassedTests: typecheck.numPassedTests + runtime.numPassedTests,
+		numPendingTests: typecheck.numPendingTests + runtime.numPendingTests,
+		numTotalTests: typecheck.numTotalTests + runtime.numTotalTests,
+		startTime: Math.min(typecheck.startTime, runtime.startTime),
+		success: typecheck.success && runtime.success,
+		testResults: [...typecheck.testResults, ...runtime.testResults]
+	};
+	if (typecheck !== void 0) return typecheck;
+	if (runtime !== void 0) return runtime;
+	throw new Error("mergeResults requires at least one result");
+}
+function printTypecheckFailures(result) {
+	for (const file of result.testResults) for (const test of file.testResults) {
+		if (test.status !== "failed") continue;
+		process.stderr.write(`  FAIL ${test.fullName}\n`);
+		for (const message of test.failureMessages) process.stderr.write(`    ${message}\n`);
 	}
-	return 0;
+}
+function printTypecheckSummary(result) {
+	const passed = result.numPassedTests;
+	const failed = result.numFailedTests;
+	const total = result.numTotalTests;
+	if (failed > 0) printTypecheckFailures(result);
+	const failedPart = failed > 0 ? `${String(failed)} failed, ` : "";
+	process.stderr.write(`\nType Tests: ${failedPart}${String(passed)} passed, ${String(total)} total\n`);
 }
 
 //#endregion