improved comments, async version of writeFile

Author: ShMcK

lib/write-test.js

@@ -4,8 +4,15 @@ var process_console_log_1 = require('process-console-log');
 var exists_1 = require('./exists');
 var constants_1 = require('./constants');
 function writeTest(config, testString) {
-    var output = process_console_log_1.logger + exists_1.default(config.dir) + testString;
-    fs_1.writeFileSync(constants_1.testPath, output, 'utf8');
+    return new Promise(function (resolve, reject) {
+        var output = process_console_log_1.logger + exists_1.default(config.dir) + testString;
+        fs_1.writeFile(constants_1.testPath, output, function (err) {
+            if (err) {
+                reject(err);
+            }
+            resolve();
+        });
+    });
 }
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = writeTest;

src/constants.ts

@@ -1,4 +1,9 @@
 import {join} from 'path';
 
+// test results are taken after this signal
+// this helps to avoid parsing console.logs before the output
 export const signal = '@@@CodeRoad Results@@@';
+
+// location for a temporary test file
+// which combines user code with helper functions
 export const testPath = join(__dirname, '.tmp.js');

src/exists.ts

@@ -1,4 +1,3 @@
-
 // checks if file exists from cwd
 // appends this function to the top of the tests
 // require('node-file-exists')(require('path').;

src/index.ts

@@ -10,6 +10,9 @@ export default function runner({testString, config, handleResult}) {
   const runner = runnerProcess(config);
 
   var final = null;
+
+  // take code after the signal to avoid confusing console.log statements
+  // with test output
   const signalMatch = new RegExp(signal);
 
   return new Promise(function run(resolve, reject) {

src/write-test.ts

@@ -1,12 +1,16 @@
-import {writeFileSync} from 'fs';
+import {writeFile} from 'fs';
 import {logger} from 'process-console-log';
 import exists from './exists';
 import {testPath} from './constants';
 
 export default function writeTest(config, testString: string) {
-
-  // append logger
-  const output = logger + exists(config.dir) + testString;
-  // write test file
-  writeFileSync(testPath, output, 'utf8');
+  return new Promise((resolve, reject) => {
+		// append logger
+    const output = logger + exists(config.dir) + testString;
+		// write test file
+    writeFile(testPath, output, (err) => {
+      if (err) { reject(err); }
+      resolve();
+    });
+  });
 }