A pre-commit hook for validating files against jsonschemas.
Project description
check-jsonschema
A pre-commit hook for checking files against a JSONSchema, built using the python jsonschema package. The schema may be specified as a local or remote (HTTP or HTTPS) file.
Remote files are automatically downloaded and cached if possible.
Supported Hooks
The most generic hook is this one:
- check-jsonschema: Validate JSON or YAML files against a jsonschema on disk or fetched via HTTP(S)
These hooks check known files against schemas provided by Schemastore:
-
check-github-workflows: Validate GitHub Workflows in
.github/workflows/ -
check-github-actions: Validate GitHub Actions in
.github/actions/or theaction.ymlat the repo root -
check-travis: Validate Travis config
These hooks check known files against schemas provided by other sources:
- check-azure-pipelines: Validate Azure Pipelines config against the schema provided by Microsoft
Example Usage
Validate GitHub Workflows with Schemastore
You can use the schemastore github workflow schema to lint your GitHub workflow
files. All you need to add to your .pre-commit-config.yaml is this:
- repo: https://github.com/sirosen/check-jsonschema
rev: 0.5.0
hooks:
- id: check-github-workflows
Applying an arbitrary schema to files
There is a more general hook available for running any jsonschema against a file or set of files. For example, to implement the GitHub workflow check manually, you could do this:
- repo: https://github.com/sirosen/check-jsonschema
rev: 0.5.0
hooks:
- id: check-jsonschema
name: "Check GitHub Workflows"
language: python
files: ^\.github/workflows/
types: [yaml]
args: ["--schemafile", "https://json.schemastore.org/github-workflow"]
Standalone Usage
You can also pip install check-jsonschema to run the tool manually.
For full usage info:
check-jsonschema --help
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file check-jsonschema-0.5.1.tar.gz.
File metadata
- Download URL: check-jsonschema-0.5.1.tar.gz
- Upload date:
- Size: 6.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0efe577ed02d18e1145f4f7331d3e1fa4db78d107d179f6a6962eca214eda2b4 |
|
| MD5 | b34f55c40a1ad09ab19f4075a2c7275a |
|
| BLAKE2b-256 | 51e121f192fe7c2ca8ce3d78071c47d93026bd4998bc31b5e72b20df64c928d6 |
Provenance
File details
Details for the file check_jsonschema-0.5.1-py3-none-any.whl.
File metadata
- Download URL: check_jsonschema-0.5.1-py3-none-any.whl
- Upload date:
- Size: 7.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 18b07ebb756db3b214b31be2449e66c7380f714426efa85b9fd37f4014f4b8b4 |
|
| MD5 | 983477c96b94ba2cc9b8a502e53aba43 |
|
| BLAKE2b-256 | 6e3c1765b026defa76b954130bf2aa9be27fc8f308ad76843468698ea7342db5 |
