contentlayerdev / contentlayerdev/contentlayer
Runtime config / schema validation
- Vorherrschende Sprache
- TypeScript
- Sterne
- 3.5k
- Forks
- 192
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
Some users (typically users who don't yet use TypeScript) are running into problems due to misconfigurations of their Contentlayer config (especially in regards to the content schema). Additionally to the safety provided by TypeScript, we should also implement a runtime validation step to avoid undefined runtime errors.
## Technical notes
Ideally we should figure out a way how to derive [Zod](https://github.com/colinhacks/zod)-like validation logic based on the existing TypeScript definitions. We could also investigate to use [TS+](https://github.com/ts-plus) for this.
## Related issues
- https://github.com/contentlayerdev/contentlayer/issues/193
Beitragsleitfaden
Rechercherichtung
Beginne mit der Überprüfung der vorhandenen TypeScript-Definitionen für die Contentlayer-Konfiguration und Inhaltsschemas. Untersuche, ob sich daraus eine Zod-ähnliche Validierung ableiten lässt oder ob TS+ geeignet ist; als erledigt gilt die Aufgabe, wenn falsch konfigurierte Schemas und Konfigurationen Validierungsfehler statt undefined-Laufzeitfehler erzeugen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- developer-experience, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 30/100