Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Yq Processor

Purpose

Validates YAML files using yq.

The Rust alternative is iyq: YAML read in-process and the jq filter evaluated with jaq, the same files passing and failing. Switching is yq → iyq in the stanza header, with args = ["FILTER"] → filter = "FILTER".

How It Works

Discovers .yml and .yaml files in the project (excluding common build tool directories), runs yq . on each file to validate syntax, and records success in the cache. A non-zero exit code from yq fails the product.

This processor supports batch mode.

Source Files

  • Input: **/*.yml, **/*.yaml
  • Output: none (checker)

Configuration

[processor.checker.yq]
args = []
dep_inputs = []
KeyTypeDefaultDescription
argsstring[][]Extra arguments passed to yq
dep_inputsstring[][]Extra files whose changes trigger rebuilds

Batch support

The tool accepts multiple files on the command line. When batching is enabled (default), rsconstruct passes all files in a single invocation for better performance.

Clean behavior

This processor is a Checker — rsconstruct clean outputs is a no-op for it (checkers produce no outputs). See Clean behavior and rsconstruct clean.