sxy-test-runner 1.4.4 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sxy-test-runner",
-  "version": "1.4.4",
+  "version": "2.0.0",
   "license": "MIT",
   "homepage": "https://github.com/RobertSandiford/sxy-test-runner",
   "repository": {
@@ -17,8 +17,12 @@
     "Automated Tests"
   ],
   "type": "module",
+  "engines": {
+    "node": ">=24"
+  },
   "main": "dist/index.js",
   "module": "dist/index.js",
+  "types": "dist/index.d.ts",
   "bin": {
     "sxy-test": "./dist/cli/index.js",
     "sxy-test-runner": "./dist/cli/index.js"
@@ -29,41 +33,42 @@
     "readme.md"
   ],
   "dependencies": {
-    "@babel/core": "^7.24.4",
-    "chalk-extensions": "^1.0.1",
+    "chalk": "^4.1.2",
     "chokidar": "^3.6.0",
     "cross-env": "^7.0.3",
     "dependency-tree": "^8.1.2",
     "esm-reload": "^1.0.1",
-    "figures": "^4.0.1",
-    "glob": "^7.2.3",
-    "globby": "^12.2.0",
     "minimatch": "^5.1.6",
     "node-watch": "^0.7.4",
-    "slash": "^5.1.0",
-    "sxy-dev-tools": "^1.0.6",
-    "sxy-helpers": "^1.0.0",
-    "sxy-lib": "^3.0.4",
-    "sxy-lib-object-copy": "^2.0.5"
+    "sxy-lib": "^3.0.4"
   },
   "devDependencies": {
-    "@babel/cli": "^7.24.1",
-    "babel-plugin-transform-awaitful": "^1.0.0",
+    "@types/chai": "^4.3.20",
+    "@types/chai-as-promised": "^7.1.8",
+    "@types/minimatch": "^5.1.2",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^24.0.0",
+    "@types/sinon": "^17.0.4",
+    "@types/sinon-chai": "^3.2.12",
     "chai": "^4.4.1",
     "chai-as-promised": "^7.1.1",
-    "eslint": "^7.32.0",
-    "eslint-config-sandi": "^1.2.0",
+    "eslint": "^9.39.4",
+    "eslint-config-tungsten-flat": "^0.2.0",
     "mocha": "^9.2.2",
     "mocha-steps": "^1.3.0",
     "nodemon": "^2.0.22",
     "sinon": "^12.0.1",
-    "sinon-chai": "^3.7.0"
+    "sinon-chai": "^3.7.0",
+    "typescript": "^6.0.3"
   },
   "scripts": {
-    "build": "babel --watch --out-dir dist src",
-    "build-once": "babel --out-dir dist src",
+    "build": "tsc --watch",
+    "build-once": "tsc",
     "dev": "cross-env NODE_OPTIONS=\"--experimental-specifier-resolution=node\" nodemon --experimental-specifier-resolution=node --watch dist/cli --watch dist/cli/lib --watch sxy-test-runner.config.js --watch sxy-loader.config.js dist/cli/index.js",
     "dev-once": "nodemon --experimental-specifier-resolution=node --watch dist/cli --watch sxy-test-runner.config.js --watch sxy-loader.config.js dist/cli/index.js once",
+    "start": "cross-env NODE_OPTIONS=\"--experimental-specifier-resolution=node\" node --experimental-specifier-resolution=node dist/cli/index.js",
+    "once": "node --experimental-specifier-resolution=node dist/cli/index.js once",
+    "once:profile": "cross-env SXYT_TIME_PROFILING=true node --experimental-specifier-resolution=node dist/cli/index.js once",
     "dev-init": "node --experimental-specifier-resolution=node dist/cli/index.js init",
     "unit-test": "mocha --watch --parallel --config unitTesting/.mocharc.cjs --watch-files dist,unitTesting dist/**/*.unitTest.js",
     "unit-tests": "unit-test",
@@ -87,7 +92,6 @@
     "unit-test-add-exports": "mocha --watch --parallel --config unitTesting/.mocharc.cjs --watch-files dist,unitTesting dist/**/addExports.unitTest.js",
     "unit-test-describe": "mocha --watch --parallel --config unitTesting/.mocharc.cjs --watch-files dist,unitTesting dist/**/describe.unitTest.js",
     "unit-test-run-tests": "mocha --watch --parallel --config unitTesting/.mocharc.cjs --watch-files dist,unitTesting dist/**/runTests.unitTest.js",
-    "mocha-trial": "mocha --watch --parallel --config unitTesting/.mocharc.cjs --watch-files dist,unitTesting dist/**/runTest.unitTest.js",
-    "prepublish": "pnpm build-once"
+    "mocha-trial": "mocha --watch --parallel --config unitTesting/.mocharc.cjs --watch-files dist,unitTesting dist/**/runTest.unitTest.js"
   }
 }

package/dist/cli/files.js

@@ -1,20 +0,0 @@
-
-// import { watch } from './watch.js'
-
-// // args: string[]
-// export function files() {
-//     //const args = global.commandLineArguments
-
-//     if (args.length === 0) {
-//         return console.log(
-//             '`sxy-test-runner files` requires an argument which is a global pattern of test files to run'
-//         )
-//     }
-//     if (args.length > 1) {
-//         return console.log(
-//             '`sxy-test-runner files` only accepts 1 argument at present'
-//         )
-//     }
-//     const pattern = args[0]
-//     watch()
-// }

package/dist/cli/files.unitTest.js

@@ -1,246 +0,0 @@
-
-// import figures from 'figures'
-
-// //import { applyConfigDefaults } from './lib/applyConfigDefaults.js'
-// import { files } from './files.js'
-
-// mochaDescribe('files command', function() {
-
-//     mochaIt('should fail with empty args', async function() {
-//         this.timeout(10000)
-
-//         const originalConsoleLog = console.log
-//         let consoleLogBuffer = ''
-//         console.log = sync(function testLog(...texts) {
-//             consoleLogBuffer += texts.join(' ') + '\n'
-//         })
-
-//         global.commandLineArguments = [
-//             '--config',
-//             'unitTesting/watch/sxy-test-runner.config.js'
-//         ]
-
-//         promise( files([]) )
-//         await new Promise( (resolve, reject) => { setTimeout(resolve, 8000) } )
-
-//         console.log = originalConsoleLog
-
-//         //console.log(consoleLogBuffer)
-//         consoleLogBuffer.should.include( 'requires an argument' )
-//     })
-
-//     mochaIt('should fail with too many args', async function() {
-//         this.timeout(10000)
-
-//         const originalConsoleLog = console.log
-//         let consoleLogBuffer = ''
-//         console.log = sync(function testLog(...texts) {
-//             consoleLogBuffer += texts.join(' ') + '\n'
-//         })
-
-//         global.commandLineArguments = [
-//             '--config',
-//             'unitTesting/watch/sxy-test-runner.config.js'
-//         ]
-
-//         promise( files(['a', 'b']) )
-//         await new Promise( (resolve, reject) => { setTimeout(resolve, 8000) } )
-
-//         console.log = originalConsoleLog
-
-//         //console.log(consoleLogBuffer)
-//         consoleLogBuffer.should.include( 'only accepts 1 argument' )
-//     })
-
-//     mochaIt('should run tests and output results and display correct tallies', async function() {
-//         this.timeout(10000)
-
-//         const originalConsoleLog = console.log
-//         let consoleLogBuffer = ''
-//         console.log = sync(function testLog(...texts) {
-//             consoleLogBuffer += texts.join(' ') + '\n'
-//         })
-
-//         global.commandLineArguments = [
-//             '--config',
-//             'unitTesting/watch/sxy-test-runner.config.js'
-//         ]
-
-//         promise( files(['**/1.test.js']) )
-//         await new Promise( (resolve, reject) => { setTimeout(resolve, 8000) } )
-
-//         console.log = originalConsoleLog
-
-//         //console.log(consoleLogBuffer)
-
-//         const testFileName = `unitTesting/watch/1.test.js`
-//         const thing = 'Sample test 1'
-//         const should = '1 should equal 1'
-
-//         console.log(consoleLogBuffer)
-
-//         consoleLogBuffer.should.include( testFileName )
-//         consoleLogBuffer.should.include( thing )
-//         consoleLogBuffer.should.include( should )
-//         consoleLogBuffer.should.include( figures.tick )
-
-//         consoleLogBuffer.should.include( 'Tests: 1/1' )
-//         consoleLogBuffer.should.include( 'Items: 1/1' )
-//         consoleLogBuffer.should.include( 'Test Files: 1/1' )
-
-//     })
-
-// /*
-//     mochaIt('should run tests and output results and display correct tallies', async function() {
-//         this.timeout(10000)
-
-//         const originalConsoleLog = console.log
-//         let consoleLogBuffer = ''
-//         console.log = sync(function testLog(...texts) {
-//             consoleLogBuffer += texts.join(' ') + '\n'
-//         })
-
-//         global.commandLineArguments = [
-//             '--config',
-//             'unitTesting/watch/sxy-test-runner.config.js'
-//         ]
-
-//         promise( watch() )
-//         await new Promise( (resolve, reject) => { setTimeout(resolve, 8000) } )
-
-//         console.log = originalConsoleLog
-
-//         //console.log(consoleLogBuffer)
-
-//         const testFileName = `unitTesting/watch/1.test.js`
-//         const thing = 'Sample test 1'
-//         const should = '1 should equal 1'
-
-//         consoleLogBuffer.should.include( testFileName )
-//         consoleLogBuffer.should.include( thing )
-//         consoleLogBuffer.should.include( should )
-//         consoleLogBuffer.should.include( figures.tick )
-
-//         consoleLogBuffer.should.include( 'Tests: 3/3' )
-//         consoleLogBuffer.should.include( 'Items: 2/2' )
-//         consoleLogBuffer.should.include( 'Test Files: 2/2' )
-
-//     })
-
-//     mochaIt('should run tests and display correct tallies', async function() {
-//         this.timeout(10000)
-
-//         const originalConsoleLog = console.log
-//         let consoleLogBuffer = ''
-//         console.log = sync(function testLog(...texts) {
-//             consoleLogBuffer += texts.join(' ') + '\n'
-//         })
-
-//         global.commandLineArguments = [
-//             '--config',
-//             'unitTesting/watch/sxy-test-runner.config.js'
-//         ]
-
-//         promise( watch() )
-//         await new Promise( (resolve, reject) => { setTimeout(resolve, 8000) } )
-
-//         console.log = originalConsoleLog
-
-//         //console.log(consoleLogBuffer)
-
-//         const testFileName = `unitTesting/watch/1.test.js`
-//         const thing = 'Sample test 1'
-//         const should = '1 should equal 1'
-
-//         consoleLogBuffer.should.include( testFileName )
-//         consoleLogBuffer.should.include( thing )
-//         consoleLogBuffer.should.include( should )
-//         consoleLogBuffer.should.include( figures.tick )
-
-//     })
-
-//     mochaIt('should warn us when there are no tests', async function() {
-//         this.timeout(6000)
-
-//         const originalConsoleLog = console.log
-//         let consoleLogBuffer = ''
-//         console.log = sync(function testLog(...texts) {
-//             consoleLogBuffer += texts.join(' ') + '\n'
-//         })
-
-//         global.commandLineArguments = [
-//             '--config',
-//             'sxy-test-runner.no-tests.config.js'
-//         ]
-
-//         promise( watch() )
-//         await new Promise( (resolve, reject) => { setTimeout(resolve, 4000) } )
-
-//         console.log = originalConsoleLog
-
-//         //console.log('saved console.log output:')
-//         //console.log(consoleLogBuffer)
-
-//         consoleLogBuffer.should.include( 'no tests found' )
-//         consoleLogBuffer.should.not.include( 'describing' )
-
-//     })
-
-//     mochaIt('should not run tests when asked not to run initial tests', async function() {
-//         this.timeout(6000)
-
-//         const originalConsoleLog = console.log
-//         let consoleLogBuffer = ''
-//         console.log = sync(function testLog(...texts) {
-//             consoleLogBuffer += texts.join(' ') + '\n'
-//         })
-
-//         global.commandLineArguments = [
-//             '--config',
-//             'sxy-test-runner.no-initial-tests.config.js'
-//         ]
-
-//         promise( watch() )
-//         await new Promise( (resolve, reject) => { setTimeout(resolve, 4000) } )
-
-//         console.log = originalConsoleLog
-
-//         //console.log('saved console.log output:')
-//         //console.log(consoleLogBuffer)
-
-//         //consoleLogBuffer.should.not.include( 'no tests found' ) // not sure - removing for now
-//         consoleLogBuffer.should.not.include( 'running initial tests' )
-//         consoleLogBuffer.should.not.include( 'describing' )
-//         consoleLogBuffer.should.include( 'watching' )
-
-//     })
-
-//     mochaIt('setup function and setup file from the config should have run', async function() {
-//         this.timeout(6000)
-
-//         global.configBasedSetupFunctionRan = false
-//         global.watchSetupFileHasRun = false
-
-//         const originalConsoleLog = console.log
-//         let consoleLogBuffer = ''
-//         console.log = sync(function testLog(...texts) {
-//             consoleLogBuffer += texts.join(' ') + '\n'
-//         })
-
-//         global.commandLineArguments = [
-//             '--config',
-//             'sxy-test-runner.setup-tasks.config.js'
-//         ]
-
-//         promise( watch() )
-//         await new Promise( (resolve, reject) => {
-//             setTimeout(resolve, 2000)
-//         } )
-
-//         console.log = originalConsoleLog
-
-//         global.configBasedSetupFunctionRan.should.equal(true)
-//         global.watchSetupFileHasRun.should.equal(true)
-
-//     })*/
-// })

package/dist/cli/lib/defaultConfig.test.js

@@ -1,9 +0,0 @@
-import { defaultConfig } from './defaultConfig.js';
-
-// applyConfigDefaults( userConfig: {} )
-
-await mochaDescribe('the defaultConfig', async function () {
-  await mochaIt('has sensible defaults', async function () {
-    await defaultConfig.should.include.keys(['tests', 'testsIgnore', 'watch']);
-  });
-});

package/dist/cli/lib/loadTestFileStatic.js

@@ -1,41 +0,0 @@
-
-/*
-
-I can't remember what this was for.
-
-Would need updating to the new file load system if used
-
-import { createTimeProfiler } from 'sxy-dev-tools'
-import { packageName, cliName, configFileName, configLocations, showTimeProfiling } from '../../config.js'
-import { join } from 'path'
-const { timeProfileAsync } = createTimeProfiler(showTimeProfiling)
-
-// could be used within runTests
-// think its not used now
-
-export function loadTestFileStatic(config, testFile) {
-
-    return timeProfileAsync(`load test ${testFile} statically (standard import)`, () => {
-
-        //console.log('loadTestFileStatic', config, testFile)
-        
-        const projectDir = process.cwd()
-
-        global.testState = {
-            describes: [],
-            describeCounter: 1
-        }
-
-        import( 'file://' + join(projectDir, testFile) )
-
-        const test = {
-            file: testFile,
-            describes: global.testState.describes
-        }
-
-        return test
-
-    } )
-
-}
-*/

package/dist/cli/lib/loadTestFileStatic.unitTest.js

@@ -1,30 +0,0 @@
-
-/*
-import { loadTestFileStatic } from "./loadTestFileStatic.js"
-import { applyConfigDefaults } from './applyConfigDefaults.js'
-
-// loadTestFile(config, testFile) ???
-
-mochaDescribe('loadTestFileStatic() function', function() {
-
-    mochaIt('should load a test file, retreiving describes', function() {
-
-        const config = applyConfigDefaults({})
-
-        const sampleTestFile = 'unitTesting/sampleTests/1.test.js'
-
-        const test = loadTestFileStatic(config, sampleTestFile)
-
-        test.describes.length.should.equal(1)
-        test.describes[0].counter.should.equal(1)
-        test.describes[0].its[0].counter.should.equal(1)
-
-    })
-
-    // mochaIt('should be able to load a test file again, after cache is cleard', function() {
-
-
-    // })
-
-})
-*/

package/dist/cli/lib/processWatchEvent.js

@@ -1 +0,0 @@
-//

package/dist/cli/lib/processWatchEvent.unitTest.js

@@ -1,15 +0,0 @@
-
-
-//import { processWatchEvent } from './processWatchEvent.js'
-
-// parseCommandLineArguments(allowedArguments)
-
-// mochaDescribe('processWatchEvent() function', function() {
-
-//     mochaIt('identifies a test in a watch event', function() {
-
-//         processWatchEvent('watchTests/a.test.js', 'update')
-
-//     })
-
-// })

package/dist/cli/lib/runDescribe.old.js

@@ -1,108 +0,0 @@
-import { timeProfileAsync } from './timeProfier.js';
-import { runTasks } from './runTasks.js';
-import { addExports } from './addExports.js';
-import { debug } from '../../output.js';
-import { runIt } from './runIt.js';
-export async function runDescribeOld(config, describe) {
-  return await timeProfileAsync(`run describe ${describe.thing}`, async () => {
-    let itCounter = 1;
-    const its = [];
-
-    // create functions to pass back
-
-    // afterDescribe
-    let afterDescribeFunc;
-    async function afterDescribe(func) {
-      if (typeof func !== 'function') {
-        throw new Error(`afterDescribe() error, argument passed to afterDescribe() must be a function,` + ` received ${typeof func}`);
-      }
-      afterDescribeFunc = func;
-    }
-
-    // beforeEachTest
-    let beforeEachTestFunc;
-    async function beforeEachTest(func) {
-      if (typeof func !== 'function') {
-        throw new Error(`afterDescribe() error, argument passed to afterDescribe() must be a function,` + ` received ${typeof func}`);
-      }
-      beforeEachTestFunc = func;
-    }
-
-    // afterEachTest
-    let afterEachTestFunc;
-    async function afterEachTest(func) {
-      if (typeof func !== 'function') {
-        throw new Error(`afterDescribe() error, argument passed to afterDescribe() must be a function,` + ` received ${typeof func}`);
-      }
-      afterEachTestFunc = func;
-    }
-
-    // it
-    async function it(should, test) {
-      const thisItCounter = itCounter++;
-      await its.push({
-        counter: thisItCounter,
-        should,
-        test
-        //beforeEachTestExports
-      });
-    }
-    const test = it;
-    const describeExports = {};
-    await configBeforeEachDescribe(config, describeExports);
-    const describeParcel = {
-      it,
-      test,
-      afterDescribe,
-      beforeEachTest,
-      afterEachTest
-    };
-    await addExports(describeParcel, describeExports);
-    await describe.tests(describeParcel);
-
-    //console.log('its', its)
-
-    // const beforeEachDescribeExports = (config.beforeEachDescribe)
-    //     ? runTasks(config, config.beforeEachDescribe)
-    //     : {}
-
-    //const thisDescribeCounter = describeCounter++ // assign THEN increment
-    //let itCounter = 1
-    const itResults = [];
-    for (const it of its) {
-      await itResults.push(await runIt(config, it, beforeEachTestFunc, afterEachTestFunc));
-    }
-    const itResultsSummary = {
-      total: 0,
-      passes: 0
-    };
-    for (const itResult of itResults) {
-      itResultsSummary.total += +(itResult.success !== null);
-      itResultsSummary.passes += +itResult.success;
-    }
-    await debug('itResultsSummary', itResultsSummary);
-    const describeResult = {
-      counter: describe.counter,
-      thing: describe.thing,
-      success: itResultsSummary.total > 0 ? itResultsSummary.passes === itResultsSummary.total : null,
-      itResults,
-      itResultsSummary
-    };
-
-    // run after 
-    if (typeof afterDescribeFunc === 'function') await afterDescribeFunc();
-    await configAfterEachDescribe(config, describeExports);
-    return describeResult;
-  });
-}
-async function configBeforeEachDescribe(config, exports) {
-  if (config.beforeEachDescribe) {
-    const theExports = await runTasks(config.beforeEachDescribe, undefined);
-    await addExports(exports, theExports);
-  }
-}
-async function configAfterEachDescribe(config, exports) {
-  if (config.afterEachDescribe) {
-    await runTasks(config.afterEachDescribe, exports);
-  }
-}