Add date to report (#7)

* directory restructure
* add date to report using date utility
* WIP test date utils
* Fix date test

Author: scraggo

docs/templates.md

@@ -0,0 +1,5 @@
+# Templates
+
+These templates shouldn't be tested on their own. They're used to generate multiple tests in their respective directories, `ava`, `jest`, and `mocha`.
+
+Defining `require` paths to files in the templates should be relative to `<root>/test/<runner>` not necessarily relative to the templates directory.

package-lock.json

@@ -31,7 +31,8 @@
     "eslint-config-prettier": "^6.10.0",
     "eslint-plugin-import": "^2.20.0",
     "eslint-plugin-prettier": "^3.1.2",
-    "prettier": "1.19.1"
+    "prettier": "1.19.1",
+    "sinon": "^9.0.2"
   },
   "ava": {
     "verbose": true

package.json

@@ -14,4 +14,4 @@ const fullCircle = (self, wait) => {
   return self;
 };
 
-module.exports = { fullCircle };
+module.exports = { fullCircle, main: fullCircle };

src/fullCircle.js

@@ -5,7 +5,7 @@ const TEST_RUNNERS = [AVA, JEST, MOCHA];
 
 // relative to root
 const TEST_DIR = './test';
-const TEMPLATE_DIR = './src/generateTests/templates';
+const TEMPLATE_DIR = './test/templates';
 
 const getTemplatePath = testRunner => `${TEMPLATE_DIR}/${testRunner}.js`;
 const getDestPath = testRunner => `${TEST_DIR}/${testRunner}`;

src/generateTests/config.js

@@ -1,5 +1,6 @@
 const { promises: fsPromises } = require('fs');
-const { range } = require('../range');
+
+const { range } = require('../utils');
 const { TEMPLATE_PATHS, TEST_RUNNERS } = require('./config');
 
 const createTestFilename = (num, testDir, testRunner) =>

src/generateTests/generateTestFiles.js

@@ -1,12 +1,16 @@
 const execa = require('execa');
-const { shuffle } = require('./');
+
+const { getDateTime, shuffle } = require('./utils');
 
 // CONSTANTS
 
 const TEST_RUNNERS = ['ava', 'jest', 'mocha', 'parallel'];
 const DOTS = '. '.repeat(16);
 const testRunners = shuffle(TEST_RUNNERS);
 
+// just run one for now
+// const testRunners = shuffle(TEST_RUNNERS).slice(0, 1);
+
 // UTILS
 
 /**
@@ -66,6 +70,13 @@ const logTestTitle = name => {
   console.log('\n\n', DOTS, '\n   running tests for', name, '\n', DOTS, '\n\n');
 };
 
+const logResultsHeader = () => {
+  console.log(`\n${'-*'.repeat(20)}`);
+  console.log(`RESULTS ${getDateTime()}`);
+  console.log('order:', testRunners);
+  console.log('');
+};
+
 // sort, format, and log test results
 const logResults = resultsArr => {
   resultsArr
@@ -92,9 +103,6 @@ const testData = testRunners.reduce((acc, name) => {
   return acc;
 }, {});
 
-// just run one for now
-// const sliced = testRunners.slice(0, 1);
-
 const main = () => {
   try {
     const testResults = [];
@@ -109,10 +117,7 @@ const main = () => {
       testResults.push(testData[name]);
     }
 
-    console.log(`-*-*-*-*-*-*-*-*-*-*-
-      RESULTS
--*-*-*-*-*-*-*-*-*-*-\n`);
-    console.log('order:', testRunners, '\n');
+    logResultsHeader();
     logResults(testResults);
   } catch (error) {
     console.error(error);

src/runAllTests.js

@@ -0,0 +1,16 @@
+const options = {
+  weekday: 'long',
+  year: 'numeric',
+  month: 'long',
+  day: 'numeric',
+};
+
+const getDateTime = (inputDate = new Date()) => {
+  const date = inputDate.toLocaleDateString(undefined, options);
+  const time = `${inputDate.getHours()}:${inputDate.getMinutes()}:${inputDate.getSeconds()}`;
+  return `${date} ${time}`;
+};
+
+module.exports = {
+  getDateTime,
+};

src/utils/date.js

@@ -1,9 +1,9 @@
-const { fullCircle } = require('./fullCircle');
+const dateUtils = require('./date');
 const { range } = require('./range');
 const { shuffle } = require('./shuffle');
 
 module.exports = {
-  fullCircle,
+  ...dateUtils,
   range,
   shuffle,
 };