Skip to content

pre-commit hooks for jsonschema validation with built-in support for checking GitHub Actions workflows

License

Notifications You must be signed in to change notification settings

cbsi-dto/pre-commit-jsonschema

 
 

Repository files navigation

pypi version supported pythons build pre-commit.ci status readthedocs documentation

check-jsonschema

A JSON Schema CLI and pre-commit hook built on jsonschema. The schema may be specified as a local or remote (HTTP or HTTPS) file.

Remote files are automatically downloaded and cached if possible.

Usage

check-jsonschema can be installed and run as a CLI tool, or via pre-commit.

Example pre-commit config

The following configuration uses check-jsonschema to validate Github Workflow files.

- repo: https://github.com/python-jsonschema/check-jsonschema
  rev: 0.30.0
  hooks:
    - id: check-github-workflows
      args: ["--verbose"]

Installing and Running as a CLI Tool

Install with pipx or brew:

pipx install check-jsonschema

or

brew install check-jsonschema

Then run, as in

check-jsonschema --schemafile schema.json instance.json

Documentation

Full documentation can be found at https://check-jsonschema.readthedocs.io/

About

pre-commit hooks for jsonschema validation with built-in support for checking GitHub Actions workflows

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.7%
  • Makefile 0.3%