Allow to change the log's 'colors' parameter (yeoman#93)

Author: suzuki-shunsuke

lib/util/log.js

@@ -11,17 +11,6 @@ const logSymbols = require('log-symbols');
 const step = '  ';
 let padding = ' ';
 
-// Color -> status mappings
-const colors = {
-  skip: 'yellow',
-  force: 'yellow',
-  create: 'green',
-  invoke: 'bold',
-  conflict: 'red',
-  identical: 'cyan',
-  info: 'gray'
-};
-
 function pad(status) {
   const max = 'identical'.length;
   const delta = max - status.length;
@@ -44,7 +33,24 @@ function formatter(msg, ctx) {
   return msg;
 }
 
-module.exports = () => {
+const getDefaultColors = () => ({
+  skip: 'yellow',
+  force: 'yellow',
+  create: 'green',
+  invoke: 'bold',
+  conflict: 'red',
+  identical: 'cyan',
+  info: 'gray'
+});
+
+const initParams = params => {
+  params = params || {};
+  return Object.assign(
+    {}, params, {
+      colors: Object.assign(getDefaultColors(), params.colors || {})});
+};
+
+module.exports = params => {
   // `this.log` is a [logref](https://github.com/mikeal/logref)
   // compatible logger, with an enhanced API.
   //
@@ -61,6 +67,9 @@ module.exports = () => {
   // - msg      - The message to show up
   // - context  - The optional context to escape the message against
   //
+  // @param {Object} params
+  // @param {Object} params.colors status mappings
+  //
   // Returns the logger
   function log(msg, ctx) {
     msg = msg || '';
@@ -76,6 +85,8 @@ module.exports = () => {
 
   _.extend(log, EventEmitter.prototype);
 
+  params = initParams(params);
+
   // A simple write method, with formatted message.
   //
   // Returns the logger
@@ -114,7 +125,7 @@ module.exports = () => {
 
   /* eslint-disable no-loop-func */
   // TODO: Fix this ESLint warning
-  for (const status of Object.keys(colors)) {
+  for (const status of Object.keys(params.colors)) {
     // Each predefined status has its logging method utility, handling
     // status color and padding before the usual `.write()`
     //
@@ -128,7 +139,7 @@ module.exports = () => {
     //      .write()
     //      .ok('This is ok');
     //
-    // The list of status and mapping colors
+    // The list of default status and mapping colors
     //
     //    skip       yellow
     //    force      yellow
@@ -140,7 +151,7 @@ module.exports = () => {
     //
     // Returns the logger
     log[status] = function () {
-      const color = colors[status];
+      const color = params.colors[status];
       this.write(chalk[color](pad(status))).write(padding);
       this.write(util.format.apply(util, arguments) + '\n');
       return this;

test/adapter.js

@@ -4,6 +4,7 @@ const inquirer = require('inquirer');
 const sinon = require('sinon');
 const logSymbols = require('log-symbols');
 const TerminalAdapter = require('../lib/adapter');
+const createLog = require('../lib/util/log');
 
 describe('TerminalAdapter', () => {
   beforeEach(function () {
@@ -146,4 +147,22 @@ describe('TerminalAdapter', () => {
       it('#info()');
     });
   });
+
+  describe('#log', () => {
+    const funcs = ['write', 'writeln', 'ok', 'error', 'table'];
+    const defaultColors = [
+      'skip', 'force', 'create', 'invoke', 'conflict', 'identical', 'info'];
+    it('log has functions', function () {
+      this.adapter.log = createLog();
+      funcs.concat(defaultColors).forEach(k => {
+        assert.equal(typeof this.adapter.log[k], 'function');
+      });
+    });
+    it('log can be added custom status', function () {
+      this.adapter.log = createLog({colors: {merge: 'yellow'}});
+      funcs.concat(defaultColors, ['merge']).forEach(k => {
+        assert.equal(typeof this.adapter.log[k], 'function');
+      });
+    });
+  });
 });