improved error handling & messages

Author: ShMcK

.npmignore

@@ -2,3 +2,4 @@ src
 tsconfig.json
 tsd.json
 tslint.json
+.gitattributes

lib/reducers/task-tests/concat-tests.js

@@ -4,14 +4,9 @@ function concatTests(targetFile, files) {
     if (fs.existsSync(targetFile)) {
         fs.unlink(targetFile);
     }
-    files.forEach(function (tests) {
-        if (typeof tests === 'string') {
-            readAppend(targetFile, tests);
-        }
-        else if (Object.prototype.toString.call(tests) === '[object Array]') {
-            tests.forEach(function (test) {
-                readAppend(targetFile, test);
-            });
+    files.forEach(function (test) {
+        if (typeof test === 'string') {
+            readAppend(targetFile, test);
         }
     });
     return targetFile;

lib/services/package.js

@@ -46,7 +46,7 @@ var PackageService = (function () {
             if (task.tests) {
                 task.tests = task.tests.map(function (tests) {
                     if (_.isString(tests)) {
-                        return [].concat(configTestString(config, _this.packageName, tests));
+                        return configTestString(config, _this.packageName, tests);
                     }
                     else {
                         console.error('Invalid task test', tests);

lib/services/setGlobals.js

@@ -30,6 +30,8 @@ function loadRunnerDep(config) {
         console.log(message);
         throw message;
     }
+    var slash = navigator.appVersion.indexOf('Win') !== -1 ? '\\' : '/';
+    runnerMain = path.join.apply(null, runnerMain.split(slash));
     runnerRoot = runnerRoot.substring(0, runnerRoot.lastIndexOf('/'));
     var pathToMain = path.join(runnerRoot, runnerMain);
     if (!!require(pathToMain).default) {

src/reducers/alert/alert.ts

@@ -26,33 +26,30 @@ export default function alertReducer(alert = defaultAlert, action: CR.Action): C
       if (result.pass && result.change > 0) {
         // Pass
         statusBarAlert.style.color = '#73C990';
-        current = {
+        return {
           message: result.msg,
           open: true,
           action: 'pass',
           duration: result.duration || 1500
         };
-        return current;
       } else if (result.pass === false && result.change < 1) {
         // Fail
         statusBarAlert.style.color = '#FF4081';
-        current = {
+        return {
           message: result.msg,
           open: true,
           action: 'fail',
           duration: result.duration || 2500
         };
-        return current;
       }
       // Alert
       statusBarAlert.style.color = '#9DA5B4';
-      current = {
+      return {
         message: result.msg,
         open: true,
         action: 'note',
         duration: result.duration || 2500
       };
-      return current;
     case Type.PAGE_COMPLETE:
       return {
         message: `Page ${action.payload.position.page + 1} Complete`,

src/reducers/task-tests/concat-tests.ts

@@ -7,25 +7,15 @@ export function concatTests(targetFile: string, files: any): string {
   }
 
   // load tests in order
-  files.forEach(function(tests) {
-    // path to file
-    if (typeof tests === 'string') {
-      readAppend(targetFile, tests);
-
-      // array of paths to file
-    } else if (Object.prototype.toString.call(tests) === '[object Array]') {
-      tests.forEach(function(test) {
-        readAppend(targetFile, test);
-      });
-    }
-  });
+  files.forEach((test: string) => readAppend(targetFile, test));
   return targetFile;
 }
 
 function readAppend(targetFile: string, file: string): void {
   try {
     let data = fs.readFileSync(file, 'utf8');
     fs.appendFileSync(targetFile, data, 'utf8');
+    return;
   } catch (e) {
     console.log('Error reading test file', e);
   }

src/services/package.ts

@@ -45,11 +45,12 @@ class PackageService {
     let config = this.config.config;
     return !tasks ? [] : tasks.map((task: CR.Task) => {
       if (task.tests) {
-        task.tests = task.tests.map((tests: string) => {
-          if (_.isString(tests)) {
-            return [].concat(configTestString(config, this.packageName, tests));
+        task.tests = task.tests.map((test: string) => {
+          // add unique string to tests
+          if (_.isString(test) && task.tests.indexOf(test) === -1) {
+            return configTestString(config, this.packageName, test);
           } else {
-            console.error('Invalid task test', tests);
+            console.error('Invalid task test', test);
           }
         });
       }

src/services/setup-checks.ts

@@ -9,7 +9,6 @@ export function verifySetupComplete() {
   hasDirectory()
   .then(hasPackageJson)
   .then(hasTutorialDep)
-  .then(hasTestRunner)
   .then(() => {
     store.dispatch(Action.setupWarning(null));
     store.dispatch(Action.loadTutorials());
@@ -73,23 +72,6 @@ function hasTutorialDep(): Promise<CR.SetupWarning> {
   });
 }
 
-// 4
-function hasTestRunner(): Promise<CR.SetupWarning> {
-  return new Promise((resolve, reject) => {
-    const hasTestRunner = true;
-    if (!hasTestRunner) {
-      reject({
-        key: 'noTestRunner',
-        title: 'Error with Tutorial',
-        click: null,
-        text: 'no test runner found'
-      });
-    }
-    resolve();
-  });
-}
-
-
 function _hasKeys(obj: Object): boolean {
   return Object.keys(obj).length > 0;
 }

src/services/tutorials.ts

@@ -3,6 +3,8 @@ import * as path from 'path';
 import * as fs from 'fs';
 import {fileExists} from '../services/exists';
 
+let tutorialError = 'This is an error with the tutorial itself';
+
 export function packageJsonExists(): boolean {
   const pathToPackageJson = path.join(window.coderoad.dir, 'package.json');
   return fileExists(pathToPackageJson);
@@ -17,18 +19,34 @@ export function loadRootPackageJson(): PackageJson {
 }
 
 function _isTutorial(name: string): boolean {
+  // has package.json
   let pathToTutorialPackageJson = path.join(window.coderoad.dir, 'node_modules', name, 'package.json');
-  if (fileExists(pathToTutorialPackageJson)) {
-    // has package.json
-    let packageJson = JSON.parse(fs.readFileSync(pathToTutorialPackageJson, 'utf8'));
-    // main path to coderoad.json
-    if (packageJson.main && packageJson.main.match(/coderoad.json$/)) {
-      let pathToCoderoadJson = path.join(window.coderoad.dir, 'node_modules', name, packageJson.main);
-      // coderoad.json file exists
-      return fileExists(pathToCoderoadJson);
-    }
+  if (!fileExists(pathToTutorialPackageJson)) {
+    console.log(`Error with ${name}: no package.json file found. ${tutorialError}`);
+    return false;
+  }
+  // main path to coderoad.json
+  let packageJson = JSON.parse(fs.readFileSync(pathToTutorialPackageJson, 'utf8'));
+  if (!packageJson.main && packageJson.main.match(/coderoad.json$/)) {
+    console.log(`Error with ${name}: main does not load a coderoad.json file. ${tutorialError}`);
+    return false;
+  }
+  // coderoad.json file exists
+  let pathToCoderoadJson = path.join(window.coderoad.dir, 'node_modules', name, packageJson.main);
+  if (!fileExists(pathToCoderoadJson)) {
+    console.log(`Error with ${name}: no coderoad.json file. ${tutorialError}`);
+    return false;
+  };
+  if (!packageJson.config || !packageJson.config.testRunner) {
+    console.log(`Error with ${name}: no test runner specified. ${tutorialError}`);
+    return false;
+  }
+  let pathToTestRunner = path.join(window.coderoad.dir, 'node_modules', packageJson.config.testRunner);
+  if (!fileExists(pathToTestRunner)) {
+    console.log(`Error with ${name}: ${packageJson.config.testRunner} test runner not installed`);
+    return false;
   }
-  return false;
+  return true;
 }
 
 export function searchForTutorials(deps: Object): string[] {