@istanbuljs/schema

What is @istanbuljs/schema?

The @istanbuljs/schema package provides JSON schemas for the configuration options of various IstanbulJS libraries. These schemas are used to validate and document the expected format and types of configuration objects. This can be particularly useful for developers integrating IstanbulJS tools into their projects, ensuring they configure the tools correctly according to the schema definitions.

What are @istanbuljs/schema's main functionalities?

Validation of nyc configuration

This code sample demonstrates how to use the @istanbuljs/schema package to validate an nyc configuration object. It uses the Ajv library to compile and validate the configuration against the schema.

const Ajv = require('ajv');
const ajv = new Ajv();
const nycConfigSchema = require('@istanbuljs/schema').nycConfig;
const validate = ajv.compile(nycConfigSchema);
const valid = validate({
  'check-coverage': true,
  'per-file': true,
  lines: 90,
  functions: 90,
  branches: 90,
  statements: 90
});
if (!valid) console.log(validate.errors);

Other packages similar to @istanbuljs/schema

joi

Joi is a powerful schema description language and data validator for JavaScript. Unlike @istanbuljs/schema, which is specific to IstanbulJS configuration schemas, Joi allows developers to define custom schemas for any purpose, making it more flexible for various validation needs.

yup

Yup is another JavaScript schema builder for value parsing and validation. Similar to Joi, Yup provides a way to construct schemas for various types of data. It is often used in form validation. Compared to @istanbuljs/schema, Yup offers more general-purpose functionality rather than being tailored to a specific library's configuration.

README

@istanbuljs/schema

Schemas describing various structures used by nyc and istanbuljs

Usage

const {nyc} = require('@istanbuljs/schema').defaults;

console.log(`Default exclude list:\n\t* ${nyc.exclude.join('\n\t* ')}`);

@istanbuljs/schema for enterprise

Available as part of the Tidelift Subscription.

The maintainers of @istanbuljs/schema and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.