Istanbul
Istanbul, a JavaScript code coverage tool
.nycrc.nycrc.json.nycrc.yaml.nycrc.yml
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
.nycrc and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
extends | string | Name of configuration to extend from. |
all | boolean | Whether or not to instrument all files (not just the ones touched by your test suite). default: false |
check-coverage | boolean | Check whether coverage is within thresholds, fail if not default: false |
extension | array<string> | List of extensions that nyc should attempt to handle in addition to .js default: [".js", ".cjs", ".mjs", ".ts", ".tsx", ".jsx"] |
include | array<string> | List of files to include for coverage. default: ["**"] |
exclude | array<string> | List of files to exclude for coverage. default: ["coverage/**"] |
reporter | array<string> | The names of custom reporter to show coverage results. default: ["text"] |
report-dir | string | Where to put the coverage report files. default: "./coverage" |
skip-full | boolean | Don't show files with 100% statement, branch, and function coverage default: false |
temp-dir | string | Directory to output raw coverage information to. default: "./.nyc_output" |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- 10 properties, 100% carrying a description, max nesting depth 4.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
default | JSON Schema Validation, draft 2020-12 | §9.2 — "default" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.