jest-roblox-assassin 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 evil bocchi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+# jest-roblox assassin
+
+jestrbx is a CLI tool for running Jest-style tests against Roblox places, wrapping the Roblox Jest runtime and rewriting results for local source paths. It is designed to integrate with roblox-ts and Rojo workflows, providing a familiar Jest experience for Roblox game development.
+
+## Features
+- Runs Jest tests inside Roblox places using the JestCore runtime
+- Maps Roblox datamodel paths back to local workspace files for readable output
+- Supports custom and built-in Jest reporters
+- CLI options are dynamically pulled from Roblox Jest docs
+- Integrates with roblox-ts, Rojo, and standard TypeScript workflows
+- Handles source mapping for .ts, .tsx, .lua, and .luau files
+- Filters tests by name or path
+- Supports parallel execution through `--maxWorkers`
+
+## Getting Started
+
+### Prerequisites
+- Node.js (v16+ recommended)
+- roblox-ts and Rojo (for TypeScript workflows)
+
+### Installation
+Clone this repository and install dependencies:
+
+```sh
+npm install
+```
+
+### Usage
+Run tests against a Roblox place file:
+
+```sh
+npx jestrbx --place path/to/place.rbxl
+```
+
+#### Common CLI Options
+- `--place <file>`: Path to the Roblox place file (required)
+- `--project <dir>`: Path to the Rojo project file (optional)
+- `--config <file>`: Path to a Jest config file. This is usually used to specify reporter options (optional)
+- `--testNamePattern <pattern>`: Filter tests by name
+- `--reporters <reporter>`: Use custom or built-in reporters
+- `--maxWorkers <num>`: Number of worker threads to use for parallel test execution
+
+For a full list of options, run:
+
+```sh
+npx jestrbx --help
+```
+
+### Example Project
+See the `demo/` directory for a sample roblox-ts project with Jest specs:
+- `demo/src/jest.config.ts`: Jest config
+- `demo/src/setup.luau`: Setup script
+- `demo/src/__tests__/`: Test specs
+
+Build and test with:
+
+```sh
+cd demo
+npm run build   # Builds with roblox-ts and Rojo
+npm test        # Runs tests with jest-roblox-assassin
+```
+
+## License
+MIT

package/package.json

@@ -0,0 +1,36 @@
+{
+    "name": "jest-roblox-assassin",
+    "version": "1.0.0",
+    "description": "Delightful Roblox testing.",
+    "license": "MIT",
+    "author": "evilbocchi",
+    "type": "module",
+    "main": "src/index.js",
+    "bin": {
+        "jestrbx": "src/cli.js"
+    },
+    "repository": {
+        "url": "https://github.com/Unreal-Works/jest-roblox-assassin.git",
+        "type": "git"
+    },
+    "scripts": {
+        "test": "vitest run",
+        "test:watch": "vitest",
+        "test:ui": "vitest --ui",
+        "test:coverage": "vitest run --coverage",
+        "demo": "cd demo && npm run test"
+    },
+    "dependencies": {
+        "@jest/reporters": "^30.2.0",
+        "chalk": "^5.6.2",
+        "commander": "^14.0.2",
+        "rbxluau": "^1.7.0"
+    },
+    "devDependencies": {
+        "@types/node": "^25.0.3",
+        "@vitest/coverage-v8": "^4.0.16",
+        "@vitest/ui": "^4.0.16",
+        "dotenv": "^17.2.3",
+        "vitest": "^4.0.16"
+    }
+}

package/src/cache.js

@@ -0,0 +1,19 @@
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+/**
+ * Ensures that the .cache directory exists with a .gitignore file.
+ * @returns {string} The path to the .cache directory.
+ */
+export function ensureCache() {
+    const CACHE_FOLDER_PATH = path.join(__dirname, "..", ".cache");
+    if (!fs.existsSync(CACHE_FOLDER_PATH)) {
+        fs.mkdirSync(CACHE_FOLDER_PATH, { recursive: true });
+        fs.writeFileSync(path.join(CACHE_FOLDER_PATH, ".gitignore"), `*`);
+    }
+    return CACHE_FOLDER_PATH;
+}