beartest-js 5.0.4 → 6.0.0

package/.prettierrc

@@ -0,0 +1,5 @@
+{
+  "tabWidth": 2,
+  "useTabs": false,
+  "printWidth": 100
+}

package/README.md

@@ -1,6 +1,6 @@
 <img src="https://beartest-js.s3.amazonaws.com/beartest-logo.png" width="400">
 
-_Beartest_ is an extremely simple JavaScript test runner inspired by Baretest and Jest. It has a tiny footprint while maintaining a familiar API.
+_Beartest_ is an extremely simple JavaScript test runner inspired by Baretest, Playwright, and Jest. It has a tiny footprint while maintaining a familiar API.
 
 ### Install
 
@@ -27,15 +27,15 @@ _Beartest_ implements the following functions `describe`, `it`, `beforeAll`, `be
 ### Example
 
 ```javascript
-import { describe, it } from "beartest-js";
+import { test } from "beartest-js";
 import assert from "assert";
 
-describe("Math Testing", () => {
-  it("should add correctly", async () => {
+test.describe("Math Testing", () => {
+  test("should add correctly", async () => {
     assert.strictEqual(1 + 2, 3);
   });
 
-  it("should subtract correctly", async () => {
+  test("should subtract correctly", async () => {
     assert.strictEqual(3 - 2, 1);
   });
 });

package/beartest.js

@@ -1,4 +1,4 @@
-const rgb = require('barecolor');
+const rgb = require("barecolor");
 
 async function RunSerially(fnArray) {
   for (const fn of fnArray) {
@@ -6,11 +6,12 @@ async function RunSerially(fnArray) {
   }
 }
 const suiteStack = [];
-const top = () =>
-  suiteStack.length ? suiteStack[suiteStack.length - 1] : undefined;
+let testRunPromise = Promise.resolve();
+const top = () => (suiteStack.length ? suiteStack[suiteStack.length - 1] : null);
+const topSafe = () => (suiteStack.length ? suiteStack[suiteStack.length - 1] : makeSuite(""));
 
 const registerTest = (suite, name, fn) => async () => {
-  const prefix = '  '.repeat(suite.depth);
+  const prefix = "  ".repeat(suite.depth);
   try {
     await suite.beforeEach();
     await fn();
@@ -25,9 +26,9 @@ const registerTest = (suite, name, fn) => async () => {
 };
 
 async function runSuite(suite) {
-  const prefix = '  '.repeat(suite.depth);
+  const prefix = "  ".repeat(suite.depth);
   const tests = suite.only.length > 0 ? suite.only : suite.tests;
-  rgb.cyanln(prefix + suite.headline + ' ');
+  rgb.cyanln(prefix + suite.headline + " ");
   try {
     await suite.beforeAll();
     await RunSerially(tests);
@@ -36,7 +37,7 @@ async function runSuite(suite) {
   }
 }
 
-async function suite(headline, fn, only = false) {
+function makeSuite(headline, only = false, fn = null) {
   const parent = top();
   const self = {
     depth: parent ? parent.depth + 1 : 0,
@@ -65,29 +66,33 @@ async function suite(headline, fn, only = false) {
   if (parent && only) parent.only.push(() => runSuite(self));
   if (parent && !only) parent.tests.push(() => runSuite(self));
   suiteStack.push(self);
-  fn();
-  suiteStack.pop();
+  if (fn) fn();
+  if (fn) suiteStack.pop();
   if (self.depth === 0) {
-    await runSuite(self);
+    const timeoutPromise = new Promise((resolve) => setTimeout(resolve, 0));
+    testRunPromise = timeoutPromise.then(() => runSuite(self));
   }
+  return self;
 }
 
-const describe = (headline, fn) => suite(headline, fn);
+const describe = (headline, fn) => makeSuite(headline, false, fn);
 describe.skip = () => {};
-describe.only = (headline, fn) => suite(headline, fn, true);
-const it = (name, fn) => top().tests.push(registerTest(top(), name, fn));
-it.only = (name, fn) => top().only.push(registerTest(top(), name, fn));
+describe.only = (headline, fn) => makeSuite(headline, true, fn);
+const it = (name, fn) => topSafe().tests.push(registerTest(topSafe(), name, fn));
+it.only = (name, fn) => topSafe().only.push(registerTest(topSafe(), name, fn));
 it.skip = () => {};
-const beforeAll = (fn) => top().beforeAllHooks.push(fn);
-const afterAll = (fn) => top().afterAllHooks.push(fn);
-const beforeEach = (fn) => top().beforeEachHooks.push(fn);
-const afterEach = (fn) => top().afterEachHooks.push(fn);
+const beforeAll = (fn) => topSafe().beforeAllHooks.push(fn);
+const afterAll = (fn) => topSafe().afterAllHooks.push(fn);
+const beforeEach = (fn) => topSafe().beforeEachHooks.push(fn);
+const afterEach = (fn) => topSafe().afterEachHooks.push(fn);
 
 module.exports = {
-  describe,
-  it,
-  beforeAll,
-  afterAll,
-  beforeEach,
-  afterEach,
+  test: Object.assign(it, {
+    describe,
+    beforeAll,
+    afterAll,
+    beforeEach,
+    afterEach,
+  }),
+  runner: { waitForTests: () => testRunPromise },
 };

package/index.d.ts

@@ -1,4 +1,14 @@
-type test = (name: string, fn: () => void | Promise<void>) => void;
+type testFn = (name: string, fn: () => unknown) => void;
+
+type test = testFn & {
+  skip: testFn;
+  only: testFn;
+  describe: testFn & { skip: testFn; only: testFn };
+  beforeAll(fn: () => unknown): void;
+  afterAll(fn: () => unknown): void;
+  beforeEach(fn: () => unknown): void;
+  afterEach(fn: () => unknown): void;
+};
 
 type Describe = (headline: string, fn: () => void) => Promise<boolean>;
 type It = test & { only: test; skip: test };
@@ -7,21 +17,7 @@ type AfterAll = (fn: () => void | Promise<void>) => void;
 type BeforeEach = (fn: () => void | Promise<void>) => void;
 type AfterEach = (fn: () => void | Promise<void>) => void;
 
-export declare const describe: Describe;
-export declare const it: It;
-
-export declare const beforeAll: BeforeAll;
-export declare const afterAll: AfterAll;
-export declare const beforeEach: BeforeEach;
-export declare const afterEach: AfterEach;
-
-interface BearTest {
-  describe: Describe;
-  it: It;
-  beforeAll: BeforeAll;
-  afterAll: AfterAll;
-  beforeEach: BeforeEach;
-  afterEach: AfterEach;
-}
-
-export default BearTest;
+export declare const test: test;
+export declare const runner: {
+  waitForTests: Promise<void>;
+};

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "beartest-js",
-  "version": "5.0.4",
+  "version": "6.0.0",
   "description": "Bear Bones Testing",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/rubber-duck-software/beartest.git"
   },
-  "types": "index.d.ts",
-  "main": "index.js",
+  "types": "./index.d.ts",
+  "main": "./index.js",
   "bin": {
     "beartest": "testrunner.js"
   },

package/testrunner.js

@@ -2,17 +2,13 @@
 const beartest = require("./beartest");
 const glob = require("tiny-glob");
 
-const tests = [];
-const describe = beartest.describe;
-beartest.describe = (headline, fn) => tests.push(describe(headline, fn));
-
 async function runTests() {
   try {
     const globStr = process.argv[2] || "**/*.test.*";
     const files = await glob(globStr, { absolute: true });
     for (const file of files) {
       require(file);
-      await Promise.all(tests);
+      await beartest.runner.waitForTests();
     }
     process.exit(0);
   } catch (e) {