sxy-test-runner 1.0.14 → 1.0.16

package/dist/cli/index.js

@@ -1,31 +1,27 @@
 #!/usr/bin/env node
+
+// need to change this to a safe version
 import 'sxy-standard';
 import 'sxy-standard-object-copy';
 const args = await process.argv.slice(2);
-
 if (args.length > 0) {
   const command = args[0];
-
   switch (command) {
     case 'init':
       await doCommand(command, await args.slice(1));
       break;
-
     case 'once':
       await doCommand(command, await args.slice(1));
       break;
-
     case 'watch':
       await doCommand(command, await args.slice(1));
       break;
-
     default:
       await doCommand('watch', args);
   }
 } else {
   await doCommand('watch', args);
 }
-
 async function doCommand(command, args) {
   global.commandLineArguments = args;
   await (await import(`./${command}.js`))[command]();

package/dist/cli/init.js

@@ -5,43 +5,33 @@ import { out, log, debug } from '../output.js';
 import fs from 'fs';
 export async function init() {
   const projectDir = await process.cwd();
-
   for (const configLocation of configLocations) {
     let loc;
     loc = await join(projectDir, configLocation, configFileName + '.js');
-
     if (await fs.existsSync(loc)) {
       await configAlreadyExists(loc);
     }
-
     loc = await join(projectDir, configLocation, configFileName + '.cjs');
-
     if (await fs.existsSync(loc)) {
       await configAlreadyExists(loc);
     }
-
     loc = await join(projectDir, configLocation, configFileName + '.mjs');
-
     if (await fs.existsSync(loc)) {
       await configAlreadyExists(loc);
     }
   }
-
   async function configAlreadyExists(loc) {
     await out(chalk.orange`[${packageName}] A matching config already exists at ${loc}` + `\nPlease remove this config before generating a new one with \`${cliName} init\``);
   }
-
   const projectPackageJsonLocation = await join(projectDir, 'package.json');
-
   if (!(await fs.existsSync(projectPackageJsonLocation))) {
     await out(chalk.orange`[${packageName}] No package.json exists in this location` + `\nPlease initialise the package with \`yarn init\` on \`npm init\`` + ` before running this command, and run this command from the project root folder`);
-  } //const packageJsonRaw = await fs.promises.readFile( projectPackageJsonLocation )
-
+  }
 
+  //const packageJsonRaw = await fs.promises.readFile( projectPackageJsonLocation )
   const packageJsonRaw = await fs.readFileSync(projectPackageJsonLocation);
   const packageJson = await JSON.parse(packageJsonRaw);
   let targetConfigName;
-
   if (packageJson.type === 'module') {
     // ES6 module
     targetConfigName = await join(projectDir, configLocations[0], configFileName + '.js');
@@ -49,7 +39,6 @@ export async function init() {
     // common 
     targetConfigName = await join(projectDir, configLocations[0], configFileName + '.mjs');
   }
-
   const defaultConfig = `export default {
 
     // base folder for tests match and ignore patterns
@@ -130,9 +119,12 @@ export async function init() {
 
     },
 
-}`; // `export default {
+}`;
+  // `export default {
+
   //     // base folder for tests match and ignore patterns
   //     testsBase: '.',
+
   //     // glob pattern or array of glob patterns of test files
   //     tests: [
   //         '**/*.test.{js,mjs,jsx}',
@@ -140,29 +132,42 @@ export async function init() {
   //         '**/tests?/*.{js,mjs,jsx}',
   //         '**/__tests?__/*.{js,mjs,jsx}'
   //     ],
+
   //     // glob pattern or array of patterns of test files to ignore
   //     testsIgnore: ['**/node_modules/**/*'],
+
   //     // function to run on startup
   //     setup: undefined,
+
   //     // function to run before each test file
   //     setupEach: undefined,
+
   //     // function to run after test run
   //     teardown: undefined,
+
   //     // function to run after each test file
   //     teardownEach: undefined,
+
   //     // watch mode configurations
   //     watch: {
+
   //         //// the base directory to watch files in
   //         watchFilesBase: '.',
+
   //         //// glob filter or array of glob filters of files to watch
   //         watchFiles: '**/*.js',
+
   //         //// glob filter or array of globl filters of files to ignore
   //         watchFilesIgnore: '**/node_modules/**/*',
+
   //         // run all tests when starting the watcher
   //         runAllOnStartup: true,
+
   //         // re run all previously failed tests on each test run, until they pass
   //         reRunFailingTests: true,
+
   //     },
+
   // }`
 
   await fs.writeFileSync(targetConfigName, defaultConfig);

package/dist/cli/lib/addBasePath.js

@@ -9,7 +9,6 @@ export async function addBasePath(base, items) {
     if (base !== undefined && base !== '.' && base !== '') {
       items = (await Array.isArray(items)) ? await items.map(item => `${base}/${item}`) : `${base}/${items}`;
     }
-
     return items;
   });
 }

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

@@ -1,5 +1,7 @@
 import { addBasePath } from './addBasePath.js';
-import { join } from 'path'; // addBaseToGlobs(base, globs)
+import { join } from 'path';
+
+// addBaseToGlobs(base, globs)
 // base: string
 // globs: string or array of strings
 

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

@@ -1,6 +1,8 @@
 import { expect } from 'chai';
 import { defaultConfig } from './defaultConfig.js';
-import { addExports } from './addExports.js'; // applyConfigDefaults( userConfig: {} )
+import { addExports } from './addExports.js';
+
+// applyConfigDefaults( userConfig: {} )
 
 import { makeCustomOut } from '../../../unitTesting/makeCustomOut.js';
 await mochaDescribe('addExports() function', async function () {
@@ -15,6 +17,7 @@ await mochaDescribe('addExports() function', async function () {
   });
   await mochaIt('should complain about duplicates', async function () {
     //const { customOut, getOutBuffer, setOutBuffer } = makeCustomOut()
+
     const exports = {
       a: 1,
       b: 2

package/dist/cli/lib/applyConfigDefaults.js

@@ -1,7 +1,9 @@
 import { mergeStructuredConfig, createTimeProfiler } from 'sxy-dev-tools';
+import objectCopy from 'sxy-lib-object-copy';
 import { packageName, cliName, configFileName, configLocations, showTimeProfiling } from '../../config.js';
-import chalk from 'chalk-extensions';
-import { out, log, debug } from '../../output.js';
+//import chalk from 'chalk-extensions'
+//import { out, log, debug } from '../../output.js'
+
 import { defaultConfig } from './defaultConfig.js';
 const {
   timeProfileAsync
@@ -11,22 +13,26 @@ export async function applyConfigDefaults(userConfig) {
     const configStructure = {
       execution: {},
       watch: {}
-    }; //const config = mergeConfig(configStructure, defaultConfig, userConfig)
+    };
+
+    //const config = mergeConfig(configStructure, defaultConfig, userConfig)
+    const config = await mergeStructuredConfig(configStructure, defaultConfig, userConfig);
 
-    const config = await mergeStructuredConfig(configStructure, defaultConfig, userConfig); // I don't think we need to do these - the glob combine func can handle it
+    // I don't think we need to do these - the glob combine func can handle it
     //if ( ! Array.isArray(config.tests) ) config.tests = [config.tests]
     //if ( ! Array.isArray(config.testsIgnore) ) config.tests = [config.testsIgnore]
     // watchFiles
     // watchFilesIgnore
+
     //log('final config', config)
 
     return config;
   });
 }
 
+// is this an old func now replaced?
 async function mergeConfig(structure, baseConfig, ...extraConfigs) {
-  const finalConfig = await Object.copy(baseConfig);
-
+  const finalConfig = await objectCopy(baseConfig);
   for (const extraConfig of extraConfigs) {
     for (const key in extraConfig) {
       if (key in structure) {
@@ -36,6 +42,5 @@ async function mergeConfig(structure, baseConfig, ...extraConfigs) {
       }
     }
   }
-
   return finalConfig;
 }

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

@@ -1,5 +1,7 @@
 import { defaultConfig } from './defaultConfig.js';
-import { applyConfigDefaults } from './applyConfigDefaults.js'; // applyConfigDefaults( userConfig: {} )
+import { applyConfigDefaults } from './applyConfigDefaults.js';
+
+// applyConfigDefaults( userConfig: {} )
 
 await mochaDescribe('applyConfigDefaults() function', async function () {
   await mochaIt('has sensible defaults when passed an empty user config', async function () {
@@ -9,7 +11,9 @@ await mochaDescribe('applyConfigDefaults() function', async function () {
   await mochaIt('retains a passed config setting', async function () {
     const finalConfig = await applyConfigDefaults({
       tests: 'foo'
-    }); //console.log(finalConfig)
+    });
+
+    //console.log(finalConfig)
 
     await finalConfig.tests.should.equal('foo');
   });
@@ -18,7 +22,9 @@ await mochaDescribe('applyConfigDefaults() function', async function () {
       watch: {
         watchFilesBase: 'src'
       }
-    }); //console.log(finalConfig)
+    });
+
+    //console.log(finalConfig)
 
     await finalConfig.watch.watchFiles.should.equal(defaultConfig.watch.watchFiles);
   });

package/dist/cli/lib/buildDependencyTree.js

@@ -4,6 +4,7 @@ import slash from 'slash';
 import 'sxy-standard/light.js';
 export async function buildDependencyTree(config, filename) {
   filename = await slash(filename); // convert to forward slashes
+
   // const filter = path => 
   //    minimatch(path, watchFiles)
   //    && ! minimatch(path, watchFilesIgnores)
@@ -14,19 +15,23 @@ export async function buildDependencyTree(config, filename) {
     //directory: './src',
     directory: config.watch.watchFilesBase,
     filter: path => path.indexOf('node_modules') === -1
-  }; //// this filter needs to be replaced
+  };
+  //// this filter needs to be replaced
 
-  const dt = await dependencyTree(dependencyTreeConfig); // process the results into final format
-  // (forward slashes and convert full path to rel path)
+  const dt = await dependencyTree(dependencyTreeConfig);
 
+  // process the results into final format
+  // (forward slashes and convert full path to rel path)
   const cwd = await process.cwd();
-  await dt.process(file => slash(file).slice(cwd.length + 1)); // remove the current file
+  await dt.process(file => slash(file).slice(cwd.length + 1));
 
+  // remove the current file
   await dt.forEach(file => {
     if (file === filename) {
-      dt.remove(file);
+      dt.remove(file); // arrayRemove?
     }
   });
+
   await debug('found dep tree', dt);
   return dt;
 }

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

@@ -1,6 +1,8 @@
 import { applyConfigDefaults } from './applyConfigDefaults.js';
 import { buildDependencyTree } from './buildDependencyTree.js';
-import { join } from 'path'; // buildDependencyTree(config, file)
+import { join } from 'path';
+
+// buildDependencyTree(config, file)
 // config:
 // file: relative to config.watch.watchFilesBase
 

package/dist/cli/lib/buildDependencyTrees.js

@@ -11,19 +11,21 @@ export async function buildDependencyTrees(config, testFiles) {
   return await timeProfileAsync('build dependency trees', async () => {
     const projectDir = await process.cwd();
     const dependencyTrees = {};
-
     for (const testFile of testFiles) {
       //newTest(testFile.replace('./', ''))
+
       const dependencyTree = await buildDependencyTree(config, testFile);
-      dependencyTrees[testFile] = dependencyTree; //    .map ( sync( file => immed(immed(slash(file)).slice(projectDir.length + 1) )) )
+      dependencyTrees[testFile] = dependencyTree;
+      //    .map ( sync( file => immed(immed(slash(file)).slice(projectDir.length + 1) )) )
       //    .filter( sync(f => immed(f !== testFile)) )
 
       await debug('final dep tree', dependencyTrees[testFile]);
     }
-
     return dependencyTrees;
   });
-} // function newTest(testFile) {
+}
+
+// function newTest(testFile) {
 //     debug('new test', testFile)
 //     const dependencyTree = buildDependencyTree(testFile)
 //     //out('AA dependencyTree', testFile, dependencyTree)

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

@@ -1,6 +1,8 @@
 import { applyConfigDefaults } from './applyConfigDefaults.js';
 import { buildDependencyTrees } from './buildDependencyTrees.js';
-import { join } from 'path'; // buildDependencyTrees(config, files)
+import { join } from 'path';
+
+// buildDependencyTrees(config, files)
 // config:
 // files: relative to config.watch.watchFilesBase
 

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

@@ -1,4 +1,6 @@
-import { defaultConfig } from './defaultConfig.js'; // applyConfigDefaults( userConfig: {} )
+import { defaultConfig } from './defaultConfig.js';
+
+// applyConfigDefaults( userConfig: {} )
 
 await mochaDescribe('the defaultConfig', async function () {
   await mochaIt('has sensible defaults', async function () {

package/dist/cli/lib/doUserSetup.js

@@ -3,7 +3,6 @@ import { out, log, debug } from '../../output.js';
 export async function doUserSetup(config) {
   if (config.setup) {
     const setupTasks = (await Array.isArray(config.setup)) ? config.setup : [config.setup];
-
     for (const setupTask of setupTasks) {
       //console.log( typeof setupTask, setupTask)
       switch (typeof setupTask) {
@@ -12,13 +11,11 @@ export async function doUserSetup(config) {
             await setupTask();
             break;
           }
-
         case 'string':
           {
             await import(`file://${await join(await process.cwd(), setupTask)}`);
             break;
           }
-
         default:
           {
             await out(`Error: setup entry has an invalid type, expected 'function' or 'string' of an file to import.`);

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

@@ -1,5 +1,7 @@
 import { applyConfigDefaults } from './applyConfigDefaults.js';
-import { doUserSetup } from './doUserSetup.js'; // applyConfigDefaults( userConfig: {} )
+import { doUserSetup } from './doUserSetup.js';
+
+// applyConfigDefaults( userConfig: {} )
 
 await mochaDescribe('the doUserSetup() function', async function () {
   await mochaIt('executes a user setup function', async function () {

package/dist/cli/lib/doUserTeardown.js

@@ -3,7 +3,6 @@ import { out, log, debug } from '../../output.js';
 export async function doUserTeardown(config) {
   if (config.teardown) {
     const teardownTasks = (await Array.isArray(config.teardown)) ? config.teardown : [config.teardown];
-
     for (const teardownTask of teardownTasks) {
       //console.log( typeof teardownTask, teardownTask)
       switch (typeof teardownTask) {
@@ -12,13 +11,11 @@ export async function doUserTeardown(config) {
             await teardownTask();
             break;
           }
-
         case 'string':
           {
             await import(`file://${await join(await process.cwd(), teardownTask)}`);
             break;
           }
-
         default:
           {
             await out(`Error: teardown entry has an invalid type, expected 'function' or 'string' of an file to import.`);

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

@@ -1,5 +1,7 @@
 import { applyConfigDefaults } from './applyConfigDefaults.js';
-import { doUserTeardown } from './doUserTeardown.js'; // applyConfigDefaults( userConfig: {} )
+import { doUserTeardown } from './doUserTeardown.js';
+
+// applyConfigDefaults( userConfig: {} )
 
 await mochaDescribe('the doUserTeardown() function', async function () {
   await mochaIt('executes a user teardown function', async function () {

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

@@ -1,5 +1,7 @@
 import { applyConfigDefaults } from './applyConfigDefaults.js';
-import { findTestFiles } from './findTestFiles.js'; // findTestFiles(config)
+import { findTestFiles } from './findTestFiles.js';
+
+// findTestFiles(config)
 
 await mochaDescribe('findTestFiles() function', async function () {
   await mochaIt('finds the tests files', async function () {

package/dist/cli/lib/getAllowedFlags.js

@@ -1,11 +1,9 @@
 export async function getAllowedFlags(allowedArguments) {
   const allowedFlags = {};
-
   for (const option in allowedArguments) {
     if ('flag' in allowedArguments[option]) {
       allowedFlags[allowedArguments[option].flag] = option;
     }
   }
-
   return allowedFlags;
 }

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

@@ -1,4 +1,6 @@
-import { getAllowedFlags } from './getAllowedFlags.js'; // findTestFiles(config)
+import { getAllowedFlags } from './getAllowedFlags.js';
+
+// findTestFiles(config)
 
 await mochaDescribe('getAllowedFlags() function', async function () {
   await mochaIt('extracts the flags from an allowedArguments object', async function () {

package/dist/cli/lib/injectProperties.js

@@ -2,10 +2,10 @@ import { out as mainOut, log, debug } from '../../output.js';
 const reservedKeys = ['describe', 'test', 'it', 'before', 'after', 'beforeEach', 'afterEach', 'beforeAll', 'afterAll'];
 export async function injectProperties(basePackage, injectProperties, from, customOut = undefined) {
   const out = customOut ? async (...texts) => await customOut(...texts) : async (...texts) => await mainOut(...texts);
-
   for (const key in injectProperties) {
     if (await reservedKeys.includes(key)) {
-      await out(`Error: key '${key}' is reserved. Please do not use this key. From '${from}'.`); //process.exit(1)
+      await out(`Error: key '${key}' is reserved. Please do not use this key. From '${from}'.`);
+      //process.exit(1)
     }
   }
 }

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

@@ -3,7 +3,6 @@ import chalk from 'chalk-extensions';
 await mochaDescribe('injectProperties() function', async function () {
   await mochaIt('complains if a reserved property is given', async function () {
     let outBuffer = '';
-
     const customOut = (...texts) => {
       //console.log(chalk.red`outBuffer1`, outBuffer)
       console.log(...texts);
@@ -56,20 +55,28 @@ await mochaDescribe('injectProperties() function', async function () {
     };
     await injectProperties(basePacket, properties, '', customOut);
     await outBuffer.should.include(errorString);
-  }); // mochaIt('complains if a passed property conflics with a base property', function() {
+  });
+
+  // mochaIt('complains if a passed property conflics with a base property', function() {
+
   //     let outBuffer = ''
   //     const customOut = sync((...texts) => {
   //         console.log(...texts)
   //         outBuffer += texts.join(' ') + '\n' // join and save to the buffer
   //     })
+
   //     const errorString = 'is reserved'
+
   //     const basePacket = {}
+
   //     let properties
+
   //     outBuffer = ''
   //     properties = {
   //         describe: true
   //     }
   //     injectProperties(basePacket, properties, '', customOut)
   //     outBuffer.should.include(errorString)
+
   // })
 });

package/dist/cli/lib/loadConfig.js

@@ -9,12 +9,12 @@ export async function loadConfig(customLocation = undefined) {
   return await timeProfileAsync('load config', async () => {
     const configOrNull = customLocation !== undefined ? await sxyLoadConfigExact(customLocation) : await sxyLoadConfig(configFileName, configLocations);
     await debug('configOrNull', typeof configOrNull, configOrNull);
-
     if (!configOrNull) {
       await out(await chalk.orange(`[${packageName}] No config found.` + `\nPlease create a ${configFileName}.js/cjs/mjs file in your project root or /config folder.` + `\nOr run \`npx ${cliName} init\` to create one.`));
       await process.exit(0);
-    } //log('user config', configOrNull)
+    }
 
+    //log('user config', configOrNull)
 
     return configOrNull;
   });

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

@@ -1,6 +1,7 @@
-import { loadConfig } from "./loadConfig.js"; // loadConfig(location)
-// location is option
+import { loadConfig } from "./loadConfig.js";
 
+// loadConfig(location)
+// location is option
 await mochaDescribe('loadConfig() function', async function () {
   await mochaIt('loads a user config', async function () {
     const userConfig = await loadConfig();

package/dist/cli/lib/loadTestFile.js

@@ -14,34 +14,35 @@ export async function loadTestFile(config, testFile) {
     await loading;
     await debug(chalk.yellow`previous file complete - will now load the file`);
   }
-
   const loadPromise = timeProfileAsync(`load test ${testFile}`, async () => {
-    const projectDir = await process.cwd(); // eslint-disable-next-line camelcase
+    const projectDir = await process.cwd();
 
+    // eslint-disable-next-line camelcase
     global.__sxy_test_runner__ = {
       describes: [],
       describeCounter: 1
     };
-    const testFileFullUrl = 'file://' + (await join(projectDir, testFile)); //console.log('testFileFullUrl', testFileFullUrl)
+    const testFileFullUrl = 'file://' + (await join(projectDir, testFile));
+
+    //console.log('testFileFullUrl', testFileFullUrl)
 
     const test = {
       file: testFile
     };
-    const capturingConsoleLog = config.execution.files === 'sequential'; //// capture console.log output
+    const capturingConsoleLog = config.execution.files === 'sequential';
 
+    //// capture console.log output
     let previousConsoleLog;
     const logs = [];
-
     if (capturingConsoleLog) {
       previousConsoleLog = console.log; // eslint-disable-line no-console
-
       console.log = async (...texts) => await logs.push(texts); // eslint-disable-line no-console
-
-    } ////
-
+    }
+    ////
 
     try {
-      await load(testFileFullUrl, {// scopeObject: { // experimental idea
+      await load(testFileFullUrl, {
+        // scopeObject: { // experimental idea
         //     name: 'scope',
         //     contents: {},
         //     exposeObject: 'scope'
@@ -53,21 +54,22 @@ export async function loadTestFile(config, testFile) {
       //error(chalk.red`Error loading file ${testFileFullUrl}`)
       test.error = `Error loading file\n${e}`;
     } finally {
-      test.logs = logs; //// restore previous console.log function
-
+      test.logs = logs;
+      //// restore previous console.log function
       if (capturingConsoleLog) {
         if (capturingConsoleLog) {
           console.log = previousConsoleLog; // eslint-disable-line no-console
         }
-      } ////
+      }
+      ////
+    }
 
-    } // console.log()
+    // console.log()
     // console.log('test', test)
     // console.log('describes', test.describes)
     // console.log('its', test.describes[0].its)
     // console.log()
 
-
     return test;
   });
   loading = loadPromise;

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

@@ -1,5 +1,7 @@
 import { loadTestFile } from "./loadTestFile.js";
-import { defaultConfig } from './defaultConfig.js'; // loadTestFile(config, testFile) ???
+import { defaultConfig } from './defaultConfig.js';
+
+// loadTestFile(config, testFile) ???
 
 await mochaDescribe('loadTestFile() function', async function () {
   /*
@@ -36,10 +38,13 @@ await mochaDescribe('loadTestFile() function', async function () {
   await mochaIt('should correctly load a file with describes without any its/tests', async function () {
     const config = defaultConfig;
     const sampleTestFile = 'unitTesting/sampleTests/describesWithoutTests.test.js';
-    const test = await loadTestFile(config, sampleTestFile); //console.log('ut test', test)
+    const test = await loadTestFile(config, sampleTestFile);
+
+    //console.log('ut test', test)
 
     await test.describes.length.should.equal(2);
     await (await test.describes.at(-1)).counter.should.equal(2);
-    await test.describes[0].tests.should.be.a('function'); //test.describes.at(-1).its.at(-1).counter.should.equal(2)
+    await test.describes[0].tests.should.be.a('function');
+    //test.describes.at(-1).its.at(-1).counter.should.equal(2)
   });
 });

package/dist/cli/lib/loadTestFileStatic.js

@@ -1,3 +1,4 @@
+
 /*
 
 I can't remember what this was for.

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

@@ -1,3 +1,4 @@
+
 /*
 import { loadTestFileStatic } from "./loadTestFileStatic.js"
 import { applyConfigDefaults } from './applyConfigDefaults.js'