Přeskočit na obsah

npm run build:rules-catalog — Generátor katalogu pravidel

Generátor katalogu pravidel: Vytáhne pravidla, která brány doopravdy vynucují, z hlaviček samotných validátorů a postaví z nich katalog a stránku /pravidla/. npm skript, generování.

npm skript generování pipeline: build pipeline: dev

Volání

npm run build:rules-catalog

Spustí node scripts/dossier/build-rules-catalog.mjs (čteno z package.json při buildu)

Zdroj: scripts/dossier/build-rules-catalog.mjs

Vytáhne pravidla, která brány doopravdy vynucují, z hlaviček samotných validátorů a postaví z nich katalog a stránku /pravidla/. Dokumentace tak nemůže popisovat pravidlo, které žádný modul nevlastní.

Kdy ho spustit

V build i dev pipeline; ručně po změně hlavičky validátoru — jinak spadne verify:rules-catalog.

Co vynucuje

Nic — tenhle příkaz reportuje nebo generuje, ale sám o sobě nic neshazuje. Co selže při chybě, hlídají brány, které za ním v pipeline běží.

Co je potřeba vědět

  • Popis pravidla se nikdy nepíše do stránky ručně; jediným zdrojem je hlavička modulu, který pravidlo vynucuje.
  • Zápis je idempotentní: soubor se přepíše jen tehdy, když se obsah liší.

Vstupy a výstupy

Čte

  • scripts/data/validate-*.mjs
  • scripts/dossier/validate-*.mjs
  • scripts/lint/*.mjs

Zapisuje

  • data/generated/rules-catalog.json
  • content/pravidla/_index.md

Popis vychází z hlavičkového komentáře zdrojového souboru. Volání, zařazení do pipeline i členství v pre-commit hooku se dopočítávají při každém buildu ze samotného repozitáře.