feat - Add stricter plugin option validation

Author: bebraw

CHANGELOG.md

@@ -1,5 +1,10 @@
 ## purifycss-webpack
 
+0.2.0 / 2017-01-24
+==================
+
+  * Feature - Add stricter plugin option validation.
+
 0.1.1 / 2017-01-23
 ==================
 

__tests__/test-validate-options.js

@@ -0,0 +1,32 @@
+const assert = require('assert');
+const validateOptions = require('../src/validate-options').default;
+
+describe('Validate options', function () {
+  it('fails empty data', function () {
+    const result = validateOptions();
+
+    assert.ok(!result.isValid);
+    assert.ok(result.error);
+  });
+
+  it('fails empty data', function () {
+    const result = validateOptions({});
+
+    assert.ok(!result.isValid);
+    assert.ok(result.error);
+  });
+
+  it('does not fail if paths are provided', function () {
+    const result = validateOptions({ paths: ['./foo'] });
+
+    assert.ok(result.isValid);
+    assert.ok(!result.error);
+  });
+
+  it('does not allow arbitrary properties', function () {
+    const result = validateOptions({ paths: ['./foo'], foobar: ['./foo'] });
+
+    assert.ok(!result.isValid);
+    assert.ok(result.error);
+  });
+});

examples/webpack.config.js

@@ -25,7 +25,7 @@ module.exports = [
     parts.purifyCSS({
       verbose: true,
       paths: glob.sync(`${PATHS.app}/*`),
-      extensions: ['.css', '.html']
+      fileExtensions: ['.css']
     })
   ),
   merge(
@@ -45,7 +45,7 @@ module.exports = [
         first: glob.sync(`${PATHS.app}/*`),
         second: glob.sync(`${PATHS.another}/*`)
       },
-      extensions: ['.css', '.html']
+      fileExtensions: ['.css']
     })
   )
 ];

package.json

@@ -46,8 +46,9 @@
     "webpack": "^1.9 || 2 || ^2.1.0-beta || ^2.2.0-rc"
   },
   "dependencies": {
-    "webpack-sources": "^0.1.4",
-    "purify-css": "^1.1.9"
+    "ajv": "^4.11.2",
+    "purify-css": "^1.1.9",
+    "webpack-sources": "^0.1.4"
   },
   "devDependencies": {
     "babel-cli": "^6.18.0",

src/index.js

@@ -2,10 +2,13 @@ const purify = require('purify-css');
 const ConcatSource = require('webpack-sources').ConcatSource;
 const parse = require('./parse');
 const search = require('./search');
+const validateOptions = require('./validate-options').default;
 
 module.exports = function PurifyPlugin(options) {
-  if (typeof options !== 'object' || !options.paths) {
-    throw new Error('You should pass an options object containing an array of paths at least');
+  const validation = validateOptions(options);
+
+  if (!validation.isValid) {
+    throw new Error(validation.error);
   }
 
   return {

src/schema.js

@@ -0,0 +1,35 @@
+export default {
+  $schema: 'http://json-schema.org/draft-04/schema#',
+  additionalProperties: false,
+  type: 'object',
+  properties: {
+    fileExtensions: {
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    },
+    moduleExtensions: {
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    },
+    paths: {
+      type: ['array', 'object'],
+      items: {
+        type: 'string'
+      }
+    },
+    purifyOptions: {
+      type: 'object',
+      properties: {}
+    },
+    verbose: {
+      type: 'boolean'
+    }
+  },
+  required: [
+    'paths'
+  ]
+};

src/validate-options.js

@@ -0,0 +1,14 @@
+import Ajv from 'ajv';
+import schema from './schema';
+
+function validateOptions(data) {
+  const ajv = new Ajv();
+  const isValid = ajv.validate(schema, data);
+
+  return {
+    isValid,
+    error: ajv.errors && ajv.errorsText()
+  };
+}
+
+export default validateOptions;