@isentinel/jest-roblox 0.0.1

package/bin/jest-roblox.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { main } from "../dist/cli.mjs";
+
+main();

package/dist/cli.d.mts

@@ -0,0 +1,8 @@
+import { t as CliOptions } from "./schema-ryuVGD35.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>;
+//#endregion
+export { main, parseArgs, run };

package/dist/cli.mjs

@@ -0,0 +1,281 @@
+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-BKBGosEI.mjs";
+import * as path$1 from "node:path";
+import process from "node:process";
+import { parseArgs as parseArgs$1 } from "node:util";
+import * as fs from "node:fs";
+
+//#region package.json
+var version = "0.0.1";
+
+//#endregion
+//#region src/utils/glob.ts
+function globSync(pattern, options = {}) {
+	const cwd = options.cwd ?? process.cwd();
+	return walkDirectory(cwd, cwd).filter((file) => matchesGlobPattern(file, pattern));
+}
+function matchesGlobPattern(filePath, pattern) {
+	const regexPattern = pattern.replace(/\./g, "\\.").replace(/\*\*/g, "{{DOUBLESTAR}}").replace(/\*/g, "[^/]*").replace(/\{\{DOUBLESTAR\}\}/g, ".*");
+	return new RegExp(`^${regexPattern}$`).test(filePath);
+}
+function walkDirectory(directoryPath, baseDirectory) {
+	const results = [];
+	try {
+		const entries = fs.readdirSync(directoryPath, { withFileTypes: true });
+		for (const entry of entries) {
+			const fullPath = path$1.join(directoryPath, entry.name);
+			const relativePath = path$1.relative(baseDirectory, fullPath).replace(/\\/g, "/");
+			if (entry.isDirectory()) {
+				if (!entry.name.startsWith(".") && entry.name !== "node_modules") results.push(...walkDirectory(fullPath, baseDirectory));
+			} else results.push(relativePath);
+		}
+	} catch {}
+	return results;
+}
+
+//#endregion
+//#region src/cli.ts
+const HELP_TEXT = `
+Usage: jest-roblox [options] [files...]
+
+Options:
+  --backend <type>          Backend: "open-cloud" or "studio" (default: open-cloud)
+  --port <number>           WebSocket port for studio backend (default: 3001)
+  --config <path>           Path to config file
+  --testPathPattern <regex> Filter test files by path pattern
+  -t, --testNamePattern <regex>  Filter tests by name pattern
+  --json                    Output results as JSON
+  --compact                 Token-efficient output for AI consumption
+  --compactMaxFailures <n>  Max failures in compact mode (default: 10)
+  --outputFile <path>       Write results to file
+  --gameOutput <path>       Write game output (print/warn/error) to file
+  --sourceMap               Map Luau stack traces to TypeScript source
+  --rojoProject <path>      Path to rojo project file (auto-detected if not set)
+  --verbose                 Show individual test results
+  --silent                  Suppress output
+  --no-color                Disable colored output
+  --no-cache                Force re-upload place file (skip cache)
+  --pollInterval <ms>       Open Cloud poll interval in ms (default: 500)
+  --projects <path...>      DataModel paths to search for tests
+  --setupFiles <path...>    DataModel paths to setup scripts
+  --no-show-luau            Hide Luau code in failure output
+  --help                    Show this help message
+  --version                 Show version number
+
+Environment Variables (open-cloud backend only):
+  ROBLOX_OPEN_CLOUD_API_KEY  API key for Roblox Open Cloud
+  ROBLOX_UNIVERSE_ID         Target universe ID
+  ROBLOX_PLACE_ID            Target place ID
+
+Examples:
+  jest-roblox                         Run all tests (open-cloud)
+  jest-roblox --backend studio        Run tests via Studio plugin
+  jest-roblox src/player.spec.ts      Run specific test file
+  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,
+		args,
+		options: {
+			"backend": { type: "string" },
+			"cache": { type: "boolean" },
+			"color": { type: "boolean" },
+			"compact": { type: "boolean" },
+			"compactMaxFailures": { type: "string" },
+			"config": { type: "string" },
+			"gameOutput": { type: "string" },
+			"help": {
+				default: false,
+				type: "boolean"
+			},
+			"json": { type: "boolean" },
+			"no-cache": { type: "boolean" },
+			"no-color": { type: "boolean" },
+			"no-show-luau": { type: "boolean" },
+			"outputFile": { type: "string" },
+			"pollInterval": { type: "string" },
+			"port": { type: "string" },
+			"projects": {
+				multiple: true,
+				type: "string"
+			},
+			"rojoProject": { type: "string" },
+			"setupFiles": {
+				multiple: true,
+				type: "string"
+			},
+			"showLuau": { type: "boolean" },
+			"silent": { type: "boolean" },
+			"sourceMap": { type: "boolean" },
+			"testNamePattern": {
+				short: "t",
+				type: "string"
+			},
+			"testPathPattern": { type: "string" },
+			"timeout": { type: "string" },
+			"verbose": { type: "boolean" },
+			"version": {
+				default: false,
+				type: "boolean"
+			}
+		},
+		strict: true
+	});
+	const compactMaxFailures = values.compactMaxFailures !== void 0 ? Number.parseInt(values.compactMaxFailures, 10) : void 0;
+	const pollInterval = values.pollInterval !== void 0 ? Number.parseInt(values.pollInterval, 10) : void 0;
+	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,
+		cache: values["no-cache"] === true ? false : values.cache,
+		color: values["no-color"] === true ? false : values.color,
+		compact: values.compact,
+		compactMaxFailures,
+		config: values.config,
+		files: positionals.length > 0 ? positionals : void 0,
+		gameOutput: values.gameOutput,
+		help: values.help,
+		json: values.json,
+		outputFile: values.outputFile,
+		pollInterval,
+		port,
+		projects: values.projects,
+		rojoProject: values.rojoProject,
+		setupFiles: values.setupFiles,
+		showLuau: values["no-show-luau"] === true ? false : values.showLuau,
+		silent: values.silent,
+		sourceMap: values.sourceMap,
+		testNamePattern: values.testNamePattern,
+		testPathPattern: values.testPathPattern,
+		timeout,
+		verbose: values.verbose,
+		version: values.version
+	};
+}
+async function run(args) {
+	try {
+		return await runInner(args);
+	} catch (err) {
+		printError(err);
+		return 2;
+	}
+}
+function printError(err) {
+	if (err instanceof LuauScriptError) {
+		const hint = getLuauErrorHint(err.message);
+		console.error(`\n  Luau script error: ${err.message}`);
+		if (hint !== void 0) console.error(`  Hint: ${hint}`);
+		console.error();
+	} else if (err instanceof Error) console.error(`Error: ${err.message}`);
+	else console.error("An unknown error occurred");
+}
+async function runInner(args) {
+	const cli = parseArgs(args);
+	if (cli.help === true) {
+		console.log(HELP_TEXT);
+		return 0;
+	}
+	if (cli.version === true) {
+		console.log(version);
+		return 0;
+	}
+	const config = mergeCliWithConfig(cli, await loadConfig(cli.config));
+	const discovery = discoverTestFiles(config, cli.files);
+	if (discovery.files.length === 0) {
+		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: config.backend === "studio" ? createStudioBackend({
+			port: config.port,
+			timeout: config.timeout
+		}) : createOpenCloudBackend(),
+		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 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."]
+];
+function discoverTestFiles(config, cliFiles) {
+	if (cliFiles && cliFiles.length > 0) {
+		const files = cliFiles.map((file) => path$1.resolve(config.rootDir, file));
+		return {
+			files,
+			totalFiles: files.length
+		};
+	}
+	const allFiles = [];
+	for (const pattern of config.testMatch) {
+		const matches = globSync(pattern, { cwd: config.rootDir });
+		allFiles.push(...matches);
+	}
+	const ignoredPatterns = config.testPathIgnorePatterns.map((pat) => new RegExp(pat));
+	const baseFiles = allFiles.filter((file) => {
+		return !ignoredPatterns.some((pattern) => pattern.test(file));
+	});
+	const totalFiles = new Set(baseFiles).size;
+	let filtered = baseFiles;
+	if (config.testPathPattern !== void 0) {
+		const pathPattern = new RegExp(config.testPathPattern);
+		filtered = filtered.filter((file) => pathPattern.test(file));
+	}
+	return {
+		files: [...new Set(filtered)],
+		totalFiles
+	};
+}
+function getLuauErrorHint(message) {
+	for (const [pattern, hint] of LUAU_ERROR_HINTS) if (pattern.test(message)) return hint;
+}
+function mergeCliWithConfig(cli, config) {
+	return {
+		...config,
+		backend: cli.backend ?? config.backend,
+		cache: cli.cache ?? config.cache,
+		color: cli.color ?? config.color,
+		compact: cli.compact ?? config.compact,
+		compactMaxFailures: cli.compactMaxFailures ?? config.compactMaxFailures,
+		gameOutput: cli.gameOutput ?? config.gameOutput,
+		json: cli.json ?? config.json,
+		outputFile: cli.outputFile ?? config.outputFile,
+		pollInterval: cli.pollInterval ?? config.pollInterval,
+		port: cli.port ?? config.port,
+		projects: cli.projects ?? config.projects,
+		rojoProject: cli.rojoProject ?? config.rojoProject,
+		setupFiles: cli.setupFiles ?? config.setupFiles,
+		showLuau: cli.showLuau ?? config.showLuau,
+		silent: cli.silent ?? config.silent,
+		sourceMap: cli.sourceMap ?? config.sourceMap,
+		testNamePattern: cli.testNamePattern ?? config.testNamePattern,
+		testPathPattern: cli.testPathPattern ?? config.testPathPattern,
+		timeout: cli.timeout ?? config.timeout,
+		verbose: cli.verbose ?? config.verbose
+	};
+}
+
+//#endregion
+export { main, parseArgs, run };