@lumjs/tests 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -11,6 +11,25 @@ and a reference to a property of a module will be in `@tests.propName` format.
 
 ## [Unreleased]
 
+## [2.1.0] - 2025-11-26
+### Changed
+- Bumped core version to newest release with changes to _stringify_.
+- Updated `test/stats` to support new stringify API changes.
+- Updated `test/log` to use stringify from the test instance.
+- Changed how `harness/node` tests to see if a file should be used as a test.
+  - addDir() method now composes the Harness options with opts argument.
+  - A new `matchFiles` option can specify a custom function that will
+    be passed the file information object and the return value will be
+    used in a boolean context to determine if the file is a test or not.
+  - If specified, `matchFiles` will be used _instead of_ the `ext` option.
+  - The `ext` option now checks for `/`, `(` or `[` characters, 
+    which would indicate it is a RegExp pattern of some sort.
+    - `\.[cm]?js$` would match `.js`, `.cjs`, and `.mjs` files.
+    - `/\.js$/i` would match `.js`, `.JS`, `.Js`, and `.jS` files.
+  - If no special characters are found, the value is assumed to be
+    a single, case-sensitive file extension.
+  - The default is still `.js` if the `ext` option was not specified.
+
 ## [2.0.0] - 2024-08-14
 ### Added
 - The `Stats` class (and `Test` which extends it) now has async support.

package/TODO.md

@@ -1,5 +1,7 @@
 # TODO
 
+- Add explicit support for running ES Module based tests.
+- An alternative to passing `module` object to test instances.
 - Write tests for:
   - `call()`
   - `diesWith()`
@@ -9,3 +11,4 @@
   - `async()` (currently used in `@lumjs/encode:v2.0.0` package).
 - Test the `harness/parser` and associated `grammar/tap` libraries.
 - Test the *external* test mode in `Harness`.
+

package/lib/harness/plugin/node.js

@@ -1,11 +1,13 @@
 // Node.js harness plugin
 const core = require('@lumjs/core');
-const {N} = core.types;
+const {N,F,S} = core.types;
 const Plugin = require('./index');
 const cp = require('node:child_process');
 const getCwd = require('node:process').cwd;
 const fs = require('node:fs');
 const path = require('node:path');
+const RE = /[\/\(\[]+/;
+const WS = /\s+/g;
 
 /**
  * Node.js Harness plugin
@@ -41,17 +43,43 @@ class NodePlugin extends Plugin
     }
   }
 
-  addDir(dir, opts={}, recurse)
+  addDir(dir, opts, recurse)
   {
+    opts = Object.assign({}, this.harness.options, opts);
+
     if (typeof recurse !== N && typeof opts.recurse === N)
     {
       recurse = opts.recurse;
     }
 
-    const ext = opts.ext ?? '.js';
     const testOpts = opts.test ?? opts;
     const files = fs.readdirSync(dir, {encoding: 'utf8', withFileTypes: true});
 
+    let isTest = opts.matchFiles;
+    if (typeof isTest !== F)
+    { // No custom test, let's make one.
+      let ext = opts.ext ?? '.js';
+
+      if (typeof ext === S)
+      {
+        ext = ext.trim();
+        if (ext.match(RE)) 
+        { // A RegExp pattern string of some sort.
+          ext = ext.split('/').map(v => v.replaceAll(WS, '')).filter(v => v !== '');
+          ext = new RegExp(...ext);
+        }
+        else
+        { // A simple file extension.
+          isTest = (file) => file.name.endsWith(ext);
+        }
+      }
+
+      if (ext instanceof RegExp)
+      { // RegExp filename test.
+        isTest = (file) => file.name.match(ext);
+      }
+    }
+
     for (const file of files)
     {
       if (file.name === '.' || file.name === '..') continue;
@@ -59,7 +87,7 @@ class NodePlugin extends Plugin
       { // Recurse to a nested directory.
         this.addDir(path.join(dir, file.name), opts, recurse-1);
       }
-      else if (file.isFile() && file.name.endsWith(ext))
+      else if (file.isFile() && isTest(file))
       { // It would seem to be a valid test.
         this.harness.addTest(path.join(dir, file.name), testOpts);
       }

package/lib/test/log.js

@@ -1,6 +1,6 @@
 
 const types = require('@lumjs/core').types;
-const {S,O,isArray,stringify,def} = types;
+const {S,O,isArray,def} = types;
 
 /**
  * A log representing the results of a test.
@@ -37,7 +37,6 @@ class LumTestLog
     this.desc = null;
     this.directive = null;
     this.details = {};
-    this.stringifyDepth = test.stringifyDepth;
     def(this, '$test$', test);
   }
 
@@ -52,7 +51,7 @@ class LumTestLog
    */
   tap (num)
   {
-    const SD = this.stringifyDepth;
+    const test = this.$test$;
 
     var out;
     if (this.ok)
@@ -81,13 +80,13 @@ class LumTestLog
       const stringy = this.details.stringify;
       
       let got = this.details.got;
-      if (stringy) got = stringify(got, SD);
+      if (stringy) got = test.stringify(got);
       out += `#       got: ${got}\n`;
 
       if ('wanted' in this.details)
       {
         let want = this.details.wanted;
-        if (stringy) want = stringify(want, SD);
+        if (stringy) want = test.stringify(want);
         out += `#  expected: ${want}\n`;
       }
 
@@ -106,7 +105,9 @@ class LumTestLog
 
       for (const i in info)
       {
-        const line = (typeof info[i] === S) ? info[i] : stringify(info[i], SD);
+        const line = (typeof info[i] === S) 
+          ? info[i] 
+          : test.stringify(info[i]);
         out += `# - ${line}\n`;
       }
     }

package/lib/test/stats.js

@@ -11,6 +11,12 @@ const DEFAULT_ASYNC_OPTS =
   interval: 5,
 }
 
+const DEFAULT_STRINGIFY_OPTS =
+{
+  maxDepth: 1,
+  jsonObjects: true,
+}
+
 /**
  * Minimalistic base class for the `Test` library.
  * 
@@ -80,8 +86,10 @@ class LumTestStats
       this.id = null;
     }
 
-    this.stringifyDepth = opts.stringify ?? 1;
-
+    this.stringifyOpts = Object.assign({}, 
+      DEFAULT_STRINGIFY_OPTS, 
+      opts.stringify);
+    
     this.failed  = 0;
     this.skipped = 0;
     this.planned = 0;
@@ -134,10 +142,9 @@ class LumTestStats
     return new Log(this);
   }
 
-  // A wrapper around types.stringify()
   stringify(what)
   {
-    return types.stringify(what, this.stringifyDepth);
+    return types.stringify(what, this.stringifyOpts);
   }
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lumjs/tests",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "main": "lib/index.js",
   "bin":
   {
@@ -27,7 +27,7 @@
   },
   "dependencies": 
   {
-    "@lumjs/core": "^1.26.0"
+    "@lumjs/core": "^1.38.4"
   },
   "scripts": {
     "test": "./bin/lumtest.js",