Skip to content

[Toolkit] Remove the unused recipe manifest type property - #3722

Closed
kbond wants to merge 1 commit into
symfony:3.xfrom
kbond:toolkit-remove-recipe-type
Closed

[Toolkit] Remove the unused recipe manifest type property#3722
kbond wants to merge 1 commit into
symfony:3.xfrom
kbond:toolkit-remove-recipe-type

Conversation

@kbond

@kbond kbond commented Jul 23, 2026

Copy link
Copy Markdown
Member
Q A
Bug fix? no
New feature? no
Deprecations? no
License MIT

Every recipe manifest declared "type": "component", and no code path actually depended on the value. The only consumers were Kit::getRecipes()/getRecipe(), whose RecipeType filter was used in exactly one place — KitContextRunner, to select recipes when wiring Twig component resolution. Iterating all recipes there is equivalent: a recipe with no component templates contributes nothing to resolution and simply falls through. The block case existed only in in-memory unit-test fixtures — no real recipe ever used it. And the create-kit scaffolder already omitted type from the manifest it generates, so requiring the property was internally inconsistent.

So the field carried no information that isn't already implicit in a recipe's files. This removes it:

  • Delete the RecipeType enum and drop the type property from RecipeManifest.
  • Simplify Kit::getRecipes()/getRecipe() to drop the type filter; KitContextRunner now iterates all recipes.
  • Remove type from schema-kit-recipe-v1.json and from all 63 kit manifests.

This clears the way for controller-only recipes (e.g. a forthcoming closeable recipe in the common kit) that ship a Stimulus controller and no Twig component — a shape the component/block enum had no honest slot for.

@kbond
[Toolkit] Remove the unused recipe manifest type property
b31f99b 
Every recipe declared `type: "component"` and no code path depended on
the distinction: the only consumers filtered `getRecipes()` to
`RecipeType::Component`, but iterating all recipes is equivalent since a
recipe without component templates contributes nothing to Twig component
resolution. The `create-kit` scaffolder already omitted `type` from its
generated manifest, so requiring it was also inconsistent.

Drop the property from `RecipeManifest`, delete the `RecipeType` enum,
remove `type` from the recipe schema and all kit manifests, and simplify
`Kit::getRecipes()`/`getRecipe()` to no longer take a type filter.
Copilot AI review requested due to automatic review settings July 23, 2026 02:41
@kbond
kbond requested a review from Kocal as a code owner July 23, 2026 02:41
@carsonbot carsonbot added Toolkit Status: Needs Review Needs to be reviewed labels Jul 23, 2026
Copilot AI reviewed Jul 23, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Removes the unused type field from Symfony UX Toolkit recipe manifests, simplifying the internal recipe model and allowing future “non-component” (e.g. controller-only) recipes without forcing an artificial enum classification.

Changes:

  • Remove RecipeType and drop the type property from RecipeManifest + JSON parsing.
  • Simplify Kit::getRecipes() / Kit::getRecipe() and update KitContextRunner to iterate all recipes.
  • Update recipe schema + kit recipe manifests (and tests) to no longer include/require type.

Reviewed changes

Copilot reviewed 76 out of 76 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/Toolkit/src/Recipe/RecipeType.php Removes the unused enum that previously backed manifest type.
src/Toolkit/src/Recipe/RecipeManifest.php Drops type from the manifest object and JSON parsing.
src/Toolkit/src/Kit/Kit.php Simplifies recipe retrieval APIs by removing the type filter parameters.
src/Toolkit/src/Kit/KitContextRunner.php Updates Twig/component resolution wiring to iterate all recipes.
src/Toolkit/schema-kit-recipe-v1.json Removes type from the recipe manifest schema and keeps name required.
src/Toolkit/kits/shadcn/accordion/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/alert/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/alert-dialog/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/aspect-ratio/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/avatar/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/badge/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/breadcrumb/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/button/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/button-group/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/card/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/checkbox/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/collapsible/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/combobox/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/dialog/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/empty/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/field/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/hover-card/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/input/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/input-group/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/item/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/kbd/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/label/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/pagination/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/progress/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/radio-group/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/resizable/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/select/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/separator/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/skeleton/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/sonner/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/spinner/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/switch/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/table/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/tabs/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/textarea/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/toggle/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/toggle-group/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/tooltip/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/shadcn/typography/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/alert/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/avatar/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/badge/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/button/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/button-group/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/card/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/checkbox/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/dropdown/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/indicator/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/input/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/kbd/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/label/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/modal/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/pagination/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/radio/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/select/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/skeleton/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/spinner/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/table/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/tabs/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/textarea/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/flowbite-4/toggle/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/common/logout-link/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/kits/common/post-link/manifest.json Removes the type property from the recipe manifest.
src/Toolkit/tests/Recipe/RecipeTest.php Updates unit tests to construct manifests without type.
src/Toolkit/tests/Recipe/RecipeManifestTest.php Updates JSON parsing tests to no longer require/validate type.
src/Toolkit/tests/Kit/Lint/Checker/DocCheckerTest.php Updates fixtures for new manifest constructor shape.
src/Toolkit/tests/Kit/Lint/Checker/DocHeadingLevelCheckerTest.php Updates fixtures for new manifest constructor shape.
src/Toolkit/tests/Kit/KitTest.php Updates kit tests to no longer assert type-filtered behavior.
src/Toolkit/tests/Installer/PoolTest.php Updates installer pool tests for new manifest constructor shape.
src/Toolkit/tests/Functional/ComponentsRenderingTest.php Adjusts functional rendering to iterate all recipes.
src/Toolkit/CHANGELOG.md Documents the manifest type removal in 3.4.0.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/Toolkit/src/Kit/KitContextRunner.php
Comment on lines +65 to 67
foreach ($kit->getRecipes() as $recipe) {
$loaders[] = new FilesystemLoader($recipe->absolutePath);
}
Comment thread src/Toolkit/src/Kit/KitContextRunner.php
Comment on lines +105 to 108
foreach ($this->kit->getRecipes() as $recipe) {
foreach ($recipe->getFiles() as $file) {
if (str_ends_with($file->sourceRelativePathName, 'templates/components/'.str_replace(':', '/', $name).'.html.twig')) {
return $file->sourceRelativePathName;
Comment thread src/Toolkit/tests/Functional/ComponentsRenderingTest.php
foreach ($kit->getRecipes(RecipeType::Component) as $recipe) {
foreach ($kit->getRecipes() as $recipe) {
foreach ($recipe->getExamples() as $i => $example) {
yield \sprintf('Kit %s, component %s, example #%d', $kitName, $recipe->name, $i) => [$kitName, $recipe->name, $example['code']];
Kocal
Kocal requested changes Jul 23, 2026
View reviewed changes

@Kocal Kocal left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I didn't had time to work on it, but the type was supposed to be component or block (#3246) , like https://ui.shadcn.com/blocks, https://flowbite.com/blocks/, https://getbootstrap.com/docs/5.3/examples/#custom-components, etc..

So 👎🏻 for me

@carsonbot carsonbot added Status: Needs Work Additional work is needed and removed Status: Needs Review Needs to be reviewed labels Jul 23, 2026
@Kocal

Kocal commented Jul 23, 2026

Copy link
Copy Markdown
Member

See open PR #3596

@kbond

kbond commented Jul 23, 2026

Copy link
Copy Markdown
Member Author

So a recipe that's purely a stimulus recipe, should be "component"?

@Kocal

Kocal commented Jul 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Mmmh, let's say that big compound recipes are blocks, and others are components, yep!
It's related to Atomic Design Methodology, but we only have components and blocks (templates).

Note that ux.symfony.com consumes Kit::getRecipes(RecipeType::Component) at multiple places:

image

Everything is ready for building blocks, I just didn't have time to continue to work on them.

@kbond kbond closed this Jul 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@Kocal Kocal Kocal requested changes

Assignees

No one assigned

Labels

Status: Needs Work Additional work is needed Toolkit

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@kbond @Kocal @carsonbot