schema-utils

Validation of options

This feature allows users to validate an options object against a predefined JSON Schema. The 'validate' function takes a schema, options, and a configuration object that includes the name of the plugin or loader using the validation.

const { validate } = require('schema-utils');
const schema = {
  type: 'object',
  properties: {
    name: {
      type: 'string'
    }
  },
  required: ['name']
};
const options = { name: 'Example' };
validate(schema, options, { name: 'MyPlugin' });

Custom error messages

This feature allows users to provide custom error messages in the schema that will be displayed when validation fails. The 'validate' function will throw an error with these messages if the options do not match the schema.

const { validate } = require('schema-utils');
const schema = {
  type: 'object',
  properties: {
    age: {
      type: 'number',
      description: 'Age must be a number'
    }
  },
  required: ['age']
};
const options = { age: 'old' };
try {
  validate(schema, options, { name: 'AgeChecker' });
} catch (error) {
  // Custom error handling
}