feat: support disabling colour output

via cli --no-color/--no-colour and via nodemon.json colours: false

Author: remy

doc/cli/help.txt

@@ -11,6 +11,7 @@
   -V, --verbose ............ show detail on what is causing restarts.
   -I, --no-stdin ........... don't try to read from stdin.
   -C, --on-change-only ..... execute script on change only, not startup
+  --no-colors .............. disable color output
   -d, --delay n ............ debounce restart for "n" seconds.
   --exitcrash .............. exit on crash, allows use of nodemon with daemon
                              tools like forever.js.

lib/cli/parse.js

@@ -178,6 +178,10 @@ function nodemonOption(options, arg, eatNext) {
     options.ext = eatNext();
   } else
 
+  if (arg === '--no-colours' || arg === '--no-colors') {
+    options.colours = false;
+  } else
+
   if (arg === '--cwd') {
     options.cwd = eatNext();
 

lib/config/defaults.js

@@ -1,6 +1,7 @@
 // default options for config.options
 module.exports = {
   restartable: 'rs',
+  colours: true,
   execMap: {
     py: 'python',
     rb: 'ruby',

lib/nodemon.js

@@ -71,6 +71,9 @@ function nodemon(settings) {
       return;
     }
 
+    // before we print anything, update the colour setting on logging
+    utils.colours = config.options.colours;
+
     // always echo out the current version
     utils.log.info(version);
 

lib/utils/index.js

@@ -78,4 +78,13 @@ Object.defineProperty(utils, 'debug', {
   get: function () {
     return this.log.debug;
   },
+});
+
+Object.defineProperty(utils, 'colours', {
+  set: function (value) {
+    this.log.useColours = value;
+  },
+  get: function () {
+    return this.log.useColours;
+  },
 });

lib/utils/log.js

@@ -2,6 +2,7 @@ var util = require('util');
 var colour = require('./colour');
 var bus = require('./bus');
 var required = false;
+var useColours = true;
 
 var coding = {
   log: 'black',
@@ -13,7 +14,11 @@ var coding = {
 };
 
 function log(type, text) {
-  var msg = colour(coding[type], '[nodemon] ' + (text || ''));
+  var msg = '[nodemon] ' + (text || '');
+
+  if (useColours) {
+    msg = colour(coding[type], msg);
+  }
 
   // always push the message through our bus
   bus.emit('log', { type: type, message: text, colour: msg });
@@ -63,4 +68,13 @@ Logger.prototype._log = function (type, msg) {
   }
 };
 
+Object.defineProperty(Logger.prototype, 'useColours', {
+  set: function (val) {
+    useColours = val;
+  },
+  get: function () {
+    return useColours;
+  },
+});
+
 module.exports = Logger;

test/utils/log.test.js

@@ -1,9 +1,10 @@
 'use strict';
 /*global describe:true, it: true */
-var logger = require('../../lib/utils/log')(true),
-    bus = require('../../lib/utils/bus'),
-    colour = require('../../lib/utils/colour'),
-    assert = require('assert');
+var Logger = require('../../lib/utils/log');
+var logger = new Logger(true);
+var bus = require('../../lib/utils/bus');
+var colour = require('../../lib/utils/colour');
+var assert = require('assert');
 
 describe('logger', function () {
   var types = {
@@ -28,6 +29,31 @@ describe('logger', function () {
     });
   });
 
+  it('should disable colour', function () {
+    var type = 'fail';
+    bus.once('log', function (event) {
+      assert.equal(event.message, type);
+      assert.ok(event.colour.indexOf(colour[types[type]]) !== -1);
+    });
+    logger[type](type);
+
+    logger.useColours = false;
+
+    bus.once('log', function (event) {
+      assert.equal(event.message, type);
+      assert.ok(event.colour.indexOf(colour[types[type]]) === -1);
+    });
+    logger[type](type);
+
+    logger.useColours = true;
+
+    bus.once('log', function (event) {
+      assert.equal(event.message, type);
+      assert.ok(event.colour.indexOf(colour[types[type]]) !== -1);
+    });
+    logger[type](type);
+  });
+
   // it('should not log detail if debug is off', function (done) {
   //   logger.debug = false;