Skip to main content

Introduction

Config File Validator validates config files across 16 formats.

It recursively searches directories for config files, detects their format by extension or filename, and reports errors.

Supported formats​

Syntax + Schema: JSON JSONC YAML TOML XML TOON SARIF

Syntax: HCL INI HOCON ENV CSV Properties EDITORCONFIG Justfile PList

When to use it​

  • CI pipelines — a GitHub Action posts validation results as PR comments with inline annotations. For other CI systems, use JSON, JUnit, or SARIF output.
  • Pre-commit hooks — a ready-made pre-commit hook validates changed config files on every commit. No setup beyond adding the hook.
  • Monorepos — validates all config formats in a single pass. No per-format tooling to install or maintain.
  • Schema enforcement — go beyond syntax checking. Require that config files declare and conform to a schema. Catch wrong field names, invalid values, and missing required keys — not just malformed syntax.

Next steps​

  • Installation — install via Homebrew, Winget, go install, or binary download
  • Quick Start — validate your first directory in under a minute