qunitx 1.2.6 → 1.2.7

package/dist/types.d.ts

@@ -44,7 +44,7 @@ export interface TestState {
 }
 /** Minimal module shape that Assert needs to resolve a fallback test context. */
 export interface ModuleState {
-    context: TestState;
+    testContext: TestState;
 }
 /** A lifecycle hook callback that receives an {@linkcode Assert} instance and a meta object with the shared context. */
 export type HookFn<A = unknown> = (assert: A, meta: {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "qunitx",
   "type": "module",
-  "version": "1.2.6",
-  "description": "A universal test framework for testing any js file on node.js, browser or deno with QUnit API",
+  "version": "1.2.7",
+  "description": "Universal test library — run the same test file in Node.js, Deno, and the browser with QUnit's battle-tested assertion API",
   "author": "Izel Nakri",
   "license": "MIT",
   "keywords": [

package/shims/deno/index.ts

@@ -24,12 +24,12 @@
  *
  * @module
  */
-import { AssertionError as DenoAssertionError } from "jsr:@std/assert";
-import type { AssertionErrorOptions } from "../types.ts";
 import '../../vendor/qunit.js';
+import { AssertionError as DenoAssertionError } from 'jsr:@std/assert';
 import Assert from '../shared/assert.ts';
 import ModuleContext from '../shared/module-context.ts';
 import TestContext from '../shared/test-context.ts';
+import type { AssertionErrorOptions } from '../types.ts';
 import Module from './module.ts';
 import Test from './test.ts';
 
@@ -111,6 +111,25 @@ export { Assert };
  */
 export { default as module } from './module.ts';
 
+/**
+ * Registers a skipped test. Equivalent to `test.skip`. The test body is never
+ * executed and the test is reported as ignored by Deno's runner.
+ *
+ * @param {string} testName - Name of the test to skip.
+ * @param {function} [_testContent] - Optional body (ignored — the test will not run).
+ * @example
+ * ```js
+ * import { module, skip } from "qunitx";
+ *
+ * module("Math", () => {
+ *   skip("addition is not yet implemented", (assert) => {
+ *     assert.equal(1 + 1, 2);
+ *   });
+ * });
+ * ```
+ */
+export const skip = Test.skip;
+
 /**
  * Defines an individual test. Wraps Deno's `it()` and handles the full QUnit
  * lifecycle: `beforeEach`/`afterEach` hooks, async assertion waiting, and step
@@ -142,25 +161,6 @@ export { default as module } from './module.ts';
  * ```
  */
 export { default as test } from './test.ts';
-
-/**
- * Registers a skipped test. Equivalent to `test.skip`. The test body is never
- * executed and the test is reported as ignored by Deno's runner.
- *
- * @param {string} testName - Name of the test to skip.
- * @param {function} [_testContent] - Optional body (ignored — the test will not run).
- * @example
- * ```js
- * import { module, skip } from "qunitx";
- *
- * module("Math", () => {
- *   skip("addition is not yet implemented", (assert) => {
- *     assert.equal(1 + 1, 2);
- *   });
- * });
- * ```
- */
-export const skip = Test.skip;
 export const todo = Test.todo;
 
 /**

package/shims/deno/module.ts

@@ -1,9 +1,7 @@
-import { describe, beforeAll, afterAll } from "jsr:@std/testing/bdd";
+import { afterAll, beforeAll, describe } from 'jsr:@std/testing/bdd';
 import type Assert from '../shared/assert.ts';
-import type { HookFn, HooksObject } from '../types.ts';
 import ModuleContext from '../shared/module-context.ts';
-export type { Assert };
-export type { HookFn, HooksObject, PushResultInfo } from '../types.ts';
+import type { HookFn, HooksObject } from '../types.ts';
 
 /**
  * Defines a test module (suite) for Deno's BDD test runner.
@@ -53,14 +51,14 @@ export default function module(
     return;
   }
 
-  const targetModuleContent = (moduleContent ? moduleContent : runtimeOptions) as (hooks: HooksObject<Assert>, meta: { moduleName: string; options: unknown }) => void;
+  const targetModuleContent = (moduleContent ?? runtimeOptions) as (hooks: HooksObject<Assert>, meta: { moduleName: string; options: unknown }) => void;
   const moduleContext = new ModuleContext(moduleName);
 
   describe(moduleName, { ...targetRuntimeOptions }, function () {
     const beforeHooks: HookFn<Assert>[] = [];
     const afterHooks: HookFn<Assert>[] = [];
 
-    beforeAll(async function () {
+    beforeAll(async () => {
       // before() assertions are attributed to the first direct test only (matching QUnit's model).
       // Tests inherit parent context via prototype chain, so no Object.assign needed.
       const firstTest = moduleContext.tests[0];
@@ -72,19 +70,18 @@ export default function module(
     });
 
     afterAll(async () => {
-      for (const testContext of moduleContext.tests) {
-        await testContext.assert!.waitForAsyncOps();
-      }
+      const allAsyncOps = moduleContext.tests.flatMap((t) => t.asyncOps);
+      if (allAsyncOps.length > 0) await Promise.all(allAsyncOps);
 
-      const lastTest = moduleContext.tests[moduleContext.tests.length - 1];
+      const lastTest = moduleContext.tests.at(-1);
       if (lastTest) {
-        for (let j = afterHooks.length - 1; j >= 0; j--) {
-          await afterHooks[j]!.call(lastTest.userContext, lastTest.assert!, { context: lastTest.userContext });
+        for (const hook of afterHooks.toReversed()) {
+          await hook.call(lastTest.userContext, lastTest.assert!, { context: lastTest.userContext });
         }
       }
 
-      for (let i = 0, len = moduleContext.tests.length; i < len; i++) {
-        moduleContext.tests[i].finish();
+      for (const testCtx of moduleContext.tests) {
+        testCtx.finish();
       }
     });
 
@@ -101,7 +98,7 @@ export default function module(
       after(afterFn) {
         afterHooks.push(afterFn);
       }
-    }, { moduleName, options: runtimeOptions, context: moduleContext.userContext });
+    }, { moduleName, options: targetRuntimeOptions, context: moduleContext.userContext });
 
     ModuleContext.currentModuleChain.pop();
   });
@@ -149,3 +146,6 @@ module.skip = function skipModule(moduleName: string, _moduleContent?: unknown):
 module.todo = function todoModule(moduleName: string, _moduleContent?: unknown): void {
   describe(moduleName, { ignore: true }, function () {});
 };
+
+export type { Assert };
+export type { HookFn, HooksObject, PushResultInfo } from '../types.ts';

package/shims/deno/test.ts

@@ -1,9 +1,7 @@
-import { it } from "jsr:@std/testing/bdd";
+import { it } from 'jsr:@std/testing/bdd';
 import type Assert from '../shared/assert.ts';
-import TestContext from '../shared/test-context.ts';
 import ModuleContext from '../shared/module-context.ts';
-export type { Assert };
-export type { PushResultInfo } from '../types.ts';
+import TestContext from '../shared/test-context.ts';
 
 /**
  * Defines an individual test within a module for Deno's BDD test runner.
@@ -59,7 +57,7 @@ export default function test(
     return;
   }
 
-  const targetTestContent = (testContent ? testContent : runtimeOptions) as (assert: Assert, meta: { testName: string; options: unknown }) => void | Promise<void>;
+  const targetTestContent = (testContent ?? runtimeOptions) as (assert: Assert, meta: { testName: string; options: unknown }) => void | Promise<void>;
   const context = new TestContext(testName, moduleContext);
 
   // Each test gets a fresh plain object inheriting from the module's user context.
@@ -69,38 +67,38 @@ export default function test(
   context.userContext = userContext;
 
   it(testName, { ...targetRuntimeOptions }, function () {
-    return new Promise((resolve, reject) => {
-      context.rejectTimeout = reject;
+    const { promise, resolve, reject } = Promise.withResolvers<void>();
+    context.rejectTimeout = reject;
 
-      (async () => {
-        const hookMeta = { context: userContext };
+    const hookMeta = { context: userContext };
 
-        try {
-          for (const module of context.module!.moduleChain) {
-            for (const hook of module.beforeEachHooks) {
-              await hook.call(userContext, context.assert!, hookMeta);
-            }
+    (async () => {
+      try {
+        for (const mod of context.module!.moduleChain) {
+          for (const hook of mod.beforeEachHooks) {
+            await hook.call(userContext, context.assert!, hookMeta);
           }
+        }
 
-          const result = await targetTestContent.call(userContext, context.assert!, { testName, options: runtimeOptions, context: userContext });
+        await targetTestContent.call(userContext, context.assert!, { testName, options: targetRuntimeOptions, context: userContext });
 
-          await context.assert!.waitForAsyncOps();
+        await context.assert!.waitForAsyncOps();
 
-          for (let i = context.module!.moduleChain.length - 1; i >= 0; i--) {
-            const module = context.module!.moduleChain[i];
-            for (let j = module.afterEachHooks.length - 1; j >= 0; j--) {
-              await module.afterEachHooks[j]!.call(userContext, context.assert!, hookMeta);
-            }
+        for (const mod of context.module!.moduleChain.toReversed()) {
+          for (const hook of mod.afterEachHooks.toReversed()) {
+            await hook.call(userContext, context.assert!, hookMeta);
           }
-
-          resolve(result);
-        } catch (err) {
-          reject(err);
-        } finally {
-          context.clearTimeoutHandle();
         }
-      })();
-    });
+
+        resolve();
+      } catch (err) {
+        reject(err);
+      } finally {
+        context.clearTimeoutHandle();
+      }
+    })();
+
+    return promise;
   });
 }
 
@@ -146,3 +144,6 @@ test.skip = function skipTest(testName: string, _testContent?: unknown): void {
 test.todo = function todoTest(testName: string, _testContent?: unknown): void {
   it(testName, { ignore: true }, async function () {});
 };
+
+export type { Assert };
+export type { PushResultInfo } from '../types.ts';

package/shims/shared/assert.ts

@@ -1,6 +1,9 @@
 import '../../vendor/qunit.js';
-import { objectValues, objectValuesSubset, validateExpectedExceptionArgs, validateException } from './index.ts';
-import type { QUnitObject, AssertionErrorConstructor, InspectFn, TestState, ModuleState, PushResultInfo } from '../types.ts';
+import type { AssertionErrorConstructor, InspectFn, ModuleState, PushResultInfo, QUnitObject, TestState } from '../types.ts';
+import { objectValues, objectValuesSubset, validateException, validateExpectedExceptionArgs } from './index.ts';
+
+// Sentinel used by rejects() to distinguish "promise resolved" from "caught undefined".
+const PENDING = Symbol('pending');
 
 /**
  * The assertion object passed to every test callback and lifecycle hook.
@@ -34,11 +37,11 @@ export default class Assert {
 
   /** @internal */
   constructor(module: ModuleState | null, test?: TestState) {
-    this.test = test || (module as ModuleState).context;
+    this.test = test || (module as ModuleState).testContext;
   }
 
   /** @internal */
-  _incrementAssertionCount() {
+  private _incrementAssertionCount() {
     this.test.totalExecutedAssertions++;
   }
 
@@ -80,22 +83,16 @@ export default class Assert {
    * ```
    */
   step(message: string): void {
-    let assertionMessage = message;
-    let result = !!message;
-
     this.test.steps.push(message);
 
-    if (typeof message === 'undefined' || message === '') {
-      assertionMessage = 'You must provide a message to assert.step';
-    } else if (typeof message !== 'string') {
-      assertionMessage = 'You must provide a string value to assert.step';
-      result = false;
-    }
+    const result = typeof message === 'string' && message.length > 0;
+    const assertionMessage = result
+      ? message
+      : (message === undefined || message === '')
+        ? 'You must provide a message to assert.step'
+        : 'You must provide a string value to assert.step';
 
-    this.pushResult({
-      result,
-      message: assertionMessage
-    });
+    this.pushResult({ result, message: assertionMessage });
   }
 
   /**
@@ -159,12 +156,9 @@ export default class Assert {
    * ```
    */
   async(): () => void {
-    let resolveFn!: () => void;
-    const done = new Promise<void>(resolve => { resolveFn = resolve; });
-
-    this.test.asyncOps.push(done);
-
-    return () => { resolveFn(); };
+    const { promise, resolve } = Promise.withResolvers<void>();
+    this.test.asyncOps.push(promise);
+    return resolve;
   }
 
   /** @internal Used by the test runner to wait for all async operations to complete. */
@@ -580,7 +574,7 @@ export default class Assert {
    * ```
    */
   throws(blockFn: unknown, expectedInput?: unknown, assertionMessage?: string): void {
-    this?._incrementAssertionCount();
+    this._incrementAssertionCount();
     const [expected, message] = validateExpectedExceptionArgs(expectedInput, assertionMessage, 'throws');
     if (typeof blockFn !== 'function') {
       throw new Assert.AssertionError({
@@ -591,8 +585,9 @@ export default class Assert {
       });
     }
 
+    let returnValue: unknown;
     try {
-      blockFn();
+      returnValue = blockFn();
     } catch (error) {
       const [result, validatedExpected, validatedMessage] = validateException(error, expected, message);
       if (result === false) {
@@ -607,6 +602,15 @@ export default class Assert {
       return;
     }
 
+    if (returnValue !== null && typeof returnValue === 'object' && typeof (returnValue as PromiseLike<unknown>).then === 'function') {
+      throw new Assert.AssertionError({
+        actual: returnValue,
+        expected: expected,
+        message: 'Function passed to `assert.throws` returned a Promise — did you mean to use `assert.rejects`?',
+        stackStartFn: this.throws,
+      });
+    }
+
     throw new Assert.AssertionError({
       actual: blockFn,
       expected: expected,
@@ -643,16 +647,14 @@ export default class Assert {
       });
     }
 
-    let didReject = false;
-    let rejectionError;
+    let caught: unknown = PENDING;
     try {
       await promise;
     } catch (error) {
-      didReject = true;
-      rejectionError = error;
+      caught = error;
     }
 
-    if (!didReject) {
+    if (caught === PENDING) {
       throw new Assert.AssertionError({
         actual: promise,
         expected: expected,
@@ -661,7 +663,7 @@ export default class Assert {
       });
     }
 
-    const [result, validatedExpected, validatedMessage] = validateException(rejectionError, expected, message);
+    const [result, validatedExpected, validatedMessage] = validateException(caught, expected, message);
     if (result === false) {
       throw new Assert.AssertionError({
         actual: result,
@@ -671,7 +673,7 @@ export default class Assert {
       });
     }
   }
-};
+}
 
 function defaultMessage(actual: unknown, description: string, expected: unknown): string {
   return `
@@ -683,6 +685,8 @@ ${description}
 ${inspect(expected)}`
 }
 
+const INSPECT_OPTIONS = { depth: 10, colors: true, compact: false as const };
+
 function inspect(value: unknown): string {
-  return Assert.inspect(value, { depth: 10, colors: true, compact: false });
+  return Assert.inspect(value, INSPECT_OPTIONS);
 }

package/shims/shared/index.ts

@@ -1,4 +1,4 @@
-const hasOwn = Object.prototype.hasOwnProperty
+const hasOwn = Object.prototype.hasOwnProperty;
 
 export function objectType(obj: unknown): string {
   if (typeof obj === 'undefined') {
@@ -32,12 +32,8 @@ export function objectType(obj: unknown): string {
   }
 }
 
-function is(type: string, obj: unknown): boolean {
-  return objectType(obj) === type;
-}
-
 export function objectValues(obj: unknown, allowArray = true): unknown {
-  const vals: Record<string, unknown> | unknown[] = allowArray && is('array', obj) ? [] : {};
+  const vals: Record<string, unknown> | unknown[] = allowArray && objectType(obj) === 'array' ? [] : {};
 
   for (const key in obj as object) {
     if (hasOwn.call(obj, key)) {
@@ -50,13 +46,8 @@ export function objectValues(obj: unknown, allowArray = true): unknown {
 }
 
 /**
- *
  * Recursively clone an object into a plain object, taking only the
- * subset of own enumerable properties that exist a given model.
- *
- * @param {any} obj
- * @param {any} model
- * @return {Object}
+ * subset of own enumerable properties that exist in a given model.
  */
 export function objectValuesSubset(obj: unknown, model: unknown): unknown {
   // Return primitive values unchanged to avoid false positives or confusing
@@ -95,14 +86,15 @@ export function validateExpectedExceptionArgs(
       expected = undefined;
       return [expected, message];
     } else {
-      throw new Error('assert.' + assertionMethod + ' does not accept a string value for the expected argument.\n' + 'Use a non-string object value (e.g. RegExp or validator function) ' + 'instead if necessary.');
+      throw new Error(
+        `assert.${assertionMethod} does not accept a string value for the expected argument.\n` +
+        'Use a non-string object value (e.g. RegExp or validator function) instead if necessary.',
+      );
     }
   }
-  const valid = !expected ||
-  // TODO: be more explicit here
-  expectedType === 'regexp' || expectedType === 'function' || expectedType === 'object';
+  const valid = !expected || expectedType === 'regexp' || expectedType === 'function' || expectedType === 'object';
   if (!valid) {
-    throw new Error('Invalid expected value type (' + expectedType + ') ' + 'provided to assert.' + assertionMethod + '.');
+    throw new Error(`Invalid expected value type (${expectedType}) provided to assert.${assertionMethod}.`);
   }
   return [expected, message];
 }
@@ -170,15 +162,10 @@ function errorString(error: unknown): string {
   // an object literal with name and message properties...
   if (resultErrorString.slice(0, 7) === '[object') {
     // Based on https://es5.github.io/#x15.11.4.4
-    return (
-      ((error as { name?: string }).name || 'Error') +
-      ((error as { message?: string }).message
-        ? ': '.concat((error as { message: string }).message)
-        : '')
-    );
-  } else {
-    return resultErrorString;
+    const name = (error as { name?: string }).name || 'Error';
+    const msg = (error as { message?: string }).message;
+    return msg ? `${name}: ${msg}` : name;
   }
-}
 
-export default { objectValues, objectValuesSubset, validateExpectedExceptionArgs, validateException };
+  return resultErrorString;
+}

package/shims/shared/module-context.ts

@@ -1,5 +1,5 @@
-import type Assert from './assert.ts';
 import type { HookFn } from '../types.ts';
+import type Assert from './assert.ts';
 import TestContext from './test-context.ts';
 
 export default class ModuleContext {
@@ -7,7 +7,7 @@ export default class ModuleContext {
   static currentModuleChain: ModuleContext[] = [];
 
   static get lastModule() {
-    return this.currentModuleChain[this.currentModuleChain.length - 1];
+    return this.currentModuleChain.at(-1);
   }
 
   name!: string;
@@ -15,7 +15,7 @@ export default class ModuleContext {
   userContext!: Record<string, unknown>;
 
   // Internal fallback assert for modules with no direct tests
-  context = new TestContext();
+  testContext = new TestContext();
 
   moduleChain: ModuleContext[] = [];
   beforeEachHooks: HookFn<Assert>[] = [];
@@ -23,11 +23,11 @@ export default class ModuleContext {
   tests: TestContext[] = [];
 
   constructor(name: string) {
-    const parentModule = ModuleContext.currentModuleChain[ModuleContext.currentModuleChain.length - 1];
+    const parentModule = ModuleContext.currentModuleChain.at(-1);
 
     ModuleContext.currentModuleChain.push(this);
 
-    this.moduleChain = ModuleContext.currentModuleChain.slice(0);
+    this.moduleChain = [...ModuleContext.currentModuleChain];
     this.name = parentModule ? `${parentModule.name} > ${name}` : name;
     this.assert = new ModuleContext.Assert(this);
 

package/shims/shared/test-context.ts

@@ -4,50 +4,29 @@ import type ModuleContext from './module-context.ts';
 export default class TestContext {
   static Assert: typeof Assert;
 
-  #name: string | undefined;
-  get name() {
-    return this.#name;
-  }
-  set name(value) {
-    this.#name = value;
-  }
-
-  #module: ModuleContext | undefined;
-  get module() {
-    return this.#module;
-  }
-  set module(value) {
-    this.#module = value;
-  }
-
-  #asyncOps: Promise<void>[] = [];
-  get asyncOps() {
-    return this.#asyncOps;
-  }
-  set asyncOps(value) {
-    this.#asyncOps = value;
-  }
-
-  #assert: Assert | undefined;
-  get assert() {
-    return this.#assert;
-  }
-  set assert(value) {
-    this.#assert = value;
-  }
-
-  #timeout: number | undefined;
-  get timeout() {
-    return this.#timeout;
-  }
-  set timeout(value) {
-    this.#timeout = value;
-  }
+  name: string | undefined;
+  module: ModuleContext | undefined;
+  asyncOps: Promise<void>[] = [];
+  assert: Assert | undefined;
+  timeout: number | undefined;
+  steps: string[] = [];
+  expectedAssertionCount: number | undefined;
+  totalExecutedAssertions = 0;
+  userContext: Record<string, unknown> = {};
 
   rejectTimeout: ((err: Error) => void) | undefined;
   #timeoutHandle: ReturnType<typeof setTimeout> | undefined;
   #timedOut = false;
 
+  constructor(name?: string, moduleContext?: ModuleContext) {
+    if (moduleContext) {
+      this.name = `${moduleContext.name} | ${name}`;
+      this.module = moduleContext;
+      this.module.tests.push(this);
+      this.assert = new TestContext.Assert(moduleContext, this);
+    }
+  }
+
   setTimeoutDuration(ms: number) {
     if (this.#timeoutHandle !== undefined) {
       clearTimeout(this.#timeoutHandle);
@@ -67,65 +46,29 @@ export default class TestContext {
     }
   }
 
-  #steps: string[] = [];
-  get steps() {
-    return this.#steps;
-  }
-  set steps(value) {
-    this.#steps = value;
-  }
-
-  #expectedAssertionCount: number | undefined;
-  get expectedAssertionCount() {
-    return this.#expectedAssertionCount;
-  }
-  set expectedAssertionCount(value) {
-    this.#expectedAssertionCount = value;
-  }
-
-  #totalExecutedAssertions = 0;
-  get totalExecutedAssertions() {
-    return this.#totalExecutedAssertions;
-  }
-  set totalExecutedAssertions(value) {
-    this.#totalExecutedAssertions = value;
-  }
-
-  userContext: Record<string, unknown> = {};
-
-  constructor(name?: string, moduleContext?: ModuleContext) {
-    if (moduleContext) {
-      this.name = `${moduleContext.name} | ${name}`;
-      this.module = moduleContext;
-      this.module.tests.push(this);
-      this.assert = new TestContext.Assert(moduleContext, this);
-    }
-  }
-
   finish() {
     if (this.#timedOut) return;
-    if (this.totalExecutedAssertions === 0) {
-      this.assert!.pushResult({
-        result: false,
-        actual: this.totalExecutedAssertions,
-        expected: '> 0',
-        message: `Expected at least one assertion to be run for test: ${this.name}`,
-      });
-    } else if (this.steps.length > 0) {
+    if (this.steps.length > 0) {
       this.assert!.pushResult({
         result: false,
         actual: this.steps,
         expected: [],
         message: `Expected assert.verifySteps() to be called before end of test after using assert.step(). Unverified steps: ${this.steps.join(', ')}`,
       });
-    } else if (this.expectedAssertionCount && this.expectedAssertionCount !== this.totalExecutedAssertions) {
+    } else if (this.expectedAssertionCount !== undefined && this.expectedAssertionCount !== this.totalExecutedAssertions) {
       this.assert!.pushResult({
         result: false,
         actual: this.totalExecutedAssertions,
         expected: this.expectedAssertionCount,
         message: `Expected ${this.expectedAssertionCount} assertions, but ${this.totalExecutedAssertions} were run for test: ${this.name}`,
       });
+    } else if (this.expectedAssertionCount === undefined && this.totalExecutedAssertions === 0) {
+      this.assert!.pushResult({
+        result: false,
+        actual: this.totalExecutedAssertions,
+        expected: '> 0',
+        message: `Expected at least one assertion to be run for test: ${this.name}`,
+      });
     }
   }
 }
-

package/shims/types.ts

@@ -44,7 +44,7 @@ export interface TestState {
 
 /** Minimal module shape that Assert needs to resolve a fallback test context. */
 export interface ModuleState {
-  context: TestState;
+  testContext: TestState;
 }
 
 /** A lifecycle hook callback that receives an {@linkcode Assert} instance and a meta object with the shared context. */