Add log level to handle crash

.gitignore

@@ -1,4 +1,5 @@
 # Node
 /node_modules
+/*.log
 
 /coverage

CHANGELOG.md

@@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com) and this project follows the [Semantic Versioning](http://semver.org) code.
 
+## 0.5.0 - 2017-04-28
+### Added
+- Add log level w/o breaking change
+
+### Changed
+- Transform current behavior to use strict log level
+
 ## 0.4.0 - 2017-04-04
 ### Changed
 - Remove failed status **Breaking change**

README.md

@@ -137,6 +137,36 @@ var config = {
 }
 ```
 
+#### logLevel
+- Type: `String`
+- Default: `strict`
+- Allowed value: `strict`, `log`, `none`
+  - `strict`: catch errors in an exception, **the webpack build crashes**
+  - `log`: log errors in a log file (`warning.log`) and none behavior
+  - `none`: show errors in console (when silent mode is off)
+
+Specify behavior when the plugin fail.
+
+Example:
+```javascript
+var config = {
+  plugins: [
+    new ContentReplacerWebpackPlugin({
+      modifiedFile: './build/index.html',
+      [
+        {
+          regex: /text/g,
+          modification: 'new text'
+        }
+      ],
+      buildTrigger: 'done',
+      logLevel: 'log'
+      ...
+    })
+  ]
+}
+```
+
 #### silent
 - Type: `Boolean`  
 - Default: `false`

helpers/logger.js

@@ -0,0 +1,60 @@
+'use strict';
+
+const winston = require('winston');
+const path = require('path');
+
+const createLogger = (level, exception, file, exit) => {
+  const loggerConfig = {
+    transports: [
+      new winston.transports.Console({
+        level,
+        handleExceptions: exception,
+        humanReadableUnhandledException: true,
+        json: false,
+        colorize: true,
+      }),
+    ],
+    exitOnError: exit,
+  };
+  if (file) {
+    loggerConfig.transports.push(new winston.transports.File({
+      level,
+      filename: path.join(__dirname, '/../warning.log'),
+      handleExceptions: exception,
+      json: false,
+    }));
+  }
+
+  return new winston.Logger(loggerConfig);
+};
+
+module.exports = (level) => {
+  if (level === undefined) {
+    return { warn: () => {} };
+  }
+
+  const exceptionLevel = level.toLowerCase();
+  let logger;
+  switch (exceptionLevel) {
+    case 'none':
+
+      // level, exception, file, exit
+      logger = createLogger('warn', true, false, false);
+      break;
+
+    case 'log':
+
+      // level, exception, file, exit
+      logger = createLogger('warn', true, true, false);
+      break;
+
+    case 'strict':
+    default:
+
+      // level, exception, file, exit
+      logger = createLogger('error', false, false, true);
+      break;
+  }
+
+  return logger;
+};

index.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const fs = require('fs');
+const logger = require('./helpers/logger');
 
 const validBuildTrigger = ['after-emit', 'done'];
 
@@ -14,12 +15,20 @@ module.exports = class ContentReplacerWebpackPlugin {
       this.buildTrigger = options.buildTrigger || 'after-emit';
       this.silent = options.silent === true || false;
       this.verbose = !this.silent;
+
+      this.logLevel = options.logLevel || 'strict';
+      this.addLogger();
     } else {
       // Throw exception
       const error = typeof options === 'object'
         ? 'Required parameters are missing'
         : 'Parameters are invalid';
 
+      this.silent = false;
+      this.logLevel = 'strict';
+      this.addLogger();
+      this.exceptionLogger.warn(error);
+
       throw new Error(error);
     }
   }
@@ -41,6 +50,15 @@ module.exports = class ContentReplacerWebpackPlugin {
         options.modifications.length > 0);
   }
 
+  addLogger() {
+    if (!this.silent) {
+      this.exceptionLogger = logger(this.logLevel);
+    } else {
+      // Empty logger when silent mode is activated
+      this.exceptionLogger = logger();
+    }
+  }
+
   replace() {
     const that = this;
     if (fs.existsSync(this.modifiedFile)) {
@@ -60,7 +78,13 @@ module.exports = class ContentReplacerWebpackPlugin {
       return true;
     }
 
-    throw new Error('File not found');
+    this.exceptionLogger.warn('File not found');
+
+    if (this.logLevel === 'strict') {
+      throw new Error('File not found');
+    }
+
+    return false;
   }
 
   apply(compiler) {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "webpack-content-replacer-plugin",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Replace content in file in webpack workflow",
   "main": "index.js",
   "scripts": {
@@ -42,6 +42,7 @@
     "expect.js": "^0.3.1",
     "istanbul": "^0.4.5",
     "mocha": "^3.2.0",
+    "rimraf": "^2.6.1",
     "webpack": "^1.14.0",
     "webpack-mock": "^0.1.1"
   },
@@ -53,5 +54,8 @@
   },
   "files": [
     "index.js"
-  ]
+  ],
+  "dependencies": {
+    "winston": "^2.3.1"
+  }
 }

test/error-test.js

@@ -0,0 +1,65 @@
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const expect = require('expect.js');
+const webpack = require('webpack');
+const except = require('./../workflow_test/webpack.error.config.js');
+
+let stat;
+let error;
+let compiler = webpack(except.noFileLogLevelOptions);
+
+/**
+ ***************************************************************************
+ * Log level
+ ***************************************************************************
+ */
+
+describe('Webpack workflow log handler test case', function testcase() {
+  this.timeout(50000);
+
+  before((done) => {
+    compiler.run((err, stats) => {
+      stat = stats;
+      error = err;
+
+      return done();
+    });
+  });
+
+  it('should return error in log level', () => {
+    expect(error).to.equal(null);
+    expect(stat).to.not.be.empty();
+    fs.readFile(path.join(__dirname, '../warning.log'), (readError, data) => {
+      expect(readError).to.be.equal(null);
+      expect(data.toString('utf8')).to.not.be.empty();
+    });
+  });
+});
+
+/**
+ ***************************************************************************
+ * None level
+ ***************************************************************************
+ */
+
+compiler = webpack(except.noFileNoneLevelOptions);
+
+describe('Webpack workflow none exception handler test case', function testcase() {
+  this.timeout(50000);
+
+  before((done) => {
+    compiler.run((err, stats) => {
+      stat = stats;
+      error = err;
+
+      return done();
+    });
+  });
+
+  it('should return error in none level', () => {
+    expect(error).to.equal(null);
+    expect(stat).to.not.be.empty();
+  });
+});

test/module-test.js

@@ -74,12 +74,34 @@ describe('ContentReplacer plugin', () => {
     expect(ContentReplacerWebpackPlugin.hasRequiredParameters(invalidOptionsObj)).to.equal(false);
   });
 
-  it('should detect missing file', () => {
-    contentReplacer.verbose = false;
-    expect(contentReplacer.replace).to.throwException(/File not found/);
+  it('should detect missing file in silent mode', () => {
+    const modifiedOptions = options;
+    modifiedOptions.silent = true;
+    contentReplacer = new ContentReplacerWebpackPlugin(modifiedOptions);
+
+    let errEx;
+    try {
+      contentReplacer.replace();
+    } catch (e) {
+      errEx = e;
+    }
+
+    expect(errEx).not.to.be(undefined);
+  });
 
-    contentReplacer.verbose = true;
-    expect(contentReplacer.replace).to.throwException(/File not found/);
+  it('should detect missing file in verbose mode', () => {
+    const modifiedOptions = options;
+    modifiedOptions.silent = false;
+    contentReplacer = new ContentReplacerWebpackPlugin(modifiedOptions);
+
+    let errEx;
+    try {
+      contentReplacer.replace();
+    } catch (e) {
+      errEx = e;
+    }
+
+    expect(errEx).not.to.be(undefined);
   });
 
   it('should replace content', () => {

workflow_test/webpack.error.config.js

@@ -0,0 +1,36 @@
+const ContentReplacer = require('../index');
+
+const noFileNoneLevelOptions = {
+  modifiedFile: '/somepath',
+  modifications: [
+    {
+      regex: /red/g,
+      modification: 'blue',
+    },
+  ],
+  logLevel: 'none',
+};
+
+const noFileLogLevelOptions = {
+  modifiedFile: '/somepath',
+  modifications: [
+    {
+      regex: /red/g,
+      modification: 'blue',
+    },
+  ],
+  logLevel: 'log',
+};
+
+module.exports = {
+  noFileNoneLevelOptions: {
+    plugins: [
+      new ContentReplacer(noFileNoneLevelOptions),
+    ],
+  },
+  noFileLogLevelOptions: {
+    plugins: [
+      new ContentReplacer(noFileLogLevelOptions),
+    ],
+  },
+};