# gulp-json-schema > gulp plugin for validating JSON files with JSON Schema Latest version **1.0.0** (published 2016-05-11) · MIT license · 0 weekly downloads ## Install ```sh npm install gulp-json-schema pnpm add gulp-json-schema yarn add gulp-json-schema bun add gulp-json-schema ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.0 | | Published | 2016-05-11 | | First published | 2016-05-11 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 8 | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 3 | | Author | IRIDE Monad | | Maintainers | io-monad | | Keywords | gulpplugin, json, jsonschema, schema, validation | ## Links - npm: https://www.npmjs.com/package/gulp-json-schema - Repository: https://github.com/io-monad/gulp-json-schema - Issues: https://github.com/io-monad/gulp-json-schema/issues - npm.io page: https://npm.io/package/gulp-json-schema ## Dependencies (8) - [tv4](https://npm.io/package/tv4.md) ^1.2.7 - [figures](https://npm.io/package/figures.md) ^1.5.0 - [request](https://npm.io/package/request.md) ^2.72.0 - [through2](https://npm.io/package/through2.md) * - [gulp-util](https://npm.io/package/gulp-util.md) * - [strip-bom](https://npm.io/package/strip-bom.md) ^3.0.0 - [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.6.1 - [normalize-url](https://npm.io/package/normalize-url.md) ^1.5.2 ## Alternatives - [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads - [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads - [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads - [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads - [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads ## Recent versions - 1.0.0 (latest) — 2016-05-11 ## README # gulp-json-schema [![wercker status](https://app.wercker.com/status/c0c9b2e96eadc1474475a40ff1f7aa0a/s/master "wercker status")](https://app.wercker.com/project/bykey/c0c9b2e96eadc1474475a40ff1f7aa0a) gulp plugin for validating JSON files with [JSON Schema](http://json-schema.org/) Currently using [tv4](https://github.com/geraintluff/tv4) as a backend for JSON schema validation, which supports [draft v4 specification](https://tools.ietf.org/html/draft-zyp-json-schema-04). ## Install npm install --save-dev gulp-json-schema ## Usage In your gulpfile: ```js var gulp = require("gulp"); var jsonSchema = require("gulp-json-schema"); gulp.task("validate", () => { return gulp.src("data/**/*.json") .pipe(jsonSchema("schema.json")); }); ``` And `gulp validate` will validate all JSON files in `data` directory with `schema.json`. If validation failed, it will emit an error, which means gulp to stop running. If you want to change this behavior, set `emitError` option to `false`. ### Options Options can be passed as a second argument, or a first argument with `schema` property of a schema file path. ```js jsonSchema("schema.json", { /* Options */ }) jsonSchema({ schema: "schema.json", /* Options */ }) ``` | Key | Description | Default | | --- | ----------- | ------- | | `schema` | Schema file path, or schema object | None | | `schemas` | Schemas to be preloaded for resolving `$ref`
This can be an array of schema object
`[{ "$id": "..." }, { "$id": "..." }]`
or an array of schema file paths
`["schema-a.json", "schema-b.json"]`
or a mapping Object with URI keys and schema object values
`{ "http://...": {}, "http://...": {} }`
See [tv4.addSchema](https://github.com/geraintluff/tv4#addschemauri-schema) for details. | `null` | | `formats` | Custom format validators
A mapping Object with format name keys and validator function values.
`{ "my-format": function () { ... } }`
See [tv4.addFormat](https://github.com/geraintluff/tv4#addformatformat-validationfunction) for details. | `null` | | `keywords` | Custom keyword validators
A mapping Object with keyword keys and validator function values.
`{ "my-keyword": function () { ... } }`
See [tv4.defineKeyword](https://github.com/geraintluff/tv4#definekeywordkeyword-validationfunction) for details. | `null` | | `configure` | Function called with a tv4 instance on initialization.
You can use this function to customize tv4 settings. | `null` | | `loadMissingSchemas` | If set to `true`, it will automatically fetch missing schemas (`$ref` that cannot be resolved) from remote server with HTTP request. | `false` | | `requestOptions` | Options for [request](https://github.com/request/request) for fetching remote schema. | `{}` | | `checkRecursive` | If set to `true`, tv4 will handle self-referencing objects properly (slows down validation)
See [tv4 article about this option](https://github.com/geraintluff/tv4#cyclical-javascript-objects). | `false` | | `banUnknownProperties` | If set to `true`, any unknown property causes validation to fail.
See [tv4 article about this option](https://github.com/geraintluff/tv4#the-banunknownproperties-flag). | `false` | | `silent` | If set to `true`, it will never output logs to console. | `false` | | `verbose` | If set to `true`, it will also report valid files. | `false` | | `missing` | If set to `"error"` (default), missing schema (`$ref` that cannot be resolved) causes validation to fail.
If set to `"warn"`, missing schema will be reported as warning, but it won't fail validation.
If set to `"ignore"`, missing schema will never be reported. | `"error"` | | `emitError` | If set to `false`, it doesn't emit an error for failed validation. (gulp will continue to run tasks) | `true` | ## Build To transpile source files into `lib` npm run build To watch file changes npm run build -- --watch ## Testing npm test ## Contributing 1. Fork it! 2. Create your feature branch: `git checkout -b my-new-feature` 3. Commit your changes: `git commit -am 'Add some feature'` 4. Push to the branch: `git push origin my-new-feature` 5. Submit a pull request :D ## License [The MIT License](LICENSE) --- _Source: https://npm.io/package/gulp-json-schema · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._