feat(logs): Refactor logs for pattern_engines

Author: bmuenzenmeyer

core/lib/pattern_engines.js

@@ -6,6 +6,7 @@ const chalk = require('chalk');
 const engineMatcher = /^patternengine-node-(.*)$/;
 const scopeMatch = /^@(.*)$/;
 const isDir = fPath => lstatSync(fPath).isDirectory();
+const logger = require('./log');
 
 const enginesDirectories = [{
   displayName: 'the core',
@@ -20,7 +21,7 @@ const enginesDirectories = [{
 function isEngineModule(filePath) {
   const baseName = path.basename(filePath);
   const engineMatch = baseName.match(engineMatcher);
-  
+
   if (engineMatch) { return engineMatch[1]; }
   return false;
 }
@@ -43,12 +44,12 @@ function isScopedPackage(filePath) {
  * @return {Array<Engine>} An array of engine objects
  */
 function resolveEngines(dir) {
-  
+
   // Guard against non-existent directories.
   if (!existsSync(dir)) {
     return []; // Silence is golden …
   }
-  
+
   /**
    * @name walk
    * @desc Traverse the given path and gather possible engines
@@ -57,14 +58,14 @@ function resolveEngines(dir) {
    * @return {Array<Engine>} - The final array of engines
    */
   const walk = (fPath, engines) => {
-  
+
     /**
      * @name dirList
      * @desc A list of all directories in the given path
      * @type {Array<string>}
      */
     const dirList = readdirSync(fPath).filter(p => isDir(path.join(fPath, p)));
-  
+
     /**
      * @name e
      * @desc For the current dir get all engines
@@ -79,7 +80,7 @@ function resolveEngines(dir) {
         }
       })
     );
-    
+
     /**
      * 1. Flatten all engines from inner recursions and current dir
      * 2. Filter the dirList for scoped packages
@@ -92,7 +93,7 @@ function resolveEngines(dir) {
         .map(scope => walk(path.join(fPath, scope), e)) // 3
     );
   };
-  
+
   return walk(dir, []);
 }
 
@@ -117,27 +118,23 @@ function findEngineModulesInDirectory(dir) {
 // methods and properites below should therefore be on its prototype.
 
 const PatternEngines = Object.create({
-  
+
   loadAllEngines: function (patternLabConfig) {
     var self = this;
-    
+
     // Try to load engines! We scan for engines at each path specified above. This
     // function is kind of a big deal.
     enginesDirectories.forEach(function (engineDirectory) {
       const enginesInThisDir = findEngineModulesInDirectory(engineDirectory.path);
-      if (patternLabConfig.debug) {
-        console.log(chalk.bold(`Loading engines from ${engineDirectory.displayName}...\n`));
-      }
-  
+
+      logger.debug(`Loading engines from ${engineDirectory.displayName}...\n`);
+
       // find all engine-named things in this directory and try to load them,
       // unless it's already been loaded.
       enginesInThisDir.forEach(function (engineDiscovery) {
         let errorMessage;
         const successMessage = "good to go";
-        if (patternLabConfig.debug) {
-          chalk.green(successMessage);
-        }
-  
+
         try {
           // Give it a try! load 'er up. But not if we already have,
           // of course.  Also pass the pattern lab config object into
@@ -157,23 +154,18 @@ const PatternEngines = Object.create({
           errorMessage = err.message;
         } finally {
           // report on the status of the engine, one way or another!
-          if (patternLabConfig.debug) {
-            console.log(`  ${engineDiscovery.name}:`, errorMessage ? chalk.red(errorMessage) : successMessage);
-          }
+          logger.info(`Pattern Engine ${engineDiscovery.name}: ${errorMessage ? errorMessage : successMessage}`);
         }
       });
-      console.log('');
     });
-    
+
     // Complain if for some reason we haven't loaded any engines.
     if (Object.keys(self).length === 0) {
-      throw new Error('No engines loaded! Something is seriously wrong.');
-    }
-    if (patternLabConfig.debug) {
-      console.log(chalk.bold('Done loading engines.\n'));
+      logger.error('No engines loaded! Something is seriously wrong.');
     }
+    logger.debug(`Done loading engines`);
   },
-  
+
   getEngineNameForPattern: function (pattern) {
     // avoid circular dependency by putting this in here. TODO: is this slow?
     const of = require('./object_factory');
@@ -182,7 +174,7 @@ const PatternEngines = Object.create({
       const engineNames = Object.keys(this);
       for (let i = 0; i < engineNames.length; i++) {
         const engine = this[engineNames[i]];
-  
+
         if (Array.isArray(engine.engineFileExtension)) {
           if (engine.engineFileExtension.includes(pattern.fileExtension)) {
             return engine.engineName;
@@ -195,12 +187,12 @@ const PatternEngines = Object.create({
         }
       }
     }
-    
+
     // otherwise, assume it's a plain mustache template string and act
     // accordingly
     return 'mustache';
   },
-  
+
   getEngineForPattern: function (pattern) {
     if (pattern.isPseudoPattern) {
       return this.getEngineForPattern(pattern.basePattern);
@@ -209,7 +201,7 @@ const PatternEngines = Object.create({
       return this[engineName];
     }
   },
-  
+
   // combine all found engines into a single array of supported extensions
   getSupportedFileExtensions: function () {
     const engineNames = Object.keys(PatternEngines);
@@ -218,19 +210,19 @@ const PatternEngines = Object.create({
     });
     return [].concat.apply([], allEnginesExtensions);
   },
-  
+
   isFileExtensionSupported: function (fileExtension) {
     const supportedExtensions = PatternEngines.getSupportedFileExtensions();
     return (supportedExtensions.lastIndexOf(fileExtension) !== -1);
   },
-  
+
   // given a filename, return a boolean: whether or not the filename indicates
   // that the file is pseudopattern JSON
   isPseudoPatternJSON: function (filename) {
     const extension = path.extname(filename);
     return (extension === '.json' && filename.indexOf('~') > -1);
   },
-  
+
   // takes a filename string, not a full path; a basename (plus extension)
   // ignore _underscored patterns, dotfiles, and anything not recognized by a
   // loaded pattern engine. Pseudo-pattern .json files ARE considered to be
@@ -242,7 +234,7 @@ const PatternEngines = Object.create({
       (extension === '.json' && !PatternEngines.isPseudoPatternJSON(filename))) {
       return false;
     }
-  
+
     // not a hidden pattern, let's dig deeper
     const supportedPatternFileExtensions = PatternEngines.getSupportedFileExtensions();
     return (supportedPatternFileExtensions.lastIndexOf(extension) !== -1 ||