feat: add ValidationError (#8)

* refactor(src/validateOptions): add schema && Error handling

* feat(src/ValidationError): add Options Validation Error

* test: simplify tests

* docs(README): document validateOptions, add examples

* chore: update webpack-defaults && dependencies

* docs(README): add && update logo, fix typo

* test: run tests on src files

* refactor(ValidationError): hide err.stack

Author: michael-ciniawsky

.babelrc

@@ -15,14 +15,38 @@
           "transform-regenerator"
         ]
       }
+    ],
+    [
+      "env",
+      {
+        "useBuiltIns": true,
+        "targets": {
+          "node": 4.3
+        },
+        "exclude": [
+          "transform-async-to-generator",
+          "transform-regenerator"
+        ]
+      }
     ]
   ],
   "ignore": [],
   "env": {
     "test": {
       "presets": [
         "env"
+      ],
+      "plugins": [
+        "transform-object-rest-spread"
       ]
     }
-  }
+  },
+  "plugins": [
+    [
+      "transform-object-rest-spread",
+      {
+        "useBuiltIns": true
+      }
+    ]
+  ]
 }

README.md

@@ -1,48 +1,66 @@
 [![npm][npm]][npm-url]
+[![node][node]][node-url]
 [![deps][deps]][deps-url]
 [![test][test]][test-url]
 [![coverage][cover]][cover-url]
-[![quality][quality]][quality-url]
 [![chat][chat]][chat-url]
 
 <div align="center">
-  <!-- replace with accurate logo e.g from https://worldvectorlogo.com/ -->
+  <a href="http://json-schema.org">
+    <!-- src="https://webpack-contrib.github.io/schema-utils/logo.png" -->
+    <img width="180" height="180"
+      src="https://raw.githubusercontent.com/json-schema-org/json-schema-org.github.io/master/img/logo.png">
+  </a>
   <a href="https://github.com/webpack/webpack">
-    <img width="200" height="200" vspace="" hspace="25"
-      src="https://worldvectorlogo.com/logos/webpack.svg">
+    <img width="200" height="200" hspace="10"
+      src="https://webpack.js.org/assets/icon-square-big.svg">
   </a>
-  <h1>Webpack Schema Utilities</h1>
-  <p>Schema validation utilities for Ajv<p>
+  <h1>Schema Utils</h1>
 </div>
 
 <h2 align="center">Install</h2>
 
 ```bash
-npm i schema-utils@latest
+npm install --save schema-utils
 ```
 
 <h2 align="center">Usage</h2>
 
-### Validate Options
+### `validateOptions`
+
+```js
+import validateOptions from 'schema-utils'
 
+validateOptions('path/to/schema.json', options, 'Loader/Plugin Name')
+```
 
 <h2 align="center">Examples</h2>
 
-```javascript
-const { validateSchema } = require('schema-utils');
+### Loader
 
-...
+```js
+import { getOptions } from 'loader-utils'
+import validateOptions from 'schema-utils'
 
-// This injects possible default values to options
-const validation = validateSchema(jsonSchema, options);
+function loader (src, map) {
+  const options = getOptions(this) || {}
 
-if(validation.isValid) {
-  throw new Error(validation.error);
+  validateOptions('path/to/schema.json', options, 'Loader Name')
 }
-
-// options are ok to use now
 ```
 
+### Plugin
+
+```js
+import Tapable from 'tapable'
+import validateOptions from 'schema-utils'
+
+class Plugin extends Tapable {
+  constructor (options) {
+    validateOptions('path/to/schema.json', options, 'Plugin Name')
+  }
+}
+```
 
 <h2 align="center">Maintainers</h2>
 
@@ -51,34 +69,41 @@ if(validation.isValid) {
     <tr>
       <td align="center">
         <img width="150" height="150"
-        src="https://avatars3.githubusercontent.com/u/166921?v=3&s=150">
+        src="https://github.com/bebraw.png?v=3&s=150">
         </br>
         <a href="https://github.com/bebraw">Juho Vepsäläinen</a>
       </td>
       <td align="center">
         <img width="150" height="150"
-        src="https://avatars2.githubusercontent.com/u/8420490?v=3&s=150">
+        src="https://github.com/d3viant0ne.png?v=3&s=150">
         </br>
         <a href="https://github.com/d3viant0ne">Joshua Wiens</a>
       </td>
+      <td align="center">
+        <img width="150" height="150"
+        src="https://github.com/michael-ciniawsky.png?v=3&s=150">
+        </br>
+        <a href="https://github.com/michael-ciniawsky">Michael Ciniawsky</a>
+      </td>
     </tr>
   <tbody>
 </table>
 
+
 [npm]: https://img.shields.io/npm/v/schema-utils.svg
 [npm-url]: https://npmjs.com/package/schema-utils
 
+[node]: https://img.shields.io/node/v/schema-utils.svg
+[node-url]: https://nodejs.org
+
 [deps]: https://david-dm.org/webpack-contrib/schema-utils.svg
 [deps-url]: https://david-dm.org/webpack-contrib/schema-utils
 
-[chat]: https://img.shields.io/badge/gitter-webpack%2Fwebpack-brightgreen.svg
-[chat-url]: https://gitter.im/webpack/webpack
-
 [test]: http://img.shields.io/travis/webpack-contrib/schema-utils.svg
 [test-url]: https://travis-ci.org/webpack-contrib/schema-utils
 
 [cover]: https://codecov.io/gh/webpack-contrib/schema-utils/branch/master/graph/badge.svg
 [cover-url]: https://codecov.io/gh/webpack-contrib/schema-utils
 
-[quality]: https://www.bithound.io/github/webpack-contrib/schema-utils/badges/score.svg
-[quality-url]: https://www.bithound.io/github/webpack-contrib/schema-utils
+[chat]: https://img.shields.io/badge/gitter-webpack%2Fwebpack-brightgreen.svg
+[chat-url]: https://gitter.im/webpack/webpack

lib/post_install.js

@@ -2,64 +2,60 @@
   "name": "schema-utils",
   "version": "0.2.1",
   "description": "Webpack Schema Validation Utilities",
-  "main": "dist/index.js",
+  "main": "dist/cjs.js",
   "files": [
-    "dist",
-    "lib",
-    "src",
-    ".babelrc"
+    "dist"
   ],
+  "engines": {
+    "node": ">= 4.3 < 5.0.0 || >= 5.10"
+  },
   "scripts": {
-    "prebuild": "yarn run clean:dist",
-    "build": "cross-env NODE_ENV=production babel -s true src -d dist --ignore 'src/**/*.test.js'",
-    "clean:dist": "del-cli dist",
-    "start": "yarn run serve:dev src",
-    "serve:dev": "nodemon $2 --exec babel-node",
+    "start": "yarn run build -- -w",
+    "prebuild": "yarn run clean",
+    "build": "cross-env NODE_ENV=production babel src -d dist --ignore 'src/**/*.test.js'",
+    "clean": "del-cli dist",
     "lint": "eslint --cache src test",
+    "lint-staged": "lint-staged",
     "security": "nsp check",
     "test": "jest",
+    "test:watch": "jest --watch",
     "test:coverage": "jest --collectCoverageFrom='src/**/*.js' --coverage",
-    "travis:test": "yarn run test",
     "travis:coverage": "yarn run test:coverage",
     "travis:lint": "yarn run lint && yarn run security",
+    "travis:test": "yarn run test",
     "webpack-defaults": "webpack-defaults",
-    "lint-staged": "lint-staged",
-    "postinstall": "node lib/post_install.js",
     "prepublish": "yarn run build",
     "release": "yarn run standard-version"
   },
   "dependencies": {
-    "ajv": "^4.11.2"
+    "ajv": "^5.0.0"
   },
   "devDependencies": {
-    "babel-cli": "^6.22.2",
-    "babel-jest": "^18.0.0",
-    "babel-polyfill": "^6.22.0",
-    "babel-preset-env": "^1.2.1",
+    "babel-cli": "^6.24.1",
+    "babel-jest": "^19.0.0",
+    "babel-plugin-transform-object-rest-spread": "^6.23.0",
+    "babel-polyfill": "^6.23.0",
+    "babel-preset-env": "^1.4.0",
     "babel-preset-webpack": "^1.0.0",
-    "chai": "^3.5.0",
-    "codecov": "^1.0.1",
-    "cross-env": "^3.1.4",
+    "codecov": "^2.0.1",
+    "cross-env": "^4.0.0",
     "del-cli": "^0.2.1",
-    "eslint": "^3.14.1",
-    "eslint-config-webpack": "^1.0.0",
+    "eslint": "^3.19.0",
+    "eslint-config-webpack": "^1.2.1",
     "eslint-plugin-import": "^2.2.0",
-    "greenkeeper-postpublish": "^1.0.1",
-    "jest": "^18.1.0",
-    "lint-staged": "^3.3.1",
-    "nodemon": "^1.11.0",
-    "nsp": "^2.6.2",
+    "jest": "^19.0.2",
+    "lint-staged": "^3.4.0",
+    "nsp": "^2.6.3",
     "pre-commit": "^1.2.2",
-    "shx": "^0.2.2",
     "standard-version": "^4.0.0",
-    "webpack-defaults": "^0.2.1"
-  },
-  "engines": {
-    "node": ">=4.3 <5.0.0 || >=5.10"
+    "webpack-defaults": "^0.4.5"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/webpack-contrib/schema-utils.git"
+  "pre-commit": "lint-staged",
+  "lint-staged": {
+    "*.js": [
+      "eslint --fix",
+      "git add"
+    ]
   },
   "eslintConfig": {
     "extends": "webpack",
@@ -77,18 +73,18 @@
     },
     {
       "name": "Joshua Wiens <@d3viant0ne>"
+    },
+    {
+      "name": "Michael Ciniawsky <@michael-ciniawsky>"
     }
   ],
-  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/webpack-contrib/schema-utils.git"
+  },
   "bugs": {
     "url": "https://github.com/webpack-contrib/schema-utils/issues"
   },
   "homepage": "https://github.com/webpack-contrib/schema-utils#readme",
-  "pre-commit": "lint-staged",
-  "lint-staged": {
-    "*.js": [
-      "eslint --fix",
-      "git add"
-    ]
-  }
+  "license": "MIT"
 }

logo.png

@@ -0,0 +1,18 @@
+class ValidationError extends Error {
+  constructor(err, name) {
+    super(err);
+
+    this.err = err;
+    this.stack = false;
+
+    this.message = `Validation Error\n\n${name || ''} Invalid Options\n\n`;
+
+    err.forEach((msg) => {
+      this.message += `options${msg.dataPath} ${msg.message}\n`;
+    });
+
+    return this;
+  }
+}
+
+export default ValidationError;

package.json

@@ -0,0 +1 @@
+module.exports = require('./index').default;

src/ValidationError.js

@@ -1,5 +1,3 @@
-import validateOptions from './lib/validate-options';
+import validateOptions from './validateOptions';
 
-export {
-  validateOptions, // eslint-disable-line import/prefer-default-export
-};
+export default validateOptions;