beartest-js 3.1.0 → 5.0.0

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 Mocha. It has a tiny footprint while maintaining a familiar API.
+_Beartest_ is an extremely simple JavaScript test runner inspired by Baretest and Jest. It has a tiny footprint while maintaining a familiar API.
 
 ### Install
 
@@ -14,27 +14,45 @@ yarn add beartest-js -D
 
 ### Why Beartest?
 
-Mocha, Jest, and similar testing frameworks are richly featured, broadly compatible, and highly customizable. Beartest is none of those things.
-**If you want features look somewhere else.** Beartest is meant to be understandable above all else. Inspired by baretest, it seeks to deliver an
-API similar to Mocha's with minimal code. **Note:** Beartest is only compatible with Node 14.
+Jest, Mocha, and similar testing frameworks are richly featured, broadly compatible, and highly customizable. Beartest is none of those things. **If you want features look somewhere else.** Beartest is meant to be simple and understandable, without the complexity of other testing frameworks. Inspired by [Baretest](https://www.npmjs.com/package/baretest), it seeks to deliver an API similar to Jest's with minimal code.
+
+### Compatibility
+
+The Beartest test runner uses common js to load files.
 
 ### Usage
 
-_Beartest_ implements the basic test organization provided by Mocha. The `beforeAll`, `beforeEach`, `afterEach`, and `afterAll` ordering functions are made available as well as `it.skip` and `it.only`. Additionally, a very basic test runner is included. This test runner accepts a glob pattern as a command line argument. The test runner can be invoked with `yarn beartest sum.test.js`.
+_Beartest_ implements the following functions `describe`, `it`, `beforeAll`, `beforeEach`, `afterEach`, `afterAll`, `it.skip`, and `it.only`. All provided functions work in a similar way as the corresponding functions in Jest.
 
-### Example Test
+### Example
 
 ```javascript
-import describe from 'beartest-js';
-import assert from 'assert';
+import { describe, it } from "beartest-js";
+import assert from "assert";
 
-export default describe('Sum', ({ it }) => {
-  it('should add correctly', async () => {
+describe("Math Testing", () => {
+  it("should add correctly", async () => {
     assert.strictEqual(1 + 2, 3);
   });
+
+  it("should subtract correctly", async () => {
+    assert.strictEqual(3 - 2, 1);
+  });
 });
 ```
 
+### Running Tests
+
+Additionally, a very basic test runner is included. This test runner accepts a glob pattern as a command line argument. The test runner can be invoked with `yarn beartest "glob-pattern"`. By default, it will look for `**/*.test.js`.
+
+Suggested package script:
+
+```json
+  "scripts": {
+    "test": "beartest"
+  }
+```
+
 ## License
 
-Copyright 2020 OpenJS Foundation and contributors. Licensed under [MIT](./LICENSE).
+Licensed under [MIT](./LICENSE).

package/beartest.js

@@ -0,0 +1,93 @@
+const rgb = require('barecolor');
+
+async function RunSerially(fnArray) {
+  for (const fn of fnArray) {
+    await fn();
+  }
+}
+const suiteStack = [];
+const top = () =>
+  suiteStack.length ? suiteStack[suiteStack.length - 1] : undefined;
+
+const registerTest = (suite, name, fn) => async () => {
+  const prefix = '  '.repeat(suite.depth);
+  try {
+    await suite.beforeEach();
+    await fn();
+    rgb.green(prefix + `✓`);
+    rgb.gray(` ${name}\n`);
+  } catch (e) {
+    rgb.red(`\n${prefix}✗ ${name} \n\n`);
+    throw e;
+  } finally {
+    await suite.afterEach();
+  }
+};
+
+async function runSuite(suite) {
+  const prefix = '  '.repeat(suite.depth);
+  const tests = suite.only.length > 0 ? suite.only : suite.tests;
+  rgb.cyanln(prefix + suite.headline + ' ');
+  try {
+    await suite.beforeAll();
+    await RunSerially(tests);
+  } finally {
+    await suite.afterAll();
+  }
+}
+
+async function suite(headline, fn, only = false) {
+  const parent = top();
+  const self = {
+    depth: parent ? parent.depth + 1 : 0,
+    headline,
+    beforeAllHooks: [],
+    async beforeAll() {
+      await RunSerially(this.beforeAllHooks);
+    },
+    beforeEachHooks: [],
+    async beforeEach() {
+      if (parent) await parent.beforeEach();
+      await RunSerially(this.beforeEachHooks);
+    },
+    afterAllHooks: [],
+    async afterAll() {
+      await RunSerially(this.afterAllHooks);
+    },
+    afterEachHooks: [],
+    async afterEach() {
+      await RunSerially(this.afterEachHooks);
+      if (parent) await parent.afterEach();
+    },
+    tests: [],
+    only: [],
+  };
+  if (parent && only) parent.only.push(() => runSuite(self));
+  if (parent && !only) parent.tests.push(() => runSuite(self));
+  suiteStack.push(self);
+  fn();
+  suiteStack.pop();
+  if (self.depth === 0) {
+    await runSuite(self);
+  }
+}
+
+const describe = (headline, fn) => suite(headline, 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));
+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);
+
+module.exports = {
+  describe,
+  it,
+  beforeAll,
+  afterAll,
+  beforeEach,
+  afterEach,
+};

package/index.d.ts

@@ -1,11 +1,12 @@
-type test = (name: string, fn: () => void | Promise<void>) => void
+type test = (name: string, fn: () => void | Promise<void>) => void;
 
-declare function describe(headline: string, fn: (args: {
-  it: test & { only: test, skip: test }
-  beforeAll: (fn: () => void | Promise<void>) => void
-  afterAll: (fn: () => void | Promise<void>) => void
-  beforeEach: (fn: () => void | Promise<void>) => void
-  afterEach: (fn: () => void | Promise<void>) => void
-}) => void): Promise<boolean>
+export declare function describe(
+  headline: string,
+  fn: () => void
+): Promise<boolean>;
 
-export = describe
+export declare const it: test & { only: test; skip: test };
+export declare function beforeAll(fn: () => void | Promise<void>): void;
+export declare function afterAll(fn: () => void | Promise<void>): void;
+export declare function beforeEach(fn: () => void | Promise<void>): void;
+export declare function afterEach(fn: () => void | Promise<void>): void;

package/index.js

@@ -0,0 +1 @@
+module.exports = require('./beartest.cjs');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "beartest-js",
-  "version": "3.1.0",
+  "version": "5.0.0",
   "description": "Bear Bones Testing",
   "repository": {
     "type": "git",

package/testrunner.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
-import beartest from './beartest.cjs';
-import glob from 'tiny-glob';
+const beartest = require("./beartest");
+const glob = require("tiny-glob");
 
 const tests = [];
 const describe = beartest.describe;
@@ -8,10 +8,10 @@ beartest.describe = (headline, fn) => tests.push(describe(headline, fn));
 
 async function runTests() {
   try {
-    const globStr = process.argv[2] || '**/*.test.*';
+    const globStr = process.argv[2] || "**/*.test.*";
     const files = await glob(globStr, { absolute: true });
     for (const file of files) {
-      await import(file);
+      require(file);
       await Promise.all(tests);
     }
     process.exit(0);

package/beartest.cjs

@@ -1,52 +0,0 @@
-const rgb = require('barecolor');
-
-async function describe(headline, fn) {
-  const suite = [];
-  const only = [];
-  let beforeAll = async () => {};
-  let afterAll = async () => {};
-  let beforeEach = async () => {};
-  let afterEach = async () => {};
-  const it = (name, fn) => suite.push({ name: name, fn: fn });
-  it.only = (name, fn) => only.push({ name: name, fn: fn });
-  it.skip = () => {};
-
-  fn({
-    it: it,
-    beforeAll: (fn) => {
-      beforeAll = fn;
-    },
-    afterAll: (fn) => {
-      afterAll = fn;
-    },
-    beforeEach: (fn) => {
-      beforeEach = fn;
-    },
-    afterEach: (fn) => {
-      afterEach = fn;
-    },
-  });
-
-  const tests = only.length > 0 ? only : suite;
-  rgb.cyanln(headline + ' ');
-
-  await beforeAll();
-  for (const test of tests) {
-    try {
-      await beforeEach();
-      await test.fn();
-      rgb.green(`✓`);
-      rgb.gray(` ${test.name}\n`);
-    } catch (e) {
-      rgb.red(`\n✗ ${test.name} \n\n`);
-      throw e;
-    } finally {
-      await afterEach();
-    }
-  }
-  await afterAll();
-}
-
-module.exports = {
-  describe,
-};

package/index.cjs

@@ -1,3 +0,0 @@
-const { describe } = require('./beartest.cjs');
-
-module.exports = describe;