Pre-commit Hook

The validator has a ready-made pre-commit hook that validates config files on every commit.

Setup

Add to your .pre-commit-config.yaml:

repos:
  - repo: https://github.com/Boeing/config-file-validator
    rev: v2.2.0
    hooks:
      - id: config-file-validator

Two hooks are provided:

Hook	Behavior
`config-file-validator`	Validates only changed config files. Fast, intended for local development.
`config-file-validator-full`	Validates all config files in the repo. Intended for CI.

Add flags via the args key:

hooks:
  - id: config-file-validator
    args: ['--schemastore']

hooks:
  - id: config-file-validator
    args: ['--exclude-dirs=node_modules,vendor', '--schemastore']

The rev field should point to a release tag. Update it when you upgrade:

repos:
  - repo: https://github.com/Boeing/config-file-validator
    rev: v2.2.0
    hooks:
      - id: config-file-validator

Run pre-commit autoupdate to bump to the latest release automatically.