@w-lfpup/jackrabbit 0.1.0 → 0.3.0

package/cli/dist/importer.js

@@ -1,16 +0,0 @@
-export class Importer {
-    #cwd;
-    constructor(cwd) {
-        this.#cwd = cwd;
-    }
-    async load(uri) {
-        let uri_updated = uri;
-        let absolute = uri.startsWith("/");
-        if (!absolute) {
-            uri_updated = this.#cwd + "/" + uri;
-        }
-        const { testModules } = await import(uri_updated);
-        // verify here
-        return testModules;
-    }
-}

package/cli/dist/logger.d.ts

@@ -1,7 +0,0 @@
-import type { LoggerAction, LoggerInterface, TestModule } from "../../core/dist/mod.js";
-export declare class Logger implements LoggerInterface {
-    #private;
-    get failed(): boolean;
-    get cancelled(): boolean;
-    log(testModules: TestModule[], action: LoggerAction): void;
-}

package/cli/dist/logger.js

@@ -1,88 +0,0 @@
-export class Logger {
-    #assertions = new Map();
-    #data = {
-        cancelled: false,
-        failed: false,
-        startTime: -1,
-        testTime: 0,
-    };
-    get failed() {
-        return this.#data.failed;
-    }
-    get cancelled() {
-        return this.#data.cancelled;
-    }
-    log(testModules, action) {
-        if ("start_run" === action.type) {
-            this.#data.startTime = action.time;
-        }
-        if ("cancel_run" === action.type) {
-            this.#data.cancelled = true;
-            logAssertions(testModules, this.#assertions);
-            logResults(this.#data, action.time);
-        }
-        //  add to fails
-        if ("end_test" === action.type && action?.assertions) {
-            if (Array.isArray(action.assertions) && action.assertions.length === 0)
-                return;
-            this.#data.testTime += action.endTime - action.startTime;
-            this.#data.failed = true;
-            let assertions = this.#assertions.get(action.moduleId);
-            if (assertions) {
-                assertions.set(action.testId, action);
-            }
-            else {
-                this.#assertions.set(action.moduleId, new Map([[action.testId, action]]));
-            }
-        }
-        if ("end_run" === action.type) {
-            logAssertions(testModules, this.#assertions);
-            logResults(this.#data, action.time);
-        }
-    }
-}
-function logAssertions(testModules, fails) {
-    for (let [moduleID, module] of testModules.entries()) {
-        let failedTests = fails.get(moduleID);
-        if (undefined === failedTests)
-            continue;
-        const { tests, options } = module;
-        console.log(`${options?.title ?? `module index: ${moduleID}`}`);
-        let numFailedTests = fails.get(moduleID)?.size ?? 0;
-        console.log(`${numFailedTests}/${tests.length} tests failed`);
-        for (let [index, test] of tests.entries()) {
-            let action = failedTests.get(index);
-            if (!action || action.type !== "end_test")
-                continue;
-            console.log(`\t${test.name}\n\t\t${action.assertions}`);
-        }
-        console.log("\n");
-    }
-}
-function logResults(data, time) {
-    let status_with_color = data.failed
-        ? yellow("\u{2717} failed")
-        : blue("\u{2714} passed");
-    if (data.cancelled) {
-        status_with_color = gray("\u{2717} cancelled");
-    }
-    const overhead = time - data.startTime;
-    console.log(`Results:
-${status_with_color}
-  duration: ${data.testTime.toFixed(4)} mS
-  overhead: ${overhead.toFixed(4)} mS`);
-}
-// 39 - default foreground color
-// 49 - default background color
-function blue(text) {
-    return `\x1b[44m\x1b[97m${text}\x1b[0m`;
-}
-function yellow(text) {
-    return `\x1b[43m\x1b[97m${text}\x1b[0m`;
-}
-function gray(text) {
-    return `\x1b[100m\x1b[97m${text}\x1b[0m`;
-}
-function logTestModule(moduleID, title) {
-    console.log(`module: ${title ?? `module index: ${moduleID}`}`);
-}

package/cli/dist/mod.d.ts

@@ -1,6 +0,0 @@
-export type { ConfigInterface } from "./cli_types.ts";
-export type { ImporterInterface } from "./cli_types.ts";
-export { Config } from "./config.js";
-export { Importer } from "./importer.js";
-export { Logger } from "./logger.js";
-export { run } from "./cli.js";

package/cli/dist/mod.js

@@ -1,4 +0,0 @@
-export { Config } from "./config.js";
-export { Importer } from "./importer.js";
-export { Logger } from "./logger.js";
-export { run } from "./cli.js";

package/cli/src/cli.ts

@@ -1,17 +0,0 @@
-import type { ConfigInterface, ImporterInterface } from "./cli_types.ts";
-import type { LoggerInterface } from "../../core/dist/mod.ts";
-
-import { startRun } from "../../core/dist/mod.js";
-import { Logger } from "./logger.js";
-
-export async function run(
-	config: ConfigInterface,
-	importer: ImporterInterface,
-	logger: LoggerInterface = new Logger(),
-) {
-	for (const file of config.files) {
-		const testModules = await importer.load(file);
-
-		await startRun(logger, testModules);
-	}
-}

package/cli/src/cli_types.ts

@@ -1,9 +0,0 @@
-import type { TestModule } from "../../core/dist/mod.ts";
-
-export interface ConfigInterface {
-	files: string[];
-}
-
-export interface ImporterInterface {
-	load(url: string): Promise<TestModule[]>;
-}

package/cli/src/config.ts

@@ -1,36 +0,0 @@
-import type { ConfigInterface } from "./cli_types.ts";
-
-type Reaction = (config: ConfigInterface, value?: string) => void;
-type Reactions = Record<string, Reaction>;
-
-const reactions: Reactions = {
-	"--file": fileConfig,
-	"-f": fileConfig,
-};
-
-function fileConfig(config: ConfigInterface, file?: string) {
-	if (file === undefined) return;
-	config.files.push(file);
-}
-
-function iterateArgs(config: ConfigInterface, args: string[]) {
-	let index = 0;
-	while (index < args.length) {
-		const flag = args[index];
-		const reaction = reactions[flag];
-		if (reaction === undefined) {
-			throw new Error(`unrecognized argument: ${flag}`);
-		}
-
-		reaction(config, args[index + 1]);
-		index += 2;
-	}
-}
-
-export class Config implements ConfigInterface {
-	files: string[] = [];
-
-	constructor(args: string[]) {
-		iterateArgs(this, args);
-	}
-}

package/cli/src/importer.ts

@@ -1,25 +0,0 @@
-import type { TestModule } from "../../core/dist/mod.ts";
-import type { ImporterInterface } from "./cli_types.ts";
-
-export class Importer implements ImporterInterface {
-	#cwd: string;
-
-	constructor(cwd: string) {
-		this.#cwd = cwd;
-	}
-
-	async load(uri: string): Promise<TestModule[]> {
-		let uri_updated = uri;
-
-		let absolute = uri.startsWith("/");
-		if (!absolute) {
-			uri_updated = this.#cwd + "/" + uri;
-		}
-
-		const { testModules } = await import(uri_updated);
-
-		// verify here
-
-		return testModules;
-	}
-}

package/cli/src/logger.ts

@@ -1,126 +0,0 @@
-import type {
-	LoggerAction,
-	LoggerInterface,
-	TestModule,
-} from "../../core/dist/mod.js";
-
-interface LoggerData {
-	cancelled: boolean;
-	failed: boolean;
-	startTime: number;
-	testTime: number;
-}
-
-export class Logger implements LoggerInterface {
-	#assertions: Map<number, Map<number, LoggerAction>> = new Map();
-	#data: LoggerData = {
-		cancelled: false,
-		failed: false,
-		startTime: -1,
-		testTime: 0,
-	};
-
-	get failed() {
-		return this.#data.failed;
-	}
-
-	get cancelled() {
-		return this.#data.cancelled;
-	}
-
-	log(testModules: TestModule[], action: LoggerAction) {
-		if ("start_run" === action.type) {
-			this.#data.startTime = action.time;
-		}
-
-		if ("cancel_run" === action.type) {
-			this.#data.cancelled = true;
-			logAssertions(testModules, this.#assertions);
-			logResults(this.#data, action.time);
-		}
-
-		//  add to fails
-		if ("end_test" === action.type && action?.assertions) {
-			if (Array.isArray(action.assertions) && action.assertions.length === 0)
-				return;
-
-			this.#data.testTime += action.endTime - action.startTime;
-			this.#data.failed = true;
-
-			let assertions = this.#assertions.get(action.moduleId);
-			if (assertions) {
-				assertions.set(action.testId, action);
-			} else {
-				this.#assertions.set(
-					action.moduleId,
-					new Map([[action.testId, action]]),
-				);
-			}
-		}
-
-		if ("end_run" === action.type) {
-			logAssertions(testModules, this.#assertions);
-			logResults(this.#data, action.time);
-		}
-	}
-}
-
-function logAssertions(
-	testModules: TestModule[],
-	fails: Map<number, Map<number, LoggerAction>>,
-) {
-	for (let [moduleID, module] of testModules.entries()) {
-		let failedTests = fails.get(moduleID);
-		if (undefined === failedTests) continue;
-
-		const { tests, options } = module;
-
-		console.log(`${options?.title ?? `module index: ${moduleID}`}`);
-
-		let numFailedTests = fails.get(moduleID)?.size ?? 0;
-		console.log(`${numFailedTests}/${tests.length} tests failed`);
-
-		for (let [index, test] of tests.entries()) {
-			let action = failedTests.get(index);
-			if (!action || action.type !== "end_test") continue;
-
-			console.log(`\t${test.name}\n\t\t${action.assertions}`);
-		}
-
-		console.log("\n");
-	}
-}
-
-function logResults(data: LoggerData, time: number) {
-	let status_with_color = data.failed
-		? yellow("\u{2717} failed")
-		: blue("\u{2714} passed");
-
-	if (data.cancelled) {
-		status_with_color = gray("\u{2717} cancelled");
-	}
-
-	const overhead = time - data.startTime;
-	console.log(`Results:
-${status_with_color}
-  duration: ${data.testTime.toFixed(4)} mS
-  overhead: ${overhead.toFixed(4)} mS`);
-}
-
-// 39 - default foreground color
-// 49 - default background color
-function blue(text: string) {
-	return `\x1b[44m\x1b[97m${text}\x1b[0m`;
-}
-
-function yellow(text: string) {
-	return `\x1b[43m\x1b[97m${text}\x1b[0m`;
-}
-
-function gray(text: string) {
-	return `\x1b[100m\x1b[97m${text}\x1b[0m`;
-}
-
-function logTestModule(moduleID: number, title?: string) {
-	console.log(`module: ${title ?? `module index: ${moduleID}`}`);
-}

package/cli/src/mod.ts

@@ -1,7 +0,0 @@
-export type { ConfigInterface } from "./cli_types.ts";
-export type { ImporterInterface } from "./cli_types.ts";
-
-export { Config } from "./config.js";
-export { Importer } from "./importer.js";
-export { Logger } from "./logger.js";
-export { run } from "./cli.js";

package/cli/tsconfig.tsbuildinfo

@@ -1 +0,0 @@
-{"root":["./src/cli.ts","./src/cli_types.ts","./src/config.ts","./src/importer.ts","./src/logger.ts","./src/mod.ts"],"version":"5.9.3"}

package/nodejs_cli/dist/mod.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/nodejs_cli/dist/mod.js

@@ -1,20 +0,0 @@
-#!/usr/bin/env node
-import { Config, Importer, Logger, run } from "../../cli/dist/mod.js";
-const config = new Config(process.argv.slice(2));
-const importer = new Importer(process.cwd());
-const logger = new Logger();
-let errored = false;
-try {
-    await run(config, importer, logger);
-}
-catch (e) {
-    errored = true;
-    console.log("Error:");
-    e instanceof Error
-        ? console.log(`
-${e.name}
-${e.message}
-${e.stack}`)
-        : console.log(e);
-}
-logger.failed || errored ? process.exit(1) : process.exit(0);

package/nodejs_cli/src/mod.ts

@@ -1,25 +0,0 @@
-#!/usr/bin/env node
-
-import { Config, Importer, Logger, run } from "../../cli/dist/mod.js";
-
-const config = new Config(process.argv.slice(2));
-const importer = new Importer(process.cwd());
-const logger = new Logger();
-
-let errored = false;
-
-try {
-	await run(config, importer, logger);
-} catch (e: unknown) {
-	errored = true;
-	console.log("Error:");
-
-	e instanceof Error
-		? console.log(`
-${e.name}
-${e.message}
-${e.stack}`)
-		: console.log(e);
-}
-
-logger.failed || errored ? process.exit(1) : process.exit(0);

package/nodejs_cli/tsconfig.tsbuildinfo

@@ -1 +0,0 @@
-{"root":["./src/mod.ts"],"version":"5.9.3"}

package/test_guide.md

@@ -1,114 +0,0 @@
-# Jackrabbit Tests
-
-For a quick visual reference, please refer to the [examples](./examples/).
-
-`Jackrabbit` leverages esmodules for a flat, concise testing experience. There are no assertion libraries, there are no wild BDD functions. Developers with javascript experience can immediately start testing with basically zero overhead.
-
-## Tests
-
-Tests are functions that return assertions.
-
-Tests `pass` when they return the `undefined` primitive or an empty array `[]`.
-
-```TS
-// my_library.tests.ts
-
-function testStuffAndPass() {
-	return;
-}
-
-async function testMoreStuffAndPass() {
-	return [];
-}
-```
-
-Any other value will cause a test to `fail`.
-
-So tests that `fail` look like:
-
-```TS
-// my_library.tests.ts
-
-function testStuffAndFail() {
-	return "this test failed!";
-}
-
-function testMoreStuffAndFail() {
-	return ["this test also failed!"];
-}
-```
-
-## Test Modules
-
-Test Modules are javascript `modules` that contain tests.
-
-### Export Tests
-
-Test Modules export their tests in an array called `tests`.
-
-```TS
-// my_library.tests.ts
-
-export const tests = [
-	testStuffAndPass,
-	testMoreStuffAndPass,
-	testStuffAndFail,
-	testMoreStuffAndFail,
-];
-```
-
-### Export Options
-
-Exporting an `options` pojo is not required.
-
-But exporting an `options` pojo with the following properties will affect test behavior:
-
-```TS
-export const options = {
-	title: import.meta.url,
-	runAsyncronously: true,
-	timeoutMs: 3000,
-}
-```
-
-All properteis are optional.
-
-Tests run sequentially unless the `runAsyncronously` property is set to `true`.
-
-```TS
-// my_library.tests.ts
-
-interface Options {
-  title?: string;
-  runAsynchronously?: boolean;
-  timeoutMs?: number;
-}
-```
-
-## Test Collections
-
-A `test collection` is a javascript module that exports a list test modules called `testModules`.
-
-```TS
-// mod.test.ts
-
-import * as MyTests from "./my_library.tests.ts";
-
-export const testModules = [
-	MyTests
-];
-```
-
-This gathers all tests into a single explicit location.
-
-## Run Test Collections
-
-Run the following command and Jackrabbit will log the results of `test collections`.
-
-```sh
-npx jackrabbit --file ./mod.test.ts
-```
-
-## License
-
-BSD 3-Clause License