patternfly / patternfly/patternfly-doc-core
Support CLI Command to Generate Zod Schema Representation
@jenny-s51 is already working on this.
Since Oct 8, 2025.
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 11
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 1
Description
Currently, tsDocGen.js generates a JSON representation of TypeScript/TSX component declarations, extracting prop types, interfaces, and metadata. It would be valuable to support an alternate output mode that generates Zod schema representations of the same props/types/interfaces.
AI-assisted tools such as Cursor often generate or modify code dynamically, which can introduce type mismatches or invalid prop values that TS alone won’t catch at runtime. Zod schemas enable runtime validation of data and props, so AI-generated or user-supplied values are thoroughly checked before being passed to components. This provides immediate feedback during development such that PatternFly components can be correctly implemented within AI-assisted workflows.
Jira Issue: PF-2764
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.