Beyond validating YAML syntax in your IDE, you can validate the definition of an import configuration using the JSON schema https://raw.githubusercontent.com/le-phare/import/refs/heads/master/lephare-import.schema.json. You could also use a tagged version in case of future breaking changes.
This also provides contextual help for autocompletion and key hover.
Add this comment as the first line of your import configuration (useful if your IDE is compatible with YAML Language Server):
# yaml-language-server: $schema=https://raw.githubusercontent.com/le-phare/import/refs/heads/master/lephare-import.schema.json- Go to "Settings" > "Languages & Frameworks" > "Schemas and DTDs" > "JSON Schema Mappings".
- Click on "Add".
- Fill in the following:
- Name: Lephare Import
- Schema file or URL: the path to a local copy or the URL: lephare-import.schema.json.
- Version: JSON Schema 2020.12
- File pattern:
config/import/*.yaml. Adjust according to your Symfony architecture.
- Click on "OK".
- Install the YAML extension to enable YAML Language Server support;
- Optionally: to enable validation on all import files, add this JSON to the user settings file
settings.json:
"yaml.schemas": {
"https://raw.githubusercontent.com/le-phare/import/refs/heads/master/lephare-import.schema.json": "config/import/*.yaml"
}