[added] function logSequentialSuccessMessage to the logger module

Author: thealjey

src/Compiler.js

@@ -5,14 +5,8 @@ import mkdirp from 'mkdirp';
 import {dirname} from 'path';
 import {writeFile, readFile} from 'fs';
 import {gzip, gunzip} from 'zlib';
-import {logError, log, consoleStyles} from './logger';
 import {isProduction} from './webpack';
-
-/* eslint-disable no-process-env */
-
-const {green} = consoleStyles;
-
-let i = 0;
+import {logError, logSequentialSuccessMessage} from './logger';
 
 /**
  * The base compiler class
@@ -49,7 +43,7 @@ export class Compiler {
    * @param {Function} callback - a callback function
    */
   static done(inPath: string, callback: () => void) {
-    log(green(++i, '. Compiled ', inPath));
+    logSequentialSuccessMessage(`Compiled ${inPath}`);
     callback();
   }
 

src/Documentation.js

@@ -3,7 +3,7 @@
 import type {NativeProcess} from './NativeProcess';
 import {join} from 'path';
 import noop from 'lodash/noop';
-import {logError} from './logger';
+import {logError, logSequentialSuccessMessage} from './logger';
 import {findBinary} from './findBinary';
 import {watch} from './watch';
 import tinylr from 'tiny-lr';
@@ -81,6 +81,7 @@ export class Documentation {
         if (stderr) {
           return logError(stderr);
         }
+        logSequentialSuccessMessage(`Generated API documentation for ${inputDir}`);
         callback();
       }, [inputDir, '-d', outputDir, '-R', readMe, '-c', jsdocConfig, '-t', template]);
     });

src/index.js

@@ -6,8 +6,9 @@ export {Documentation} from './Documentation';
 export {watch} from './watch';
 export {yaml} from './yaml';
 export {findBinary} from './findBinary';
-export {consoleStyles, log, logError, logPostCSSWarnings, logSASSError, logLintingErrors} from './logger';
 export {babelBEOptions, babelFEOptions} from './webpack';
+export {consoleStyles, log, logError, logPostCSSWarnings, logSASSError, logLintingErrors,
+  logSequentialSuccessMessage} from './logger';
 
 export {flatten, arrayToJSX, htmlToArray, htmlToJSX} from './jsx';
 export {markdownToArray, markdownToJSX, markdownToHTML} from './markdown';

src/logger.js

@@ -9,6 +9,8 @@ import cleanStack from 'clean-stack';
 
 /* eslint-disable no-console */
 
+let i = 0;
+
 /**
  * Dead-simple, composable, isomorphic, cross-browser wrapper for `console.log`.
  *
@@ -405,3 +407,22 @@ export function logLintingErrors(errors: LintError[], prefix: ?string = null) {
   });
   log(prefix ? `${prefix} l` : 'L', 'inting errors: ', errors.length);
 }
+
+/**
+ * Within the current process logs green colored messages out to the console prepending a sequential a number starting
+ * with "1." to the message, to make it easier to distinguish messages containing the same text.
+ *
+ * @memberof module:logger
+ * @function logSequentialSuccessMessage
+ * @param {string} message - a message to log
+ * @example
+ * import {logSequentialSuccessMessage} from 'webcompiler';
+ * // or - import {logSequentialSuccessMessage} from 'webcompiler/lib/logger';
+ * // or - var logSequentialSuccessMessage = require('webcompiler').logSequentialSuccessMessage;
+ * // or - var logSequentialSuccessMessage = require('webcompiler/lib/logger').logSequentialSuccessMessage;
+ */
+export function logSequentialSuccessMessage(message: string) {
+  const {green} = consoleStyles;
+
+  log(green(++i, '. ', message));
+}