chore(): replace colors module with chalk and update all usages. (#1605)

Author: jthoms1

.eslintrc.js

@@ -3,8 +3,12 @@ module.exports = {
     node: true,
     commonjs: true
   },
+  plugins: [
+    'no-use-extend-native'
+  ],
   extends: 'eslint:recommended',
   rules: {
+    'no-use-extend-native/no-use-extend-native': 2,
     eqeqeq: [
       "error",
       "smart"

lib/cli.js

@@ -1,5 +1,3 @@
-require('colors');
-
 var Cli = {};
 var IonicAppLib = require('ionic-app-lib');
 var IonicStats = require('./utils/stats');
@@ -19,6 +17,7 @@ var log = Logging.logger;
 var Q = require('q');
 var helpUtil = require('./utils/help');
 var EOL = require('os').EOL;
+var chalk = require('chalk');
 
 Cli.ALL_TASKS = Tasks;
 Cli.IONIC_DASH = 'https://apps.ionic.io';
@@ -154,7 +153,7 @@ Cli.run = function run(processArgv) {
     // For v2, print a warning as this is most likely not what they want
     if (!fs.existsSync('node_modules')) {
       if (argv.v2) {
-        log.warn('WARN: No node_modules directory found, do you need to run npm install?'.yellow);
+        log.warn(chalk.yellow('WARN: No node_modules directory found, do you need to run npm install?'));
       }
       log.debug('node_modules directory not found, not running gulp hooks');
 
@@ -173,7 +172,7 @@ Cli.run = function run(processArgv) {
         log.info('\nDo you need to run `npm install`?\n');
         process.exit(1);
       }
-      log.error('\nThere is an error in your gulpfile: '.red);
+      log.error(chalk.red('\nThere is an error in your gulpfile: '));
       log.error(e.stack + '\n');
       process.exit(1);
     }
@@ -188,6 +187,7 @@ Cli.run = function run(processArgv) {
     }
 
     if (!gulpLoaded) {
+
       // warn if no build file and it's a command that requires a build step
       // but still run the command with no hooks
       if (Cli.isBuildCommand(taskName) && argv.v2 && !npmScripts) {
@@ -216,8 +216,8 @@ Cli.runWithGulp = function runWithGulp(argv, taskInstance, rawCliArguments) {
   } catch (e) {
 
     // Empty gulpfile (or one that doesn't require gulp?), and no gulp
-    log.error('\nGulpfile detected, but gulp is not installed'.red);
-    log.error('Do you need to run `npm install`?\n'.red);
+    log.error(chalk.red('\nGulpfile detected, but gulp is not installed'));
+    log.error(chalk.red('Do you need to run `npm install`?\n'));
     return process.exit(1);
   }
 
@@ -231,9 +231,9 @@ Cli.runWithGulp = function runWithGulp(argv, taskInstance, rawCliArguments) {
     beforeHookPromise = Cli.runGulpHook(gulp, beforeHook);
 
   } else if (Cli.isBuildCommand(cmdName) && argv.v2) {
-    log.warn(('WARN: No \'' + beforeHook + '\' gulp task found!').yellow);
-    log.warn(('If your app requires a build step, you may want to ensure it runs before ' +
-              cmdName + '.\n').yellow);
+    log.warn(chalk.yellow('WARN: No \'' + beforeHook + '\' gulp task found!'));
+    log.warn(chalk.yellow('If your app requires a build step, you may want to ensure it runs before ' +
+              cmdName + '.\n'));
   }
 
   // run beforeHook
@@ -333,7 +333,7 @@ Cli.runNpmHook = function runNpmHook(hook) {
   spawned.stdout.pipe(process.stdout);
   spawned.stdout.on('data', function(data) {
     var dataLines = data.toString().split(EOL);
-    for (var i = 0; i < dataLines.length; i++) {
+    for (var i = 0; i < dataLines.length; i += 1) {
       if (dataLines[i].length) {
         if (dataLines[i].indexOf('watch ready') > -1) {
           return q.resolve();
@@ -348,7 +348,7 @@ Cli.runNpmHook = function runNpmHook(hook) {
     }
     return q.resolve();
   });
-  
+
   // If this process ends ensure that we killed the spawned child
   process.on('exit', function() {
     spawned.kill();
@@ -367,8 +367,6 @@ Cli.loadNpmScripts = function loadNpmScripts() {
   } catch (e) {
     throw e;
   }
-
-  return undefined;
 };
 
 Cli.logEvents = function logEvents(gulpInst, finalTaskNames) {
@@ -379,14 +377,14 @@ Cli.logEvents = function logEvents(gulpInst, finalTaskNames) {
 
     // TODO: batch these
     // so when 5 tasks start at once it only logs one time with all 5
-    gutil.log('Starting', '\'' + e.task.cyan + '\'...');
+    gutil.log('Starting', '\'' + chalk.cyan(e.task) + '\'...');
   });
 
   gulpInst.on('task_stop', function(e) {
     var time = prettyTime(e.hrDuration);
     gutil.log(
-      'Finished', '\'' + e.task.cyan + '\'',
-      'after', time.magenta
+      'Finished', '\'' + chalk.cyan(e.task) + '\'',
+      'after', chalk.magenta(time)
     );
     if (finalTaskNames.indexOf(e.task) > -1) {
       log.info();
@@ -397,20 +395,12 @@ Cli.logEvents = function logEvents(gulpInst, finalTaskNames) {
     var msg = Cli.formatGulpError(e);
     var time = prettyTime(e.hrDuration);
     gutil.log(
-      '\'' + e.task.cyan + '\'',
-      'errored after'.red,
-      time.magenta
+      '\'' + chalk.cyan(e.task) + '\'',
+      chalk.red('errored after'),
+      chalk.magenta(time)
     );
     gutil.log(msg);
   });
-
-  // gulpInst.on('task_not_found', function(err) {
-  //   gutil.log(
-  //     ('Task \'' + err.task + '\' is not in your gulpfile').red
-  //   );
-  //   gutil.log('Please check the documentation for proper gulpfile formatting');
-  //   process.exit(1);
-  // });
 };
 
 // Format orchestrator errors
@@ -472,13 +462,13 @@ Cli.printVersionWarning = function printVersionWarning(version, npmVersion) {
   }
 
   if (npmVersion && npmVersion !== version.trim()) {
-    log.warn('\n------------------------------------\n'.red);
-    log.warn('Ionic CLI is out of date:\n'.bold.yellow);
-    log.warn((' * Locally installed version: ' + version + '\n').yellow);
-    log.warn((' * Latest version: ' + npmVersion + '\n').yellow);
-    log.warn((' * https://github.com/driftyco/ionic-cli/blob/master/CHANGELOG.md\n').yellow);
-    log.warn(' * Run '.yellow + 'npm install -g ionic'.bold + ' to update\n'.yellow);
-    log.warn('------------------------------------\n\n'.red);
+    log.warn(chalk.red('\n------------------------------------\n'));
+    log.warn(chalk.yellow.bold('Ionic CLI is out of date:\n'));
+    log.warn(chalk.yellow(' * Locally installed version: ' + version + '\n'));
+    log.warn(chalk.yellow(' * Latest version: ' + npmVersion + '\n'));
+    log.warn(chalk.yellow(' * https://github.com/driftyco/ionic-cli/blob/master/CHANGELOG.md\n'));
+    log.warn(chalk.yellow(' * Run ') + chalk.bold('npm install -g ionic') + chalk.yellow(' to update\n'));
+    log.warn(chalk.red('------------------------------------\n\n'));
   }
 };
 
@@ -614,10 +604,10 @@ Cli.printNewsUpdates = function printNewsUpdates(skipNewsCheck) {
 
         for (var i = 0, j = messagesJson.list.length; i < j; i += 1) {
           var entry = messagesJson.list[i];
-          var entryMessage = ['+ ', entry.name, '\n', '+ ', entry.action.blue.bold, '\n+\n'].join('');
+          var entryMessage = ['+ ', entry.name, '\n', '+ ', chalk.blue.bold(entry.action), '\n+\n'].join('');
           log.info(entryMessage);
         }
-        log.info('+---------------------------------------------------------+\n'.green);
+        log.info(chalk.green('+---------------------------------------------------------+\n'));
       } catch (ex) {
         q.reject('Error occurred in downloading the CLI messages:', ex);
         appLibUtils.fail(ex);
@@ -639,7 +629,7 @@ Cli.gatherInfo = function gatherInfo() {
 };
 
 Cli.handleUncaughtExceptions = function handleUncaughtExceptions(err) {
-  log.error('An uncaught exception occurred and has been reported to Ionic'.red.bold);
+  log.error(chalk.red.bold('An uncaught exception occurred and has been reported to Ionic'));
   var errorMessage = typeof err === 'string' ? err : err.message;
   appLibUtils.errorHandler(errorMessage);
   process.exit(1);
@@ -655,10 +645,10 @@ Cli.attachErrorHandling = function attachErrorHandling() {
         var info = Cli.gatherInfo();
         var ionicCliVersion = info.ionic_cli;
         if (stack && stack.length > 0) {
-          process.stderr.write('\n' + stack.bold + '\n\n');
+          process.stderr.write('\n' + chalk.bold(stack) + '\n\n');
         }
-        process.stderr.write('\n' + errorMessage.bold);
-        process.stderr.write((' (CLI v' + ionicCliVersion + ')').bold + '\n');
+        process.stderr.write('\n' + chalk.bold(errorMessage));
+        process.stderr.write(chalk.bold(' (CLI v' + ionicCliVersion + ')') + '\n');
 
         Info.printInfo(info);
       }

lib/ionic/add.js

@@ -1,7 +1,6 @@
 'use strict';
 
-require('colors');
-
+var chalk = require('chalk');
 var extend = require('../utils/extend');
 var childProcess = require('child_process');
 var IonicAppLib = require('ionic-app-lib');
@@ -31,8 +30,8 @@ function installBowerComponent(componentName) {
   } catch (e) {} // eslint-disable-line no-empty
 
   // Error happened, report it.
-  var errorMessage = 'Bower error, check that "'.red.bold + componentName + '"'.red.bold +
-    ' exists,'.red.bold + '\nor try running "'.red.bold + bowerInstallCommand + '" for more info.'.red.bold;
+  var errorMessage = chalk.red.bold('Bower error, check that "') + componentName + 
+    chalk.red.bold('" exists,\nor try running "') + bowerInstallCommand + chalk.red.bold('" for more info.');
   appLibUtils.fail(errorMessage, 'add');
 }
 
@@ -45,10 +44,10 @@ function installBowerComponent(componentName) {
 function run(ionic, argv) {
 
   // This command will be deprecated in the future.
-  var deprecationMsg = 'This command has been ' + 'deprecated'.red + '.  All ' +
+  var deprecationMsg = 'This command has been ' + chalk.red('deprecated') + '.  All ' +
    'resources are currently available in NPM and we recommend that you use NPM to manage these.\n' +
    'More information is available here: https://github.com/driftyco/ionic-cli/wiki/Migrating-to-NPM-from-bower\n';
-  log.info(deprecationMsg.bold);
+  log.info(chalk.bold(deprecationMsg));
 
   if (!bower.checkForBower()) {
     appLibUtils.fail(bower.installMessage, 'add');

lib/ionic/config.js

@@ -1,5 +1,6 @@
 'use strict';
 
+var chalk = require('chalk');
 var extend = require('../utils/extend');
 var IonicAppLib = require('ionic-app-lib');
 var ioLib = IonicAppLib.ioConfig;
@@ -11,7 +12,8 @@ var settings = {
   name: 'config',
   summary: 'Set configuration variables for your ionic app',
   args: {
-    '<command>': 'set'.yellow + ', ' + 'unset'.yellow + ', ' + 'build'.yellow + ', or ' + 'info'.yellow,
+    '<command>': chalk.yellow('set') + ', ' +
+      chalk.yellow('unset') + ', ' + chalk.yellow('build') + ', or ' + chalk.yellow('info'),
     '[key]': 'The key to set',
     '[value]': 'The value to set'
   },

lib/ionic/docs.js

@@ -1,5 +1,6 @@
 'use strict';
 
+var chalk = require('chalk');
 var prompt = require('prompt');
 var _ = require('underscore');
 var extend = require('../utils/extend');
@@ -28,7 +29,7 @@ function list() {
     var docsList = IonicDocs.api;
 
     // var i = 0;
-    log.info('Help Topics'.yellow);
+    log.info(chalk.yellow('Help Topics'));
     _.each(docsList, function(doc) {
       var table = new Table({ head: [doc.id] });
       var count = 0;
@@ -50,7 +51,7 @@ function list() {
   } catch (ex) {
     log.error('Error listing docs:', ex);
   }
-  log.info('Type "ionic docs <docname>" to open the help document for that doc.'.blue.bold);
+  log.info(chalk.blue.bold('Type "ionic docs <docname>" to open the help document for that doc.'));
 }
 
 function openDefault() {
@@ -150,7 +151,7 @@ function lookUpCommand(helpDoc) {
 
   function openDoc(topic, doc) {
     var url = sanitizeUrl('http://ionicframework.com/docs/api/' + topic + '/' + doc);
-    log.info('Opening Ionic document:'.green.bold, url.green.bold);
+    log.info(chalk.green.bold('Opening Ionic document:'), chalk.green.bold(url));
     return require('open')(url);
   }
 }

lib/ionic/emulate.js

@@ -1,5 +1,6 @@
 'use strict';
 
+var chalk = require('chalk');
 var extend = require('../utils/extend');
 var npmScripts = require('../utils/npmScripts');
 var os = require('os');
@@ -10,7 +11,7 @@ var log = IonicAppLib.logging.logger;
 var cordovaUtils = require('../utils/cordova');
 
 var cordovaRunEmulateOptions = {
-  '--livereload|-l': 'Live reload app dev files from the device' + ' (beta)'.yellow,
+  '--livereload|-l': 'Live reload app dev files from the device' + chalk.yellow(' (beta)'),
   '--address': 'Use specific address (livereload req.)',
   '--port|-p': 'Dev server HTTP port (8100 default, livereload req.)',
   '--livereload-port|-r': 'Live Reload port (35729 default, livereload req.)',

lib/ionic/generate.js

@@ -5,7 +5,6 @@ var path = require('path');
 var ionicAppLib = require('ionic-app-lib');
 var appGenerator = require('@ionic/app-generators');
 var log = ionicAppLib.logging.logger;
-var Project =  ionicAppLib.project;
 var fail = ionicAppLib.utils.fail;
 
 var settings = {
@@ -34,16 +33,8 @@ function run(ionic, argv) {
       return fail('Generators are only available for Ionic 2 projects');
     }
 
-    var project;
-    try {
-      project = Project.load(process.cwd());
-    } catch (err) {
-      return fail(err);
-    }
-
     var generator = argv._[1];
     var name = argv._[2]; // TODO support multiple names
-    var isTS = project.get('typescript') || argv.ts;
 
     if (argv.list) {
       appGenerator.printAvailableGenerators();
@@ -117,45 +108,6 @@ function run(ionic, argv) {
   }
 }
 
-function loadToolingModule() {
-
-  // First try node_modules/ionic-angular/tooling
-  var toolingPath;
-  var ionicModule;
-
-  try {
-    toolingPath = path.join(process.cwd(), 'node_modules', 'ionic-angular', 'tooling');
-    ionicModule = require(toolingPath);
-  } catch (err) {
-
-    // if this isn't found, that's fine, check for ionic-framework
-    if (err.code !== 'MODULE_NOT_FOUND') {
-      fail('Error when requiring ' + toolingPath + ':\n  ' + err);
-    }
-  }
-
-  // Then try node_modules/ionic-framework/tooling
-  if (!ionicModule) {
-    try {
-      ionicModule = require(path.join(process.cwd(), 'node_modules', 'ionic-framework', 'tooling'));
-    } catch (err) {
-      if (err.code === 'MODULE_NOT_FOUND') {
-        fail('No ionic-angular package found, do you have Ionic installed?');
-      }
-    }
-  }
-
-  // Last, try node_modules/ionic-framework (beta.1 and below)
-  if (!ionicModule) {
-    try {
-      ionicModule = require(path.join(process.cwd(), 'node_modules', 'ionic-framework'));
-    } catch (err) {
-      fail(err);
-    }
-  }
-  return ionicModule;
-}
-
 module.exports = extend(settings, {
   run: run
 });

lib/ionic/help.js

@@ -1,5 +1,6 @@
 'use strict';
 
+var chalk = require('chalk');
 var extend = require('../utils/extend');
 var helpUtil = require('../utils/help');
 
@@ -28,7 +29,7 @@ function run(ionic, argv) {
     return helpUtil.printTaskUsage(task, ionic.VERSION);
   }
 
-  return console.log('Command not found.'.red.bold);
+  return console.log(chalk.red.bold('Command not found.'));
 }
 
 module.exports = extend(settings, {