Webpack Schema Validation Utilities
npm install @webpack-contrib/schema-utils[![npm][npm]][npm-url]
[![node][node]][node-url]
[![deps][deps]][deps-url]
[![tests][tests]][tests-url]
[![chat][chat]][chat-url]
Webpack Schema Validation Utilities
Validates options objects against a JSON Schema and
displays the output beautifully.
src="https://cdn.rawgit.com/webpack-contrib/schema-utils/master/.github/pretty.png">
This module requires a minimum of Node v6.9.0 and Webpack v4.0.0.
To begin, you'll need to install schema-utils:
``console`
$ npm install @webpack-contrib/schema-utils --save-dev
When using the API directly, the main entry point is the serve function, which
is the default export of the module.
`js
const validate = require('@webpack-contrib/schema-utils');
const schema = require('path/to/schema.json');
const target = { ... }; // the options object to validate
const name = '...'; // the load or plugin name validate() is being used in
validate({ name, schema, target });
`
Returns true if validation succeeded, false validation failed and options
allow the function to return a value. (see options below).
Type: Object
Options for initializing and controlling the server provided. The option names
listed below belong to the options object.
#### exit
Type: Booleanfalse
Default:
If true, will instruct the validator to end the process with an error code of1.
#### log
Type: Booleanfalse
Default:
If true, will instruct the validator to log the results of the validation (inthrow: false
the event of a failure) in a
webpack-style log output. This
is typically used with .
src="https://cdn.rawgit.com/webpack-contrib/schema-utils/master/.github/output-log-true.png">
#### name
Type: Stringundefined
Default:
_Required_
A String specifying the name of the loader or plugin utilizing the validator.
#### schema
Type: String|Objectundefined
Default:
_Required_
A String specifying the filesystem path to the schema used for validation.object
Alternatively, you may specify an containing the JSON-parsed schema.
#### target
Type: Objectundefined
Default:
_Required_
An Object containing the options to validate against the specified schema.
#### throw
Type: Booleantrue
Default:
By default the validator will throw an error and display validation results upon
failure. If this option is set to false, the validator will not throw an error.false
This is typically used in situations where a return value of forvalidate() is sufficient, a stack trace is uneeded, or when
webpack-style log output is
preferred.
src="https://cdn.rawgit.com/webpack-contrib/schema-utils/master/.github/output-throws-true.png">
Below is a basic example of how this validator might be used:
`json`schema.json
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"test": {
"anyOf": [
{ "type": "array" },
{ "type": "string" },
{ "instanceof": "RegExp" }
]
},
"transform": {
"instanceof": "Function"
},
"sourceMap": {
"type": "boolean"
}
},
"additionalProperties": false
}
`js
const { getOptions } = require('loader-utils');
const validate = require('@webpack-contrib/schema-utils');
import schema from 'path/to/schema.json'
function loader (src, map) {
const options = getOptions(this) || {};
validate({ name: 'Loader Name', schema, target: options });
// Code...
}
`
`js
const validate = require('@webpack-contrib/schema-utils');
const schema = require('path/to/schema.json');
class Plugin {
constructor (options) {
validate({ name: 'Plugin Name', schema, target: options });
this.options = options;
}
apply (compiler) {
// Code...
}
}
``
#### MIT
[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
[tests]: https://img.shields.io/circleci/project/github/webpack-contrib/schema-utils.svg
[tests-url]: https://circleci.com/gh/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
[chat]: https://img.shields.io/badge/gitter-webpack%2Fwebpack-brightgreen.svg
[chat-url]: https://gitter.im/webpack/webpack