bash
npm i schema-utils
validateOptionsschema.json
js
{
"type": "object",
"properties": {
// Options...
},
"additionalProperties": false
}
schema.json
js
{
"type": "object",
"properties": {
"option": {
"type": [ "boolean" ]
}
},
// Overrides the default err.message for option
"errorMessage": {
"option": "should be {Boolean} (https:/github.com/org/repo#anchor)"
}
"additionalProperties": false
}
```js import schema from 'path/to/schema.json' import validateOptions from 'schema-utils'
validateOptions(schema, options, 'Loader/Plugin Name') ```
schema.json
json
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"test": {
"anyOf": [
{ "type": "array" },
{ "type": "string" },
{ "instanceof": "RegExp" }
]
},
"transform": {
"instanceof": "Function"
},
"sourceMap": {
"type": "boolean"
}
},
"additionalProperties": false
}
Loader```js import { getOptions } from 'loader-utils' import validateOptions from 'schema-utils'
import schema from 'path/to/schema.json'
function loader (src, map) { const options = getOptions(this) || {}
validateOptions(schema, options, 'Loader Name')
// Code... } ```
Plugin```js import validateOptions from 'schema-utils'
import schema from 'path/to/schema.json'
class Plugin { constructor (options) { validateOptions(schema, options, 'Plugin Name')
this.options = options
}
apply (compiler) { // Code... } } ```