Skip to content

Validation

Syclops generates a YAML schema that defines the job configuration rules. This schema can be used for auto-completion and linting, but also to get more information about a specific property.

During asset crawling, Syclops looks for all schema files of the plugins and creates a single schema.yaml in the install folder. In order to use the linting features for the job descriptions, the IDE has to be pointed towards the schema file.

Linting
Linting of job description

For Visual Studio Code, the YAML extension needs to be installed. In the VSCode settings.json, the following entry has to be set. This will apply the schema to all YAML files ending with syclops.yaml. 

  "yaml.schemas": {
    "<path/to/schema.yaml>": "*syclops.yaml"
  },