qunitx 0.4.4 → 0.5.0

package/lib/commands/generate.js

@@ -1,9 +1,9 @@
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
 import kleur from 'kleur';
 import findProjectRoot from '../utils/find-project-root.js';
 import pathExists from '../utils/path-exists.js';
-import { dirname } from 'path';
-import { fileURLToPath } from 'url';
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
 

package/lib/commands/help.js

@@ -1,7 +1,7 @@
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
 import kleur from 'kleur';
-import { dirname } from 'path';
-import { fileURLToPath } from 'url';
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const highlight = (text) => kleur.magenta().bold(text);

package/lib/commands/init.js

@@ -1,8 +1,8 @@
-import fs from 'fs/promises';
-import path, { dirname } from 'path';
+import fs from 'node:fs/promises';
+import path, { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
 import findProjectRoot from '../utils/find-project-root.js';
 import pathExists from '../utils/path-exists.js';
-import { fileURLToPath } from 'url';
 import defaultProjectConfigValues from '../boilerplates/default-project-config-values.js';
 
 const __dirname = dirname(fileURLToPath(import.meta.url));

package/lib/commands/run/tests-in-browser.js

@@ -1,7 +1,7 @@
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
 import kleur from 'kleur';
-import { dirname } from 'path';
-import { fileURLToPath } from 'url';
 import esbuild from 'esbuild';
 import timeCounter from '../../utils/time-counter.js';
 import runUserModule from '../../utils/run-user-module.js';

package/lib/commands/run.js

@@ -1,8 +1,7 @@
-import path from 'path';
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
+import { normalize, dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
 import kleur from 'kleur';
-import { dirname } from 'path';
-import { fileURLToPath } from 'url';
 import runTestsInNode from './run/tests-in-node.js';
 import runTestsInBrowser from './run/tests-in-browser.js';
 import setupBrowser from '../setup/browser.js';
@@ -155,6 +154,6 @@ function normalizeInternalAssetPathFromHTML(projectRoot, assetPath, htmlPath) {
   let currentDirectory = htmlPath ? htmlPath.split('/').slice(0, -1).join('/') : projectRoot;
 
   return assetPath.startsWith('./')
-    ? path.normalize(`${currentDirectory}/${assetPath.slice(2)}`)
-    : path.normalize(`${currentDirectory}/${assetPath}`);
+    ? normalize(`${currentDirectory}/${assetPath.slice(2)}`)
+    : normalize(`${currentDirectory}/${assetPath}`);
 }

package/lib/setup/browser.js

@@ -1,4 +1,4 @@
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
 import kleur from 'kleur';
 import Puppeteer from 'puppeteer';
 import setupWebServer from './web-server.js';
@@ -10,9 +10,10 @@ export default async function setupBrowser(config = {
   let [server, browser] = await Promise.all([
     setupWebServer(config, cachedContent),
     Puppeteer.launch({
+      debugger: config.debug || false,
+      args: ['--no-sandbox', '--disable-gpu', '--remote-debugging-port=0', '--window-size=1440,900'],
       executablePath: process.env.CHROME_BIN || null,
       headless: 'new',
-      args: ['--no-sandbox', '--disable-gpu', '--remote-debugging-port=0', '--window-size=1440,900']
     }),
   ]);
   let [page, ..._] = await Promise.all([

package/lib/setup/config.js

@@ -1,4 +1,4 @@
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
 import defaultProjectConfigValues from '../boilerplates/default-project-config-values.js';
 import findProjectRoot from '../utils/find-project-root.js';
 import setupFSTree from './fs-tree.js';

package/lib/setup/fs-tree.js

@@ -1,5 +1,4 @@
-import kleur from 'kleur';
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
 import picomatch from 'picomatch';
 import recursiveLookup from 'recursive-lookup';
 

package/lib/setup/web-server.js

@@ -1,11 +1,10 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
 import kleur from 'kleur';
-import path from 'path';
-import http from 'http';
 import express from 'nanoexpress';
-import fs from 'fs/promises';
+import staticServe from '@nanoexpress/middleware-static-serve';
 import findInternalAssetsFromHTML from '../utils/find-internal-assets-from-html.js';
 import TAPDisplayTestResult from '../tap/display-test-result.js';
-import staticServe from '@nanoexpress/middleware-static-serve';
 
 export default async function setupWebServer(config = {
   port: 1234, debug: false, watch: false, timeout: 10000
@@ -221,14 +220,14 @@ function testRuntimeToInject(port, config) {
       });
 
       if ([1, 3].includes(window.socket.readyState)) {
-        return window.setTimeout(() => window.QUnit.start(), 10);
+        return window.setTimeout(() => window.QUnit.start(), 25);
       } else {
         let connectionTrialCount = 0;
         let connectionInterval = window.setInterval(() => {
           if ([1, 3].includes(window.socket.readyState) || connectionTrialCount > 25) {
             window.clearInterval(connectionInterval);
 
-            return window.setTimeout(() => window.QUnit.start(), 10);
+            return window.setTimeout(() => window.QUnit.start(), 25);
           }
 
           connectionTrialCount = connectionTrialCount + 1;

package/lib/setup/write-output-static-files.js

@@ -1,4 +1,4 @@
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
 
 export default async function writeOutputStaticFiles({ projectRoot, output }, cachedContent) {
   let staticHTMLPromises = Object.keys(cachedContent.staticHTMLs).map(async (staticHTMLKey) => {

package/lib/tap/display-test-result.js

@@ -22,12 +22,12 @@ export default function(COUNTER, details) { // NOTE: https://github.com/qunitjs/
         console.log('  ---');
         console.log(indentString(yaml.dump({
           name: `Assertion #${index + 1}`, // TODO: check what happens on runtime errors
-          actual: assertion.actual || null,
-          expected: assertion.expected || null,
+          actual: assertion.actual ? JSON.parse(JSON.stringify(assertion.actual, getCircularReplacer())) : assertion.actual,
+          expected: assertion.expected ? JSON.parse(JSON.stringify(assertion.expected, getCircularReplacer())) : assertion.expected,
           message: assertion.message || null,
           stack: assertion.stack || null,
           at: stack ? stack[0].replace('(file://', '').replace(')', '') : null
-        }).trim(), 4));
+        }), 4));
         console.log('  ...');
       }
 
@@ -39,6 +39,23 @@ export default function(COUNTER, details) { // NOTE: https://github.com/qunitjs/
   }
 }
 
+function getCircularReplacer() {
+  const ancestors = [];
+  return function (key, value) {
+    if (typeof value !== "object" || value === null) {
+      return value;
+    }
+    while (ancestors.length > 0 && ancestors.at(-1) !== this) {
+      ancestors.pop();
+    }
+    if (ancestors.includes(value)) {
+      return "[Circular]";
+    }
+    ancestors.push(value);
+    return value;
+  };
+}
+
 // not ok 10 test exited without ending: deepEqual true works
 //   ---
 //     operator: fail

package/lib/utils/listen-to-keyboard-key.js

@@ -3,7 +3,6 @@ let targetInputs = {};
 let inputs = [];
 let listenerAdded = false;
 
-
 export default function listenToKeyboardKey(inputString, closure, options = { caseSensitive: false }) {
   stdin.setRawMode(true);
   stdin.resume();

package/lib/utils/parse-cli-flags.js

@@ -1,4 +1,4 @@
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
 
 // { inputs: [], browser: true, debug: true, watch: true, failFast: true, htmlPaths: [], output }
 export default async function(projectRoot) {

package/lib/utils/path-exists.js

@@ -1,4 +1,4 @@
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
 
 export default async function pathExists(path) {
   try {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "qunitx",
   "type": "module",
-  "version": "0.4.4",
+  "version": "0.5.0",
   "description": "Experimental improvements, suggestions for qunit CLI",
   "author": "Izel Nakri",
   "license": "MIT",
@@ -10,12 +10,23 @@
     "qunit-plugin"
   ],
   "engines": {
-    "node": ">=20.1.0"
+    "node": ">=20.3.0"
   },
-  "main": "index.js",
   "bin": {
     "qunitx": "cli.js"
   },
+  "imports": {
+    "qunitx": {
+      "node": "./shims/nodejs.js",
+      "deno": "./shims/deno.js",
+      "default": "./index.js"
+    }
+  },
+  "exports": {
+    "node": "./shims/nodejs.js",
+    "deno": "./shims/deno.js",
+    "default": "./index.js"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/izelnakri/qunitx.git"
@@ -24,6 +35,9 @@
     "bin": "chmod +x cli.js && ./cli.js",
     "build": "npm run build:qunit",
     "build:qunit": "node scripts/hack-qunit.js",
+    "run": "npm run run:node",
+    "run:node": "node cli.js",
+    "run:deno": "deno run --allow-read deno/cli.js",
     "changelog:unreleased": "node_modules/.bin/auto-changelog --stdout --commit-limit false --package --unreleased-only --hide-credit --sort-commits date-desc",
     "changelog:preview": "node_modules/.bin/auto-changelog --stdout --commit-limit false --package -u --sort-commits date-desc",
     "changelog:update": "node_modules/.bin/auto-changelog --commit-limit false --package --sort-commits date-desc",
@@ -31,6 +45,7 @@
     "release:alpha": "node_modules/.bin/release-it --preRelease=alpha --no-git.requireUpstream",
     "release:beta": "node_modules/.bin/release-it --preRelease=beta --no-git.requireUpstream",
     "release": "node_modules/.bin/release-it",
+    "test:deno": "deno test --allow-read --allow-env --allow-run test/commands/index.js",
     "test": "node --test test/index.js | tee test-output.log",
     "test:old": "node_modules/.bin/mocha --require test/setup.js --bail --exit --check-leaks test/inputs test/commands test/flags/after-test.js test/flags/before-test.js -t=20000",
     "test:sanity-first": "./cli.js test/helpers/failing-tests.js test/helpers/failing-tests.ts",
@@ -60,7 +75,7 @@
     "release-it": "^15.10.3"
   },
   "volta": {
-    "node": "20.1.0"
+    "node": "20.3.1"
   },
   "prettier": {
     "printWidth": 100,

package/shims/deno-assert.js

@@ -0,0 +1,55 @@
+import { assert, assertEquals, assertNotEquals, assertStrictEquals, assertNotStrictEquals, assertObjectMatch, assertRejects, assertThrows } from "https://deno.land/std@0.192.0/testing/asserts.ts";
+
+class AssertionError extends Error {
+  override name = 'AssertionError';
+  constructor(message: string) {
+    super(message);
+  }
+}
+
+export default {
+  _steps: [],
+  async() {
+    return () => {}; // NOTE: noop, deno has sanitizeResources
+  },
+  deepEqual: assertEquals,
+  equal: assertEquals,
+  expect() {
+    return () => {}; // NOTE: NOT implemented
+  },
+  false(state, message) {
+    return assert(state === false, message);
+  },
+  notDeepEqual: assertNotEquals,
+  notEqual: assertNotEquals,
+  notOk(state, message) {
+    return assert(!state, message);
+  },
+  notPropContains() {
+    throw new AssertionError('assert.notPropContains is not implemented for deno on QUnit');
+  },
+  notPropEqual() {
+    throw new AssertionError('assert.notPropEqual is not implemented for deno on QUnit');
+  },
+  notStrictEqual: assertNotStrictEquals,
+  ok: assert,
+  propContains: assertObjectMatch,
+  pushResult() {
+    return () => {}; // NOTE: NOT implemented
+  },
+  rejects: assertRejects,
+  step(value = '') {
+    this._steps.push(value);
+  },
+  strictEqual: assertStrictEquals,
+  throws: assertThrows,
+  timeout() {
+    return true; // NOTE: NOT implemented
+  },
+  true(state, message) {
+    return assert(state === true, message);
+  },
+  verifySteps(steps, message = 'Verify steps failed!') {
+    return assertEquals(this._steps, steps, message);
+  }
+};

package/shims/deno.js

@@ -0,0 +1,46 @@
+import {
+  afterEach,
+  beforeEach,
+  beforeAll,
+  afterAll,
+  describe,
+  it,
+} from "https://deno.land/std@0.192.0/testing/bdd.ts";
+import assert from './deno-assert.js';
+
+// TODO: TEST beforeEach, before, afterEach, after, currently not sure if they work!
+export const module = async function(moduleName, runtimeOptions, moduleContent) {
+  let targetRuntimeOptions = moduleContent ? Object.assign(runtimeOptions, { name: moduleName }) : { name: moduleName };
+  let targetModuleContent = moduleContent ? moduleName : runtimeOptions;
+
+  return describe(assignDefaultValues(targetRuntimeOptions, { concurrency: true }), async function() {
+    return await targetModuleContent({ before: beforeAll, after: afterAll, beforeEach, afterEach }, {
+      moduleName,
+      options: runtimeOptions
+    });
+  });
+}
+
+export const test = async function(testName, runtimeOptions, testContent) {
+  let targetRuntimeOptions = testContent ? Object.assign(runtimeOptions, { name: testName }) : { name: testName };
+  let targetTestContent = testContent ? testContent : runtimeOptions;
+
+  return it(targetRuntimeOptions, async function() {
+    let metadata = { testName, options: targetRuntimeOptions, expectedTestCount: undefined };
+    return await targetTestContent(assert, metadata);
+
+    if (expectedTestCount) {
+
+    }
+  });
+}
+
+function assignDefaultValues(options, defaultValues) {
+  for (let key in defaultValues) {
+    if (options[key] === undefined) {
+      options[key] = defaultValues[key];
+    }
+  }
+
+  return options;
+}

package/shims/nodejs-assert.js

@@ -2,10 +2,13 @@ import assert from 'node:assert';
 
 // TODO: write test cases for these
 export default {
+  _steps: [],
   async: assert.async,
   deepEqual: assert.deepStrictEqual,
   equal: assert.strictEqual,
-  expect: assert.expect,
+  expect() {
+    return () => {}; // NOTE: NOT implemented
+  },
   false: assert.false,
   notDeepEqual: assert.notDeepStrictEqual,
   notEqual: assert.notEqual,
@@ -19,10 +22,14 @@ export default {
   propContains: assert.propContains,
   pushResult: assert.pushResult,
   rejects: assert.rejects,
-  step: assert.step,
+  step(value = '') {
+    this._steps.push(value);
+  },
   strictEqual: assert.strictEqual,
   throws: assert.throws,
   timeout: assert.timeout,
   true: assert.true,
-  verifySteps: assert.verifySteps
+  verifySteps(steps, message = 'Verify steps failed!') {
+    return assert.deepEqual(this._steps, steps, message);
+  }
 };

package/shims/nodejs.js

@@ -28,6 +28,8 @@ function assignDefaultValues(options, defaultValues) {
       options[key] = defaultValues[key];
     }
   }
+
+  return options;
 }
 
 // NOTE: later maybe expose these as well: