feat(config): add YAML schema hints for editors

gildesmarais · gildesmarais · commit 8a67725a69d5 · 2026-03-10T18:24:26.000+01:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,5 @@
+{
+  "yaml.schemas": {
+    "https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json": "lib/html2rss/configs/**/*.yml"
+  }
+}
diff --git a/README.md b/README.md
@@ -71,6 +71,25 @@ make test-domain DOMAIN=github.com
 
 **Config folder convention**: Place configs under the registrable domain folder (e.g., `example.com/` or `bbc.co.uk/`). Legacy subdomain folders (e.g., `news.example.com/`) are allowed but not preferred.
 
+## Editor Setup (JSON Schema)
+
+Get inline validation and autocompletion when editing configs in your IDE.
+All config files already carry the schema modeline at the top:
+
+```yaml
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
+```
+
+Any editor with [yaml-language-server](https://github.com/redhat-developer/yaml-language-server)
+support (VS Code + [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml),
+Neovim, Helix, …) will automatically pick up the schema when opening a config file.
+
+The included `.vscode/settings.json` additionally associates the schema with all
+configs via a glob pattern, so new files get validation before the modeline is added.
+
+> `make schema` writes `schema/html2rss-config.schema.json` locally — useful for
+> offline editing or when you want to pin against the currently installed gem version.
+
 ## Documentation
 
 - [Main Documentation](https://html2rss.github.io/html2rss-configs/)
diff --git a/lib/html2rss/configs/adfc.de/pressemitteilungen.yml b/lib/html2rss/configs/adfc.de/pressemitteilungen.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://www.adfc.de/presse/pressemitteilungen/
   time_zone: Europe/Berlin
diff --git a/lib/html2rss/configs/apnews.com/hub.yml b/lib/html2rss/configs/apnews.com/hub.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 ---
 parameters:
   section:
diff --git a/lib/html2rss/configs/avherald.com/index.yml b/lib/html2rss/configs/avherald.com/index.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 ---
 channel:
   url: https://avherald.com/
diff --git a/lib/html2rss/configs/bbc.co.uk/available_episodes.yml b/lib/html2rss/configs/bbc.co.uk/available_episodes.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 parameters:
   id:
     type: string
diff --git a/lib/html2rss/configs/bbc.com/mundo.yml b/lib/html2rss/configs/bbc.com/mundo.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 ---
 channel:
   url: https://www.bbc.com/mundo
diff --git a/lib/html2rss/configs/blog.mondediplo.net/feed.yml b/lib/html2rss/configs/blog.mondediplo.net/feed.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 parameters:
   blog:
     type: string
diff --git a/lib/html2rss/configs/canarianweekly.com/front.yml b/lib/html2rss/configs/canarianweekly.com/front.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://www.canarianweekly.com/
   time_zone: Europe/London
diff --git a/lib/html2rss/configs/cinemascore.com/index.yml b/lib/html2rss/configs/cinemascore.com/index.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://webapp.cinemascore.com/guest/surveys
   ttl: 720
diff --git a/lib/html2rss/configs/cleanenergywire.org/news.yml b/lib/html2rss/configs/cleanenergywire.org/news.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://www.cleanenergywire.org/news-archive
   time_zone: "Europe/Berlin"
diff --git a/lib/html2rss/configs/cnet.com/section_sub.yml b/lib/html2rss/configs/cnet.com/section_sub.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 ---
 parameters:
   section:
diff --git a/lib/html2rss/configs/computerbase.de/meistgelesen.yml b/lib/html2rss/configs/computerbase.de/meistgelesen.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   title: "computerbase.de: meistgelesen"
   url: https://www.computerbase.de
diff --git a/lib/html2rss/configs/cutle.fish/index.yml b/lib/html2rss/configs/cutle.fish/index.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 ---
 channel:
   url: https://cutle.fish/
diff --git a/lib/html2rss/configs/deraktionaer.de/meistgelesen.yml b/lib/html2rss/configs/deraktionaer.de/meistgelesen.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   title: "deraktionaer.de: meistgelesen"
   url: https://deraktionaer.de/
diff --git a/lib/html2rss/configs/developer.apple.com/tutorials_data_documentation_technotes_json.yml b/lib/html2rss/configs/developer.apple.com/tutorials_data_documentation_technotes_json.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 ---
 channel:
   json: true
diff --git a/lib/html2rss/configs/dfs.de/pressemitteilungen.yml b/lib/html2rss/configs/dfs.de/pressemitteilungen.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://www.dfs.de/homepage/de/medien/presse/
   time_zone: Europe/Berlin
diff --git a/lib/html2rss/configs/dsw-info.de/presse.yml b/lib/html2rss/configs/dsw-info.de/presse.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://www.dsw-info.de/presse
   time_zone: Europe/Berlin
diff --git a/lib/html2rss/configs/espn.com/f1.yml b/lib/html2rss/configs/espn.com/f1.yml
@@ -1,9 +1,12 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
+strategy: default
 channel:
   url: https://www.espn.com/f1/
   time_zone: UTC
   ttl: 60
 selectors:
   items:
+    s: 'dfd'
     selector: ".headlineStack__list > li"
   title:
     selector: "a"
diff --git a/lib/html2rss/configs/fia.com/documents.yml b/lib/html2rss/configs/fia.com/documents.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 ---
 channel:
   url: https://www.fia.com/documents/championships/fia-formula-one-world-championship-14/season/season-2026-2072
diff --git a/lib/html2rss/configs/formula1.com/latest.yml b/lib/html2rss/configs/formula1.com/latest.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://www.formula1.com/en/latest/all.html
   time_zone: UTC
diff --git a/lib/html2rss/configs/github.com/releases.yml b/lib/html2rss/configs/github.com/releases.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 parameters:
   username:
     type: string
diff --git a/lib/html2rss/configs/iaapa.org/news.yml b/lib/html2rss/configs/iaapa.org/news.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://www.iaapa.org/news
   time_zone: UTC
diff --git a/lib/html2rss/configs/imdb.com/ratings.yml b/lib/html2rss/configs/imdb.com/ratings.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 parameters:
   user_id:
     type: string
diff --git a/lib/html2rss/configs/ingenieur.de/karriere_arbeitsleben_heiko_mell.yml b/lib/html2rss/configs/ingenieur.de/karriere_arbeitsleben_heiko_mell.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 ---
 channel:
   url: https://www.ingenieur.de/karriere/arbeitsleben/heiko-mell/
diff --git a/lib/html2rss/configs/kinocheck.de/filmstarts.yml b/lib/html2rss/configs/kinocheck.de/filmstarts.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://kinocheck.de/filmstarts
   time_zone: Europe/Berlin
diff --git a/lib/html2rss/configs/microsoft.com/azure-products.yml b/lib/html2rss/configs/microsoft.com/azure-products.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://azure.microsoft.com/en-us/products
   language: en
diff --git a/lib/html2rss/configs/newyorker.com/magazine.yml b/lib/html2rss/configs/newyorker.com/magazine.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 ---
 channel:
   url: https://www.newyorker.com/magazine
diff --git a/lib/html2rss/configs/nomanssky.com/news.yml b/lib/html2rss/configs/nomanssky.com/news.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 ---
 channel:
   url: https://www.nomanssky.com/news/
diff --git a/lib/html2rss/configs/pankow.lebensmittel-kontrollergebnisse.de/search.yml b/lib/html2rss/configs/pankow.lebensmittel-kontrollergebnisse.de/search.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 ---
 channel:
   url: https://pankow.lebensmittel-kontrollergebnisse.de/Search
diff --git a/lib/html2rss/configs/phys.org/weekly.yml b/lib/html2rss/configs/phys.org/weekly.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://phys.org/weekly-news/
   time_zone: Europe/London
diff --git a/lib/html2rss/configs/rbb24.de/meistgeklickt.yml b/lib/html2rss/configs/rbb24.de/meistgeklickt.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   title: "rbb24.de: meistgeklickt"
   url: https://rbb24.de/
diff --git a/lib/html2rss/configs/robinwood.de/aktuelles.yml b/lib/html2rss/configs/robinwood.de/aktuelles.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://www.robinwood.de/was-gibt-es-neues/aktuelles
   time_zone: Europe/Berlin
diff --git a/lib/html2rss/configs/s3.amazonaws.com/popular_movies.yml b/lib/html2rss/configs/s3.amazonaws.com/popular_movies.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 # This generates a RSS of the daily updated
 # https://github.com/sjlu/popular-movies
 channel:
diff --git a/lib/html2rss/configs/sebastianvettel.de/news.yml b/lib/html2rss/configs/sebastianvettel.de/news.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 ---
 channel:
   url: https://sebastianvettel.de/news/
diff --git a/lib/html2rss/configs/softwareleadweekly.com/issues.yml b/lib/html2rss/configs/softwareleadweekly.com/issues.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://softwareleadweekly.com/issues
   time_zone: UTC
diff --git a/lib/html2rss/configs/solarthermalworld.org/news.yml b/lib/html2rss/configs/solarthermalworld.org/news.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://solarthermalworld.org/news
   time_zone: UTC
diff --git a/lib/html2rss/configs/spektrum.de/meistgelesen.yml b/lib/html2rss/configs/spektrum.de/meistgelesen.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   title: "spektrum.de: meistgelesen"
   url: https://www.spektrum.de/
diff --git a/lib/html2rss/configs/spiegel.de/impressum_autor.yml b/lib/html2rss/configs/spiegel.de/impressum_autor.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 parameters:
   id:
     type: string
diff --git a/lib/html2rss/configs/stackoverflow.com/hot_network_questions.yml b/lib/html2rss/configs/stackoverflow.com/hot_network_questions.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   title: "stackoverflow.com: Hot Network Questions"
   url: https://stackoverflow.com/questions
diff --git a/lib/html2rss/configs/steuerzahler.de/news.yml b/lib/html2rss/configs/steuerzahler.de/news.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://www.steuerzahler.de/news
   time_zone: Europe/Berlin
diff --git a/lib/html2rss/configs/stripes.com/index.yml b/lib/html2rss/configs/stripes.com/index.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 ---
 channel:
   url: https://www.stripes.com/
diff --git a/lib/html2rss/configs/support.apple.com/en_gb_ht201222.yml b/lib/html2rss/configs/support.apple.com/en_gb_ht201222.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 ---
 channel:
   url: https://support.apple.com/en-gb/HT201222
diff --git a/lib/html2rss/configs/support.apple.com/exchange_repair.yml b/lib/html2rss/configs/support.apple.com/exchange_repair.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://support.apple.com/exchange_repair
   time_zone: America/Los_Angeles
diff --git a/lib/html2rss/configs/teneriffa-news.com/news.yml b/lib/html2rss/configs/teneriffa-news.com/news.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://www.teneriffa-news.com/news
   time_zone: "Europe/Lisbon"
diff --git a/lib/html2rss/configs/test.de/archiv.yml b/lib/html2rss/configs/test.de/archiv.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 ---
 channel:
   url: https://www.test.de/archiv/
diff --git a/lib/html2rss/configs/theguardian.com/international_mostpopular.yml b/lib/html2rss/configs/theguardian.com/international_mostpopular.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   title: "theguardian.com: International most popular"
   url: https://www.theguardian.com/international
diff --git a/lib/html2rss/configs/thoughtworks.com/insights.yml b/lib/html2rss/configs/thoughtworks.com/insights.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://www.thoughtworks.com/insights
   language: en
diff --git a/lib/html2rss/configs/tourismusnetzwerk-brandenburg.de/aktuelle_nachrichten.yml b/lib/html2rss/configs/tourismusnetzwerk-brandenburg.de/aktuelle_nachrichten.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 channel:
   url: https://www.tourismusnetzwerk-brandenburg.de/nc/aktuelle-nachrichten/
   time_zone: Europe/Berlin
diff --git a/lib/html2rss/configs/webentwickler-jobs.de/in.yml b/lib/html2rss/configs/webentwickler-jobs.de/in.yml
@@ -1,3 +1,4 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json
 ---
 parameters:
   region:

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  "yaml.schemas": {
 +    "https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json": "lib/html2rss/configs/**/*.yml"
 +  }
 +}
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json`
`1`	`2`	`channel:`
`2`	`3`	`url: https://www.adfc.de/presse/pressemitteilungen/`
`3`	`4`	`time_zone: Europe/Berlin`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# yaml-language-server: $schema=https://raw.githubusercontent.com/html2rss/html2rss/refs/heads/master/schema/html2rss-config.schema.json`
`1`	`2`	`---`
`2`	`3`	`parameters:`
`3`	`4`	`section:`