Skip to content

add "requiredFlavor" feature#33

Open
Sam Beveridge (00salmon) wants to merge 1 commit intomainfrom
add-required-flavor
Open

add "requiredFlavor" feature#33
Sam Beveridge (00salmon) wants to merge 1 commit intomainfrom
add-required-flavor

Conversation

@00salmon
Copy link
Copy Markdown
Contributor

Description of the change

Description here

Type of change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation or Development tools (readme, specs, tests, code formatting)

Links

  • Jira issue number: (PUT IT HERE)
  • Process.st launch checklist: (PUT IT HERE)

Checklists

Development

  • Prettier was run (if applicable)
  • The behaviour changes in the pull request are covered by specs
  • All tests related to the changed code pass in development

Paperwork

  • This pull request has a descriptive title and information useful to a reviewer
  • This pull request has a Jira number
  • This pull request has a Process.st launch checklist

Code review

  • Changes have been reviewed by at least one other engineer
  • Security impacts of this change have been considered

Copilot AI review requested due to automatic review settings April 16, 2026 19:03
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 16, 2026

⚠️ No Changeset found

Latest commit: 605dd08

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 @requiredFlavor from Stencil docsTags and emit it on generated schema.Attribute metadata.
  • Extend @raisins/schema Attribute type definition with an optional requiredFlavor?: 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'),
Copy link

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants