@istanbuljs/schema
Advanced tools
Package description
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.
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);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 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.
Changelog
Readme
Schemas describing various structures used by nyc and istanbuljs
const {nyc} = require('@istanbuljs/schema').defaults;
console.log(`Default exclude list:\n\t* ${nyc.exclude.join('\n\t* ')}`);
FAQs
Schemas describing various structures used by nyc and istanbuljs
The npm package @istanbuljs/schema receives a total of 20,788,310 weekly downloads. As such, @istanbuljs/schema popularity was classified as popular.
We found that @istanbuljs/schema demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.