qunitx-cli 0.5.5 → 0.5.7

package/lib/utils/path-exists.js

@@ -1,5 +1,15 @@
 import fs from 'node:fs/promises';
 
+/**
+ * Returns `true` if the given filesystem path is accessible, `false` otherwise.
+ * @example
+ * ```js
+ * import pathExists from './lib/utils/path-exists.js';
+ * console.assert(await pathExists('/tmp') === true);
+ * console.assert(await pathExists('/tmp/nonexistent-qunitx-file') === false);
+ * ```
+ * @returns {Promise<boolean>}
+ */
 export default async function pathExists(path) {
   try {
     await fs.access(path);

package/lib/utils/read-boilerplate.js

@@ -1,11 +1,15 @@
-import { isSea, getAsset } from 'node:sea';
 import fs from 'node:fs/promises';
 import { dirname, join } from 'node:path';
 import { fileURLToPath } from 'node:url';
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
+/**
+ * Reads a boilerplate file by relative path, using the SEA asset store when running as a Node.js binary.
+ * @returns {Promise<string>}
+ */
 export default async function readBoilerplate(relativePath) {
-  if (isSea()) return getAsset(relativePath, 'utf8');
-  return (await fs.readFile(join(__dirname, '../boilerplates', relativePath))).toString();
+  const sea = await import('node:sea').catch(() => null);
+  if (sea?.isSea()) return sea.getAsset(relativePath, 'utf8');
+  return (await fs.readFile(join(__dirname, '../../templates', relativePath))).toString();
 }

package/lib/utils/resolve-port-number-for.js

@@ -1,3 +1,7 @@
+/**
+ * Returns `portNumber` if it is free, otherwise recursively tries `portNumber + 1` until a free port is found.
+ * @returns {Promise<number>}
+ */
 export default async function resolvePortNumberFor(portNumber) {
   if (await portIsAvailable(portNumber)) {
     return portNumber;

package/lib/utils/run-user-module.js

@@ -1,5 +1,9 @@
 import kleur from 'kleur';
 
+/**
+ * Dynamically imports `modulePath` and calls its default export with `params`; exits with code 1 on error.
+ * @returns {Promise<void>}
+ */
 export default async function runUserModule(modulePath, params, scriptPosition) {
   try {
     const func = await import(modulePath);

package/lib/utils/search-in-parent-directories.js

@@ -1,5 +1,9 @@
 import pathExists from './path-exists.js';
 
+/**
+ * Recursively searches `directory` and its ancestors for a file or folder named `targetEntry`; returns the absolute path or `undefined`.
+ * @returns {Promise<string|undefined>}
+ */
 async function searchInParentDirectories(directory, targetEntry) {
   const resolvedDirectory = directory === '.' ? process.cwd() : directory;
 

package/lib/utils/time-counter.js

@@ -1,4 +1,15 @@
-export default function () {
+/**
+ * Returns a timer object with a `startTime` Date and a `stop()` method that returns elapsed milliseconds.
+ * @example
+ * ```js
+ * import timeCounter from './lib/utils/time-counter.js';
+ * const t = timeCounter();
+ * const ms = t.stop();
+ * console.assert(ms >= 0);
+ * ```
+ * @returns {{ startTime: Date, stop: () => number }}
+ */
+export default function timeCounter() {
   const startTime = new Date();
 
   return {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "qunitx-cli",
   "type": "module",
-  "version": "0.5.5",
+  "version": "0.5.7",
   "description": "Browser runner for QUnitx: run your qunitx tests in google-chrome",
   "main": "cli.js",
   "author": "Izel Nakri",
@@ -19,17 +19,21 @@
     "format": "prettier --check \"lib/**/*.js\" \"test/**/*.js\" \"*.js\" \"package.json\" \".github/**/*.yml\"",
     "format:fix": "prettier --write \"lib/**/*.js\" \"test/**/*.js\" \"*.js\" \"package.json\" \".github/**/*.yml\"",
     "lint": "deno lint lib/ cli.js",
+    "lint:docs": "node scripts/lint-docs.js",
+    "docs": "deno doc --html --name=\"qunitx-cli\" --output=docs/lib 'lib/**/*.js' README.md",
     "build": "node build.js",
     "changelog:unreleased": "git-cliff --unreleased --strip all",
     "changelog:preview": "git-cliff",
     "changelog:update": "git-cliff --output CHANGELOG.md",
+    "postinstall": "deno install --allow-scripts=npm:puppeteer || true",
     "prepack": "npm run build",
     "test": "node test/setup.js && FORCE_COLOR=0 node --test test/**/*-test.js",
     "test:sanity-first": "./cli.js test/helpers/failing-tests.js test/helpers/failing-tests.ts",
     "test:sanity-second": "./cli.js test/helpers/passing-tests.js test/helpers/passing-tests.ts"
   },
   "engines": {
-    "node": ">=24.0.0"
+    "node": ">=24.0.0",
+    "deno": ">=2.7.0"
   },
   "bin": {
     "qunitx": "cli.js"

package/lib/boilerplates/default-project-config-values.js

@@ -1,6 +0,0 @@
-export default {
-  output: 'tmp',
-  timeout: 20000,
-  failFast: false,
-  port: 1234,
-};