coderabbit-yaml-valid

.coderabbit.yaml must be valid YAML

Severity	error (auto)
Autofix	-
Since	v0.1.0
Repo Types	coderabbit
Category	CodeRabbit

Why

.coderabbit.yaml configures CodeRabbit's review behavior, including custom instructions that are fed to the LLM. Invalid YAML means the entire configuration is ignored and CodeRabbit falls back to defaults — your custom review instructions and path-specific rules are silently lost.

Examples

Bad:

reviews:
  instructions: "Be strict
    about error handling

Good:

reviews:
  instructions: |
    Be strict about error handling.
    Flag any function that swallows exceptions.

How to fix

Fix the YAML syntax error at the line reported in the violation. Common issues: unquoted strings with special characters, incorrect indentation, and missing closing quotes. Use a YAML linter or validator to check the file before committing.

Configuration

rules:
  coderabbit-yaml-valid:
    enabled: auto  # true | false | auto
    severity: error

Run skillsaw explain coderabbit-yaml-valid to see this documentation and the rule's effective configuration in your terminal.