https://github.com/alenkacz/gradle-json-validator

Gradle plugin for json validation
https://github.com/alenkacz/gradle-json-validator

gradle json-schema json-schema-validator json-validation

Last synced: about 4 hours ago
JSON representation

Gradle plugin for json validation

• Host: GitHub
• URL: https://github.com/alenkacz/gradle-json-validator
• Owner: alenkacz
• License: mit
• Created: 2016-01-16T11:25:09.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2021-12-19T08:31:12.000Z (almost 3 years ago)
• Last Synced: 2023-03-12T07:37:14.317Z (over 1 year ago)
• Topics: gradle, json-schema, json-schema-validator, json-validation
• Language: Groovy
• Size: 110 KB
• Stars: 10
• Watchers: 2
• Forks: 9
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gradle-json-validator

[![Build Status](https://travis-ci.org/alenkacz/gradle-json-validator.svg)](https://travis-ci.org/alenkacz/gradle-json-validator) [ ![Download](https://api.bintray.com/packages/alenkacz/maven/gradle-json-validator/images/download.svg) ](https://bintray.com/alenkacz/maven/gradle-json-validator/_latestVersion)

Provides json validation as a part of your gradle build pipeline.

This plugin implements a custom task type, [ValidateJsonTask](https://github.com/alenkacz/gradle-json-validator/blob/master/src/main/groovy/cz/alenkacz/gradle/jsonvalidator/ValidateJsonTask.groovy). This task expects two properties - *targetJsonFile* and *jsonSchemaFile* (instead of *targetJsonFile* you can use *targetJsonDirectory* and then all files in that directory will be validated). If that directory contains both json and non-json files, the task will fail for non-json files. If you want to validate only files with .json extension use the `onlyWithJsonExtension` property. If you need to validate more jsons as a part of one build, you will have to create as many custom tasks as the number of json schema files (see *validateCustomJson* in the example below).

Usage

====================

	buildscript {

		repositories {

			jcenter()

		}

		dependencies {

			classpath 'cz.alenkacz.gradle:json-validator:FILL_VERSION_HERE'

		}

	}

	apply plugin: 'json-validator'

	

    import cz.alenkacz.gradle.jsonvalidator.ValidateJsonTask

    

    task validateCustomJson(type: ValidateJsonTask) {

      targetJsonFile = file("target.json") // only one of targetJsonFile or targetJsonDirectory can be specified 

      targetJsonDirectory = file("directoryWithJsons") // only one of targetJsonFile or targetJsonDirectory can be specified

      jsonSchema = file("schema.json")

      onlyWithJsonExtension = true // default is false, this makes sense only when using targetJsonDirectory, it ignores all files apart from those who do not have .json file extension

    }

JSON schema syntax check

====================

For some build pipelines it might be useful to be able to check schema files for syntax errors as a part of the build. To make that work, use the following setup and run the task **validateJsonSchema**:

	buildscript {

		repositories {

			jcenter()

		}

		dependencies {

			classpath 'cz.alenkacz.gradle:json-validator:FILL_VERSION_HERE'

		}

	}

	apply plugin: 'json-validator'

	

    jsonSchema {

        schemaFolder = PATH_TO_YOUR_FOLDER_WITH_JSON_SCHEMAS

    }