feat: make possible to define official formatter as string (#202)

Author: ricardogobbosouza

README.md

@@ -77,10 +77,10 @@ If `true`, `stylelint` will fix as many errors as possible. The fixes are made t
 
 ### `formatter`
 
-- Type: `Function`
-- Default: `require('stylelint').formatters.string`
+- Type: `String|Function`
+- Default: `'string'`
 
-Specify the formatter that you would like to use to format your results.
+Specify the formatter that you would like to use to format your results. See [formatter option](https://stylelint.io/user-guide/node-api#formatter).
 
 ### `lintDirtyModulesOnly`
 

src/getOptions.js

@@ -2,21 +2,39 @@ import validateOptions from 'schema-utils';
 
 import schema from './options.json';
 
-export default function getOptions(options) {
+export default function getOptions(pluginOptions) {
+  const options = {
+    files: '**/*.s?(c|a)ss',
+    formatter: 'string',
+    stylelintPath: 'stylelint',
+    ...pluginOptions,
+  };
+
   validateOptions(schema, options, {
     name: 'Stylelint Webpack Plugin',
     baseDataPath: 'options',
   });
 
-  const stylelintPath = options.stylelintPath || 'stylelint';
-
   // eslint-disable-next-line
-  const { formatters } = require(stylelintPath);
+  const stylelint = require(options.stylelintPath);
 
-  return {
-    files: '**/*.s?(c|a)ss',
-    formatter: formatters.string,
-    stylelintPath,
-    ...options,
-  };
+  options.formatter = getFormatter(stylelint, options.formatter);
+
+  return options;
+}
+
+function getFormatter({ formatters }, formatter) {
+  if (typeof formatter === 'function') {
+    return formatter;
+  }
+
+  // Try to get oficial formatter
+  if (
+    typeof formatter === 'string' &&
+    typeof formatters[formatter] === 'function'
+  ) {
+    return formatters[formatter];
+  }
+
+  return formatters.string;
 }

src/options.json

@@ -28,7 +28,7 @@
     },
     "formatter": {
       "description": "Specify the formatter that you would like to use to format your results.",
-      "instanceof": "Function"
+      "anyOf": [{ "type": "string" }, { "instanceof": "Function" }]
     },
     "lintDirtyModulesOnly": {
       "description": "Lint only changed files, skip lint on start.",

test/formatter.test.js

@@ -0,0 +1,53 @@
+import { formatters } from 'stylelint';
+
+import pack from './utils/pack';
+
+describe('formatter', () => {
+  it('should use default formatter', (done) => {
+    const compiler = pack('error');
+
+    compiler.run((err, stats) => {
+      expect(err).toBeNull();
+      expect(stats.hasWarnings()).toBe(false);
+      expect(stats.hasErrors()).toBe(true);
+      expect(stats.compilation.errors[0].message).toBeTruthy();
+      done();
+    });
+  });
+
+  it('should use default formatter when invalid', (done) => {
+    const compiler = pack('error', { formatter: 'invalid' });
+
+    compiler.run((err, stats) => {
+      expect(err).toBeNull();
+      expect(stats.hasWarnings()).toBe(false);
+      expect(stats.hasErrors()).toBe(true);
+      expect(stats.compilation.errors[0].message).toBeTruthy();
+      done();
+    });
+  });
+
+  it('should use string formatter', (done) => {
+    const compiler = pack('error', { formatter: 'json' });
+
+    compiler.run((err, stats) => {
+      expect(err).toBeNull();
+      expect(stats.hasWarnings()).toBe(false);
+      expect(stats.hasErrors()).toBe(true);
+      expect(stats.compilation.errors[0].message).toBeTruthy();
+      done();
+    });
+  });
+
+  it('should use function formatter', (done) => {
+    const compiler = pack('error', { formatter: formatters.verbose });
+
+    compiler.run((err, stats) => {
+      expect(err).toBeNull();
+      expect(stats.hasWarnings()).toBe(false);
+      expect(stats.hasErrors()).toBe(true);
+      expect(stats.compilation.errors[0].message).toBeTruthy();
+      done();
+    });
+  });
+});