Conversation
|
There was a problem hiding this comment.
Pull request overview
Adds support for a new requiredFlavor metadata field on attributes in the Raisins schema, and populates it from Stencil JSDoc tags during docs-to-Raisins conversion.
Changes:
- Parse
@requiredFlavorfrom StencildocsTagsand emit it on generatedschema.Attributemetadata. - Extend
@raisins/schemaAttributetype definition with an optionalrequiredFlavor?: string.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| packages/stencil-docs-target/src/convertToRaisins.ts | Emits requiredFlavor on attributes based on the @requiredFlavor docs tag. |
| packages/schema/schema.d.ts | Adds requiredFlavor to the Attribute interface so the output is typed/validated consistently. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| required: required(p), | ||
| requiredFeatures: jsonTagValue(p, 'requiredFeatures'), | ||
| featureTooltip: tagValue(p.docsTags, 'featureTooltip'), | ||
| requiredFlavor: tagValue(p.docsTags, 'requiredFlavor'), |
There was a problem hiding this comment.
New @requiredFlavor docs tag is now parsed into the output, but the Stencil docs target README’s “Attributes Annotations” table doesn’t document this tag. Please add documentation (tag name, description, example) so component authors know how to use it.
Description of the change
Type of change
Links
Checklists
Development
Paperwork
Code review