IDE Integration¶

VS Code YAML Schema Support¶

For autocomplete and validation in VS Code, install the YAML extension and add a schema reference to your config file.

Option 1: Inline comment¶

# yaml-language-server: $schema=https://raw.githubusercontent.com/anthony-spruyt/xfg/main/config-schema.json
files:
  my.config.json:
    content:
      key: value

repos:
  - git: git@github.com:org/repo.git

Option 2: VS Code settings¶

Add to .vscode/settings.json:

{
  "yaml.schemas": {
    "https://raw.githubusercontent.com/anthony-spruyt/xfg/main/config-schema.json": [
      "**/sync-config.yaml",
      "**/config-sync.yaml"
    ]
  }
}

What You Get¶

This enables:

Autocomplete for files, repos, content, mergeStrategy, git, override
Enum suggestions for mergeStrategy values (replace, append, prepend)
Validation of required fields
Hover documentation for each field