2024-04-22 14:20:12 +00:00
|
|
|
JSON schemas for Kometa YAML files
|
2024-01-02 22:09:29 +00:00
|
|
|
|
2024-04-29 19:22:16 +00:00
|
|
|
How to:
|
|
|
|
|
|
|
|
|
|
Add this as the first line in your `config.yml`:
|
|
|
|
|
```
|
|
|
|
|
# yaml-language-server: $schema=https://raw.githubusercontent.com/Kometa-Team/Kometa/nightly/json-schema/config-schema.json
|
|
|
|
|
```
|
|
|
|
|
[change `nightly` to `develop`, or `master` if you wish]
|
|
|
|
|
|
|
|
|
|
Then open your config file in an editor that supports the use of JSON schema.
|
|
|
|
|
|
|
|
|
|
For example, VS Code with the Red Hat YAML extension.
|
|
|
|
|
|
2024-05-01 16:17:46 +00:00
|
|
|
This will give you context-sensitive hints and auto-complete for much of the Kometa `config.yml`
|
2024-04-29 19:22:16 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2024-01-02 22:09:29 +00:00
|
|
|
limitations:
|
|
|
|
|
|
|
|
|
|
- template variables not cased for specific default file
|
|
|
|
|
- template variables with keys are wildcarded
|
|
|
|
|
- "position" attribute has no validation
|
|
|
|
|
- "streaming" default has no validation
|
|
|
|
|
- search has no validation; just accepts string
|
|
|
|
|
- schedule has no validation; just accepts string
|
|
|
|
|
|
|
|
|
|
TODO:
|
2024-01-03 16:03:55 +00:00
|
|
|
"list of coordinates"
|
2024-01-02 22:09:29 +00:00
|
|
|
|
|
|
|
|
- schema for collection yaml
|
|
|
|
|
- schema for metadata yaml
|
|
|
|
|
- schema for overlay yaml
|
|
|
|
|
- schema for template yaml
|
2024-01-03 16:03:55 +00:00
|
|
|
|
|
|
|
|
Notes:
|
