chore(): replace console statements with logger

Author: tlancina

lib/cli.js

@@ -14,7 +14,8 @@ var Cli = module.exports,
     settings = require('../package.json'),
     Tasks = require('./tasks/cliTasks'),
     Utils = IonicAppLib.utils,
-    logging = IonicAppLib.logging,
+    Logging = IonicAppLib.logging,
+    log = Logging.logger,
     Q = require('q'),
     semver = require('semver'),
     gutil = require('gulp-util'),
@@ -28,7 +29,7 @@ Cli.IONIC_API = '/api/v1/';
 Cli.PRIVATE_PATH = '.ionic';
 
 // This is where the logger for the app-lib can be configured (or replaced).
-logging.logger.level = 'info';
+log.level = 'info';
 
 
 // Cli.dev = function dev() {
@@ -52,7 +53,6 @@ Cli.run = function run(processArgv) {
     //execute, grab those options, and reparse the arguments.
     var argv = optimist(processArgv.slice(2)).argv;
 
-    Cli.setUpConsoleLoggingHelpers();
     Cli.attachErrorHandling();
     Cli.checkLatestVersion();
 
@@ -74,7 +74,7 @@ Cli.run = function run(processArgv) {
     }
 
     if (argv.verbose) {
-      logging.logger.level = 'debug';
+      log.level = 'debug';
     }
 
     if(argv.help || argv.h) {
@@ -84,7 +84,7 @@ Cli.run = function run(processArgv) {
     if(argv['stats-opt-out']) {
       IonicConfig.set('statsOptOut', true);
       IonicConfig.save();
-      logging.logger.info('Successful stats opt-out');
+      log.info('Successful stats opt-out');
       return;
     } else {
       IonicStats.t();
@@ -94,7 +94,7 @@ Cli.run = function run(processArgv) {
     if(!taskSetting) {
       return Cli.printAvailableTasks();
     }
-    logging.logger.debug('Task setting:', taskSetting);
+    log.debug('Task setting:', taskSetting);
     var booleanOptions = Cli.getBooleanOptionsForTask(taskSetting);
     argv = optimist(processArgv.slice(2)).boolean(booleanOptions).argv;
     var taskModule = Cli.lookupTask(taskSetting.module);
@@ -105,19 +105,18 @@ Cli.run = function run(processArgv) {
       var root = Utils.cdIonicRoot();
       var project = IonicProject.load(root);
       argv.v2 = project && project.get('v2');
-      argv.v2 && logging.logger.debug('Ionic 2 project.');
+      argv.v2 && log.debug('Ionic 2 project.');
 
       if (fs.existsSync('node_modules')) {
         //run with gulp hooks
         return runWithGulp(argv, taskInstance);
       } else if (argv.v2) {
-        console.warn('WARN: No node_modules directory found, do you need to run npm install?');
+        log.warn('WARN: No node_modules directory found, do you need to run npm install?');
       }
     }
     return Q.fcall(taskInstance.run.bind(taskInstance), Cli, argv);
 
   } catch (ex) {
-    logging.logger.debug('Cli.Run - Error', ex);
     return Utils.fail(ex);
   }
 };
@@ -128,20 +127,20 @@ function runWithGulp(argv, taskInstance){
   var afterHook = cmdName + ':after';
 
   if (loadGulpfile()) {
-    logging.logger.debug('Gulpfile found');
+    log.verbose('Gulpfile found');
 
     try {
       var gulp = require(path.resolve(process.cwd() + '/node_modules/gulp'));
     } catch(e) {
       // Empty gulpfile (or one that doesn't require gulp?), and no gulp
-      console.error('\nGulpfile detected, but gulp is not installed');
-      console.error('Do you need to run `npm install`?\n');
+      log.error('\nGulpfile detected, but gulp is not installed');
+      log.error('Do you need to run `npm install`?\n');
       process.exit(1);
     }
     logEvents(gulp, [beforeHook, afterHook]);
 
     if (gulp.tasks[beforeHook]) {
-      console.info('\nRunning \'' + beforeHook + '\' gulp task before ' + cmdName);
+      log.info('\nRunning \'' + beforeHook + '\' gulp task before ' + cmdName);
     }
     return Q.nfcall(gulp.start.bind(gulp), beforeHook).then(
       function(){
@@ -152,41 +151,41 @@ function runWithGulp(argv, taskInstance){
         //if there is no hook task, but it's a v2 app and a command that usually needs a hook
         if (e.missingTask && /serve|build|run|emulate|upload/.test(cmdName) && argv.v2) {
           var taskName = (cmdName === 'serve') ? 'watch' : 'build';
-          console.warn('WARN: No \'' + beforeHook + '\' gulp task found!');
+          log.warn('WARN: No \'' + beforeHook + '\' gulp task found!');
 
           //The task exists, but there are no hooks for it
           //They have the old config file, so we're safe to yell at them
           //With new config, may intentionally not have hooks if running their own build
           if (gulp.tasks[taskName] && fs.existsSync('ionic.config.js')) {
-            console.info('Your gulpfile contains a \'' + taskName + '\' task already! Add:\n')
-            console.log('    gulp.task(\'' + cmdName + ':before\', [\'' + taskName + '\']);\n');
-            console.info('to your gulpfile to have Ionic CLI run \'' + taskName + '\' before ' + cmdName + '.\n');
+            log.info('Your gulpfile contains a \'' + taskName + '\' task already! Add:\n')
+            log.info('    gulp.task(\'' + cmdName + ':before\', [\'' + taskName + '\']);\n');
+            log.info('to your gulpfile to have Ionic CLI run \'' + taskName + '\' before ' + cmdName + '.\n');
           } else {
-            console.warn('If your app requires a build step, you may want to ensure it runs before ' + cmdName + '.\n');
+            log.warn('If your app requires a build step, you may want to ensure it runs before ' + cmdName + '.\n');
           }
         }
         // Only some commands return promises, so wrap it
         return Q.fcall(taskInstance.run.bind(taskInstance), Cli, argv);
       }
     ).then(function(){
       if (gulp.tasks[afterHook]) {
-        console.info('\nRunning \'' + afterHook + '\' gulp task after ' + cmdName);
+        log.info('\nRunning \'' + afterHook + '\' gulp task after ' + cmdName);
       }
       return Q.nfcall(gulp.start.bind(gulp), afterHook);
     });
   }
 
   //No gulpfile
   if (/serve|build|run|emulate|upload/.test(cmdName) && argv.v2) {
-    console.warn('WARN: No gulpfile found!');
-    console.warn('If your app requires a build step, you may want to ensure it runs before ' + cmdName + '.\n');
+    log.warn('WARN: No gulpfile found!');
+    log.warn('If your app requires a build step, you may want to ensure it runs before ' + cmdName + '.\n');
 
     if (fs.existsSync('ionic.config.js')) {
       var inquirer = require('inquirer');
       var deferred = Q.defer();
 
-      console.info('Looks like you are using the deprecated ionic.config.js and have no gulpfile!');
-      console.info('As of beta.21 the Ionic CLI relies on gulp hooks to build your web assets\n');
+      log.info('Looks like you are using the deprecated ionic.config.js and have no gulpfile!');
+      log.info('As of beta.21 the Ionic CLI relies on gulp hooks to build your web assets\n');
       inquirer.prompt([{
         type: 'confirm',
         name: 'downloadGulp',
@@ -202,17 +201,17 @@ function runWithGulp(argv, taskInstance){
           return downloadDefaultGulpfile(cmdName).then(
             installGulpfilePackages,
             function(err) {
-              console.error('There was an error downloading the default gulpfile: ' + err);
+              log.error('There was an error downloading the default gulpfile: ' + err);
               process.exit(1);
             }
           ).then(
             function(){
-              console.success('Npm packages installed successfully. Try running \'' + cmdName + '\' again.');
+              log.info('Npm packages installed successfully. Try running \'' + cmdName + '\' again.');
             },
             function(){
-              console.warn('There was an error installing the packages required by the gulpfile.');
-              console.warn('You\'ll need to install the following packages manually: ');
-              console.warn('    ' + requires.join(' '));
+              log.warn('There was an error installing the packages required by the gulpfile.');
+              log.warn('You\'ll need to install the following packages manually: ');
+              log.warn('    ' + requires.join(' '));
             }
           );
         },
@@ -236,17 +235,17 @@ function loadGulpfile(){
     } catch(e){
       if (e.code === 'MODULE_NOT_FOUND') {
         if (e.message.indexOf(names[i]) === -1) {
-          console.log('Uh oh! Looks like you\'re missing a module in your gulpfile:');
-          console.error(e.message);
-          console.log('\nDo you need to run `npm install`?\n');
+          log.info('Uh oh! Looks like you\'re missing a module in your gulpfile:');
+          log.error(e.message);
+          log.info('\nDo you need to run `npm install`?\n');
           process.exit(1);
         } else {
           // ignore missing gulpfile
           continue
         }
       }
-      console.error('There is an error in your gulpfile: ')
-      console.error(e.stack);
+      log.error('There is an error in your gulpfile: ')
+      log.error(e.stack);
       process.exit(1);
     }
   }
@@ -261,7 +260,7 @@ function downloadDefaultGulpfile(){
   var branch = project.get('typescript') ? 'typescript' : 'master';
   var url = 'https://raw.githubusercontent.com/driftyco/ionic2-app-base/' + branch + '/gulpfile.js';
 
-  console.info('\nDownloading default gulpfile from: ' + url);
+  log.info('\nDownloading default gulpfile from: ' + url);
 
   fileStream.on('open', function () {
     https.get(url, function (res) {
@@ -285,14 +284,16 @@ function installGulpfilePackages(cmdName){
   var requires = detective(fs.readFileSync('gulpfile.js'));
   var deferred = Q.defer();
 
-  console.success('Successfully downloaded gulpfile.\n');
-  console.info('Now installing npm packages used by the gulpfile: ');
-  console.info('    ' + requires.join(' ') + '\n');
+  log.info('Successfully downloaded gulpfile.\n'.green);
+  log.info('Now installing npm packages used by the gulpfile: ');
+  log.info('    ' + requires.join(' ') + '\n');
 
   var npmInstall = require('child_process').spawn('npm', ['install', '--save-dev'].concat(requires));
-  npmInstall.stdout.on('data', function(data){ logging.logger.debug(data) });
-  npmInstall.stderr.on('data', function(data){ logging.logger.debug(data) });
-  npmInstall.on('error', function(err) { console.error(err) });
+  npmInstall.stdout.on('data', function(data){ log.debug(data) });
+  npmInstall.stderr.on('data', function(data){ log.debug(data) });
+  npmInstall.on('error', function(err) {
+    log.error('Error in gulp npm install: ' + err.stack);
+  });
   npmInstall.on('exit', function(code) {
     code !== 0 ? deferred.reject() : deferred.resolve();
   });
@@ -315,7 +316,7 @@ function logEvents(gulpInst, finalTaskNames) {
       'after', time.magenta
     );
     if (finalTaskNames.indexOf(e.task) > -1) {
-      console.log();
+      log.info();
     }
   });
 
@@ -380,64 +381,6 @@ Cli.getBooleanOptionsForTask = function getBooleanOptionsForTask(task) {
   return booleanOptions;
 };
 
-Cli.setUpConsoleLoggingHelpers = function setUpConsoleLoggingHelpers() {
-  colors.setTheme({
-    silly: 'rainbow',
-    input: 'grey',
-    small: 'grey',
-    verbose: 'cyan',
-    prompt: ['yellow', 'bold'],
-    info: 'white',
-    data: 'grey',
-    help: 'cyan',
-    warn: 'yellow',
-    debug: 'blue',
-    error: 'red'
-  });
-
-  var consoleInfo = console.info;
-  console.info = function() {
-    if (arguments.length === 1 && !arguments[0]) return;
-    var msg = '';
-    for (var n in arguments) {
-      msg += arguments[n] + ' ';
-    }
-    consoleInfo.call(console, msg.cyan.bold);
-  };
-
-  var consoleWarn = console.warn;
-  console.warn = function() {
-    if (arguments.length === 1 && !arguments[0]) return;
-    var msg = '';
-    for (var n in arguments) {
-      msg += arguments[n] + ' ';
-    }
-    consoleWarn.call(console, msg.yellow.bold);
-  };
-
-  var consoleError = console.error;
-  console.error = function() {
-    if (arguments.length === 1 && !arguments[0]) return;
-    var msg = ' ✗';
-    for (var n in arguments) {
-      msg += ' ' + arguments[n];
-    }
-    consoleError.call(console, msg.red.bold);
-  };
-
-  console.success = function() {
-    if (arguments.length === 1 && !arguments[0]) return;
-    var msg = ' ✓';
-    for (var n in arguments) {
-      msg += ' ' + arguments[n];
-    }
-    console.log(msg.green.bold);
-  };
-
-  //Default level is set to 'info'
-  IonicAppLib.logging.createDefaultLogger();
-};
-
 Cli.lookupTask = function lookupTask(module) {
   try {
     var taskModule = require(module).IonicTask;
@@ -694,7 +637,7 @@ Cli.processExit = function processExit(code) {
 };
 
 Cli.version = function version() {
-  console.log(settings.version + '\n');
+  log.info(settings.version + '\n');
 };
 
 Cli.printNewsUpdates = function printNewsUpdates(skipNewsCheck) {
@@ -736,11 +679,8 @@ Cli.printNewsUpdates = function printNewsUpdates(skipNewsCheck) {
         }
         process.stdout.write('+---------------------------------------------------------+\n'.green);
       } catch(ex) {
-        console.log('ex', ex.stack);
         q.reject('Error occurred in downloading the CLI messages:', ex)
         Utils.fail(ex);
-        q.reject(ex);
-        return
       }
       q.resolve(messagesJson);
     } else {
@@ -780,17 +720,17 @@ Cli.handleUncaughtExceptions = function handleUncaughtExceptions(err, url) {
 Cli.attachErrorHandling = function attachErrorHandling() {
   Utils.errorHandler = function errorHandler(msg, taskHelp) {
     try {
-      logging.logger.debug('Cli.Utils.errorHandler msg', msg, typeof msg);
+      log.debug('Cli.Utils.errorHandler msg', msg, typeof msg);
       var stack = typeof msg == 'string' ? '' : msg.stack;
       var errorMessage = typeof msg == 'string' ? msg : msg.message;
       if (msg) {
         var info = Cli.gatherInfo();
         var ionicCliVersion = info.ionic_cli;
         if (stack && stack.length > 0) {
-          process.stderr.write('\n' + stack.error.bold + '\n\n');
+          process.stderr.write('\n' + stack.bold + '\n\n');
         }
-        process.stderr.write('\n' + errorMessage.error.bold);
-        process.stderr.write( (' (CLI v' + ionicCliVersion + ')').error.bold + '\n');
+        process.stderr.write('\n' + errorMessage.bold);
+        process.stderr.write( (' (CLI v' + ionicCliVersion + ')').bold + '\n');
 
         Info.printInfo(info);
       }
@@ -828,7 +768,7 @@ Cli.doRuntimeCheck = function doRuntimeCheck(version) {
   try {
     versionHasBeenChecked = semver.satisfies(version, lastVersionChecked);
   } catch (ex) {
-    console.log(ex);
+    log.info(ex);
   }
 
   if (!lastVersionChecked || !versionHasBeenChecked) {