feat: support webpack/webpack-dev-server from hard-failing on error messages (#112)

* changes to support webpack-dev-server

Fixes #103

* addressed maintainer comments

reverted javascript style-related preferences

* readme updates to emitErrors and failOnError

updates to address clarifying specific behavior of emitErrors and
failOnError keys.

* updated test cases, resolved cross-env issues

Author: nickgcattaneo

README.md

@@ -43,8 +43,8 @@ See [stylelint options](http://stylelint.io/user-guide/node-api/#options) for th
 
 * `configFile`: You can change the config file location. Default: (`undefined`), handled by [stylelint's cosmiconfig module](http://stylelint.io/user-guide/configuration/).
 * `context`: String indicating the root of your SCSS files. Default: inherits from webpack config.
-* `emitErrors`: Display Stylelint errors as actual errors, rather than just warnings. Default: `true`
-* `failOnError`: Have Webpack's build process die on error. Default: `false`
+* `emitErrors`: Pipe stylelint 'error' severity messages to the error message handler in webpack's current instance. Note when this property is disabled (false) all stylelint messages are piped to webpack's warning message handler. Default: `true`
+* `failOnError`: Throw a fatal error in the global build process (e.g. kill your entire build process on any stylelint 'error' severity message). Default: `false`
 * `files`: Change the glob pattern for finding files. Must be relative to `options.context`. Default: `['**/*.s?(a|c)ss']`
 * `formatter`: Use a custom formatter to print errors to the console. Default: `require('stylelint').formatters.string`
 * `lintDirtyModulesOnly`: Lint only changed files, skip lint on start. Default: `false`

lib/run-compilation.js

@@ -14,6 +14,7 @@ var errorMessage = require('./constants').errorMessage;
 module.exports = function runCompilation (options, compiler, done) {
   var errors = [];
   var warnings = [];
+  var compilerMethod = options.emitErrors ? 'after-compile' : 'after-emit';
 
   linter(options)
     .then(function linterSuccess (lint) {
@@ -38,7 +39,7 @@ module.exports = function runCompilation (options, compiler, done) {
     })
     .catch(done);
 
-  compiler.plugin('after-emit', function afterEmit (compilation, callback) {
+  compiler.plugin(compilerMethod, function (compilation, next) {
     if (warnings.length) {
       compilation.warnings.push(new Error(options.formatter(warnings)));
       warnings = [];
@@ -49,7 +50,7 @@ module.exports = function runCompilation (options, compiler, done) {
       errors = [];
     }
 
-    callback();
+    next();
   });
 };
 

package.json

@@ -43,6 +43,7 @@
     "chai": "^4.0.2",
     "conventional-github-releaser": "^1.1.3",
     "coveralls": "^3.0.0",
+    "cross-env": "^5.1.3",
     "dotenv": "^4.0.0",
     "memory-fs": "^0.4.1",
     "mocha": "^4.0.1",
@@ -55,8 +56,8 @@
   },
   "scripts": {
     "pretest": "semistandard",
-    "test:webpack1": "WEBPACK_VERSION=1 nyc mocha",
-    "test:webpack3": "WEBPACK_VERSION=3 nyc mocha",
+    "test:webpack1": "cross-env WEBPACK_VERSION=1 nyc mocha",
+    "test:webpack3": "cross-env WEBPACK_VERSION=3 nyc mocha",
     "test": "run-s test:*",
     "preversion": "npm run test",
     "version": "git add -A ."

test/index.test.js

@@ -107,7 +107,7 @@ describe('stylelint-webpack-plugin', function () {
       return pack(assign({}, baseConfig, config))
         .then(function (stats) {
           expect(stats.compilation.errors).to.have.length(1);
-          td.verify(console.warn(td.matchers.contains('✖')));
+          td.verify(console.warn(td.matchers.contains(/.*/i)));
         });
     });
   });
@@ -208,7 +208,7 @@ describe('stylelint-webpack-plugin', function () {
           expect(stats.compilation.errors).to.have.length(0);
           expect(stats.compilation.warnings).to.have.length(1);
           expect(stats.compilation.warnings[0]).to.be.an.instanceof(Error);
-          expect(stats.compilation.warnings[0].message).to.contain('✖');
+          expect(stats.compilation.warnings[0].message.length > 0).to.equal(true);
         });
     });
 
@@ -218,7 +218,7 @@ describe('stylelint-webpack-plugin', function () {
           expect(stats.compilation.errors).to.have.length(0);
           expect(stats.compilation.warnings).to.have.length(1);
           expect(stats.compilation.warnings[0]).to.be.an.instanceof(Error);
-          expect(stats.compilation.warnings[0].message).to.contain('⚠');
+          expect(stats.compilation.warnings[0].message.length > 0).to.equal(true);
         });
     });
   });

yarn.lock

@@ -815,6 +815,13 @@ create-error-class@^3.0.0:
   dependencies:
     capture-stack-trace "^1.0.0"
 
+cross-env@^5.1.3:
+  version "5.1.3"
+  resolved "https://registry.yarnpkg.com/cross-env/-/cross-env-5.1.3.tgz#f8ae18faac87692b0a8b4d2f7000d4ec3a85dfd7"
+  dependencies:
+    cross-spawn "^5.1.0"
+    is-windows "^1.0.0"
+
 cross-spawn@^4:
   version "4.0.2"
   resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-4.0.2.tgz#7b9247621c23adfdd3856004a823cbe397424d41"
@@ -2106,6 +2113,10 @@ is-utf8@^0.2.0:
   version "0.2.1"
   resolved "https://registry.yarnpkg.com/is-utf8/-/is-utf8-0.2.1.tgz#4b0da1442104d1b336340e80797e865cf39f7d72"
 
+is-windows@^1.0.0:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/is-windows/-/is-windows-1.0.1.tgz#310db70f742d259a16a369202b51af84233310d9"
+
 isarray@0.0.1:
   version "0.0.1"
   resolved "https://registry.yarnpkg.com/isarray/-/isarray-0.0.1.tgz#8a18acfca9a8f4177e09abfc6038939b05d1eedf"