[changed] created a new module util; made the webpack module private

Author: thealjey

src/Compiler.js

@@ -5,7 +5,7 @@ import mkdirp from 'mkdirp';
 import {dirname} from 'path';
 import {writeFile, readFile} from 'fs';
 import {gzip, gunzip} from 'zlib';
-import {isProduction} from './webpack';
+import {isProduction} from './util';
 import {logError, logSequentialSuccessMessage} from './logger';
 
 /**

src/JSCompiler.js

@@ -6,7 +6,8 @@ import {readdir, stat, createReadStream, createWriteStream} from 'fs';
 import {transformFile} from 'babel-core';
 import forEach from 'lodash/forEach';
 import noop from 'lodash/noop';
-import {getCompiler, babelBEOptions} from './webpack';
+import {getCompiler} from './webpack';
+import {babelBEOptions} from './util';
 import {logError, log, consoleStyles} from './logger';
 
 /* eslint-disable no-sync */

src/highlight.js

@@ -5,15 +5,16 @@ import noop from 'lodash/noop';
 import constant from 'lodash/constant';
 import {load} from 'cheerio';
 import {transformElements, arrayToJSX} from './jsx';
+import {isNode} from './util';
 
 /**
  * CodeMirror syntax highlighting that works in the browser and on Node.js
  *
  * @module highlight
  */
 
-// when not in the browser, polyfill specific DOM requirements of CodeMirror
-if ('undefined' === typeof navigator) {
+// on Node.js, polyfill specific DOM requirements of CodeMirror
+if (isNode) {
   global.window = jsdom().defaultView;
   global.navigator = window.navigator;
   window.document.createRange = constant({

src/index.js

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

src/logger.js

@@ -6,6 +6,7 @@ import map from 'lodash/map';
 import transform from 'lodash/transform';
 import ErrorStackParser from 'error-stack-parser';
 import cleanStack from 'clean-stack';
+import {isNode} from './util';
 
 /* eslint-disable no-console */
 
@@ -51,16 +52,6 @@ let i = 0;
  */
 export class Message {
 
-  /**
-   * true on Node.js
-   *
-   * @member {boolean} isNode
-   * @memberof module:logger.Message
-   * @private
-   * @static
-   */
-  static isNode: boolean = 'undefined' !== typeof process && 'node' === process.release.name;
-
   /**
    * a style config
    *
@@ -151,7 +142,7 @@ export class Message {
    * @param {string | number | module:logger.Message} msg - a message
    */
   addMessage(msg: string | number | Message) {
-    if (Message.isNode) {
+    if (isNode) {
       this.addBEMessage(msg);
     } else if (msg instanceof Message) {
       this.addFEMessageInstance(msg);

src/util.js

@@ -0,0 +1,79 @@
+/* @flow */
+
+/* eslint-disable no-process-env */
+
+/**
+ * Generic utilities and configuration objects.
+ *
+ * @module util
+ */
+
+/**
+ * `true` on Node.js
+ *
+ * @memberof module:util
+ * @constant {boolean} isNode
+ * @example
+ * import {isNode} from 'webcompiler';
+ * // or - import {isNode} from 'webcompiler/lib/util';
+ * // or - var isNode = require('webcompiler').isNode;
+ * // or - var isNode = require('webcompiler/lib/util').isNode;
+ */
+export const isNode = 'undefined' !== typeof process && 'node' === process.release.name;
+
+/**
+ * `true` if the `NODE_ENV` environment variable is set to `"production"`
+ *
+ * @memberof module:util
+ * @constant {boolean} isProduction
+ * @example
+ * import {isProduction} from 'webcompiler';
+ * // or - import {isProduction} from 'webcompiler/lib/util';
+ * // or - var isProduction = require('webcompiler').isProduction;
+ * // or - var isProduction = require('webcompiler/lib/util').isProduction;
+ */
+export const isProduction = 'production' === process.env.NODE_ENV;
+
+/**
+ * Babel configuration for the Node.js.
+ *
+ * @memberof module:util
+ * @member {Object} babelBEOptions
+ * @example
+ * import {babelBEOptions} from 'webcompiler';
+ * // or - import {babelBEOptions} from 'webcompiler/lib/util';
+ * // or - var babelBEOptions = require('webcompiler').babelBEOptions;
+ * // or - var babelBEOptions = require('webcompiler/lib/util').babelBEOptions;
+ */
+export const babelBEOptions = {
+  babelrc: false,
+  presets: ['es2016', 'es2017', 'stage-2', 'react'],
+  plugins: [
+    ['transform-es2015-modules-commonjs', {loose: true}]
+  ]
+};
+
+/**
+ * Babel configuration for the browser.
+ *
+ * @memberof module:util
+ * @member {Object} babelFEOptions
+ * @example
+ * import {babelFEOptions} from 'webcompiler';
+ * // or - import {babelFEOptions} from 'webcompiler/lib/util';
+ * // or - var babelFEOptions = require('webcompiler').babelFEOptions;
+ * // or - var babelFEOptions = require('webcompiler/lib/util').babelFEOptions;
+ */
+export const babelFEOptions = {
+  cacheDirectory: true,
+  babelrc: false,
+  presets: [
+    ['es2015', {
+      // temporarily disabled until `webpack` 2.3 and `webpack-hot-loader` 3.0 are available
+      // modules: false,
+      loose: true
+    }],
+    'es2016', 'es2017', 'stage-2', 'react'
+  ],
+  plugins: ['transform-runtime']
+};

src/webpack.js

@@ -5,6 +5,7 @@ import {dirname, basename} from 'path';
 import WebpackDevServer from 'webpack-dev-server';
 import MemoryFS from 'memory-fs';
 import serveStatic from 'serve-static';
+import {isProduction, babelFEOptions} from './util';
 
 /* eslint-disable no-process-env */
 
@@ -26,64 +27,9 @@ const cache = {},
  * You can use it to tweak the Babel options.
  *
  * @module webpack
+ * @private
  */
 
-/**
- * `true` if the `NODE_ENV` environment variable is set to `'production'`
- *
- * @memberof module:webpack
- * @constant {boolean} isProduction
- */
-export const isProduction = 'production' === process.env.NODE_ENV;
-
-/**
- * Babel configuration for the Node.js.
- *
- * @memberof module:webpack
- * @member {Object} babelBEOptions
- * @example
- * import {babelBEOptions} from 'webcompiler';
- * // or - import {babelBEOptions} from 'webcompiler/lib/webpack';
- * // or - var babelBEOptions = require('webcompiler').babelBEOptions;
- * // or - var babelBEOptions = require('webcompiler/lib/webpack').babelBEOptions;
- *
- * babelFEOptions.presets.push('my-custom-preset');
- */
-export const babelBEOptions = {
-  babelrc: false,
-  presets: ['es2016', 'es2017', 'stage-2', 'react'],
-  plugins: [
-    ['transform-es2015-modules-commonjs', {loose: true}]
-  ]
-};
-
-/**
- * Babel configuration for the browser.
- *
- * @memberof module:webpack
- * @member {Object} babelFEOptions
- * @example
- * import {babelFEOptions} from 'webcompiler';
- * // or - import {babelFEOptions} from 'webcompiler/lib/webpack';
- * // or - var babelFEOptions = require('webcompiler').babelFEOptions;
- * // or - var babelFEOptions = require('webcompiler/lib/webpack').babelFEOptions;
- *
- * babelFEOptions.presets.push('my-custom-preset');
- */
-export const babelFEOptions = {
-  cacheDirectory: true,
-  babelrc: false,
-  presets: [
-    ['es2015', {
-      // temporarily disabled until `webpack` 2.3 and `webpack-hot-loader` 3.0 are available
-      // modules: false,
-      loose: true
-    }],
-    'es2016', 'es2017', 'stage-2', 'react'
-  ],
-  plugins: ['transform-runtime']
-};
-
 /**
  * Returns a webpack configuration object.
  *