@w-lfpup/jackrabbit 0.1.0 → 0.2.0

package/.github/workflows/{build_and_test.yml → tests.yml}

@@ -1,4 +1,4 @@
-name: Build and Test
+name: Tests
 
 on:
   push:
@@ -10,8 +10,8 @@ jobs:
   build_and_test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
       - name: Install
         run: npm ci
       - name: Test

package/README.md

@@ -2,13 +2,9 @@
 
 Write tests without dependencies (including jackrabbit itself).
 
-## Tests
-
-Read [this guide](./test_guide.md) to create jackrabbit tests.
-
-## Nodejs
+[![Tests](https://github.com/w-lfpup/jackrabbit-js/actions/workflows/tests.yml/badge.svg)](https://github.com/w-lfpup/jackrabbit-js/actions/workflows/tests.yml)
 
-### Install
+## Install
 
 Install jackrabbit with npm.
 
@@ -22,10 +18,117 @@ Or Install jackrabbit directly from github.
 npm install --save-dev https://github.com/w-lfpup/jackrabbit-js
 ```
 
-### Run Test Collections
+# Tests
+
+For a quick visual reference, please refer to the [examples](./examples/).
+
+Developers with javascript experience can immediately start testing with basically zero overhead.
+
+## Tests
+
+Tests are functions or promises that return assertions.
+
+Tests `pass` when they return the `undefined` primitive or an empty array `[]`.
+
+```TS
+// my.tests.ts
+
+function testStuffAndPass() {
+	return;
+}
+
+function testMoreStuffAndPass() {
+	return [];
+}
+```
+
+Any other value will cause a test to `fail`.
+
+So tests that `fail` look like:
+
+```TS
+// my.tests.ts
+
+function testStuffAndFail() {
+	return "this test failed!";
+}
+
+function testMoreStuffAndFail() {
+	return ["this test also failed!"];
+}
+```
+
+## Test Modules
+
+Test Modules are javascript `modules` that export two values: `tests` and `options`.
+
+### Export Tests
+
+Test Modules export their tests in an array called `tests`.
+
+```TS
+// my.tests.ts
+
+export const tests = [
+	testStuffAndPass,
+	testMoreStuffAndPass,
+	testStuffAndFail,
+	testMoreStuffAndFail,
+];
+```
+
+### Export Options
+
+Export a parameter object named `options` to affect test behaviors in the current module:
+
+```TS
+// my.tests.ts
+
+interface Options {
+  runAsynchronously?: boolean;
+  timeoutMs?: number;
+  title?: string;
+}
+
+...
+
+export const options = {
+	runAsyncronously: true,
+	timeoutMs: 3000,
+	title: import.meta.url,
+}
+```
+
+All properties are optional and exporting an `options` pojo is not required.
+
+Tests run sequentially unless the `runAsyncronously` property is set to `true`.
+
+## 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.tests.ts";
+
+export const testModules = [
+	MyTests
+];
+```
+
+## Run Test Collections
+
+Run the following command and to log the results of a test collection.
+
+```sh
+npx jackrabbit ./mod.tests.ts
+```
+
+To run multiple test collections, add more filepaths as commandline arguments:
 
 ```sh
-npx jackrabbit --file ./path/to/test/collection.ts
+npx jackrabbit ./mod.tests.ts ./another_mod.tests.ts
 ```
 
 ## License

package/cli/dist/config.js

@@ -1,27 +1,6 @@
-const reactions = {
-    "--file": fileConfig,
-    "-f": fileConfig,
-};
-function fileConfig(config, file) {
-    if (file === undefined)
-        return;
-    config.files.push(file);
-}
-function iterateArgs(config, args) {
-    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 {
     files = [];
     constructor(args) {
-        iterateArgs(this, args);
+        this.files = args;
     }
 }

package/cli/src/config.ts

@@ -1,36 +1,9 @@
 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);
+		this.files = args;
 	}
 }

package/core/dist/jackrabbit_types.d.ts

@@ -6,9 +6,9 @@ type SyncTest = () => Assertions;
 type AsyncTest = () => Promise<Assertions>;
 export type Test = SyncTest | AsyncTest;
 export interface Options {
-    title?: string;
     runAsynchronously?: boolean;
     timeoutMs?: number;
+    title?: string;
 }
 export interface TestModule {
     tests: Test[];

package/core/src/jackrabbit_types.ts

@@ -9,9 +9,9 @@ type AsyncTest = () => Promise<Assertions>;
 export type Test = SyncTest | AsyncTest;
 
 export interface Options {
-	title?: string;
 	runAsynchronously?: boolean;
 	timeoutMs?: number;
+	title?: string;
 }
 
 export interface TestModule {

package/package.json

@@ -1,6 +1,8 @@
 {
 	"name": "@w-lfpup/jackrabbit",
 	"description": "A test runner without dependencies",
+	"version": "0.2.0",
+	"license": "BSD-3-Clause",
 	"workspaces": [
 		"core",
 		"tests",
@@ -14,12 +16,11 @@
 		"prepare": "npm run build",
 		"build": "npm run --workspaces build",
 		"format": "npx prettier --write ./",
-		"test": "npx jackrabbit --file ./tests/dist/mod.js"
+		"test": "npx jackrabbit ./tests/dist/mod.js"
 	},
-	"version": "0.1.0",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/w-lfpup/jackarabbit-js.git"
+		"url": "git+https://github.com/w-lfpup/jackrabbit-js.git"
 	},
 	"devDependencies": {
 		"@types/node": "^22.5.5",

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