src="https://cdn.rawgit.com/webpack-contrib/schema-utils/master/.github/json-schema-logo.svg">

[![npm][npm]][npm-url]
[![node][node]][node-url]
[![deps][deps]][deps-url]
[![tests][tests]][tests-url]
[![chat][chat]][chat-url]

schema-utils

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">

Requirements

This module requires a minimum of Node v6.9.0 and Webpack v4.0.0.

Getting Started

To begin, you'll need to install schema-utils:

``console
$ npm install @webpack-contrib/schema-utils --save-dev
`

API

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 });
`

$3

Returns true if validation succeeded, false validation failed and options
allow the function to return a value. (see options below).

$3

Type: Object

Options for initializing and controlling the server provided. The option names
listed below belong to the options object.

#### exit

Type: Boolean
Default: false

If true, will instruct the validator to end the process with an error code of
1.

#### log

Type: Boolean
Default: false

If true, will instruct the validator to log the results of the validation (in
the event of a failure) in a
webpack-style log output. This
is typically used with throw: false.

src="https://cdn.rawgit.com/webpack-contrib/schema-utils/master/.github/output-log-true.png">

#### name

Type: String
Default: undefined
_Required_

A String specifying the name of the loader or plugin utilizing the validator.

#### schema

Type: String|Object
Default: undefined
_Required_

A String specifying the filesystem path to the schema used for validation.
Alternatively, you may specify an object containing the JSON-parsed schema.

#### target

Type: Object
Default: undefined
_Required_

An Object containing the options to validate against the specified schema.

#### throw

Type: Boolean
Default: true

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.
This is typically used in situations where a return value of false for
validate() 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">

Examples

Below is a basic example of how this validator might be used:

`json


schema.json

`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...
}
`

$3

`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...
}
}
``

License

#### 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