[Toolkit] Rework recipe name #3107
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
carsonbot
added
Feature
Kocal
force-pushed
the
toolkit-rework-recipe-name
branch
2 times, most recently
from
cc01380 to
9735dff
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR refactors recipe naming in the Symfony UX Toolkit by introducing a kebab-case naming convention and adding a dedicated name field to recipes. The changes make component installation more command-line friendly by using kebab-case identifiers while preserving human-readable display names.
- Adds a
namefield to Recipe objects based on folder names in kebab-case format - Updates recipe folder structure from PascalCase to kebab-case
- Modifies command syntax to use kebab-case recipe names (e.g.,
alert-dialoginstead ofAlert Dialog)
Reviewed Changes
Copilot reviewed 29 out of 102 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/Toolkit/src/Recipe/Recipe.php | Adds name field to Recipe constructor |
| src/Toolkit/src/Recipe/RecipeSynchronizer.php | Updates recipe creation to use folder basename as name |
| src/Toolkit/src/Kit/Kit.php | Refactors recipe storage to use name as key instead of manifest name |
| src/Toolkit/src/Command/InstallCommand.php | Updates command examples and messaging to use kebab-case naming |
| ux.symfony.com/templates/toolkit/_kit_aside.html.twig | Updates navigation to use recipe name instead of manifest name |
| Multiple test files | Updates test fixtures and assertions for kebab-case naming |
| src/Toolkit/kits/shadcn/alert-dialog/ | Example of folder renaming from AlertDialog to alert-dialog |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Kocal
force-pushed
the
toolkit-rework-recipe-name
branch
2 times, most recently
from
55853e6 to
f06e725
Compare
Kocal
force-pushed
the
toolkit-rework-recipe-name
branch
from
f06e725 to
a82b03b
Compare
|
Interesting, the CI fails to find recipe like Note that Not sure what's the best solution here, does the runner has some filesystem cache when running EDIT: thanks to GPT, that's in fact related to git itself with tends to ignore case, I will find a workaround. |
Kocal
force-pushed
the
toolkit-rework-recipe-name
branch
from
69da901 to
edec8f7
Compare
Kocal
force-pushed
the
toolkit-rework-recipe-name
branch
from
edec8f7 to
60a6b78
Compare
|
Had to merge through GUI because: |
Kocal
added a commit
that referenced
this pull request
Sep 27, 2025
# Via Hugo Alliaume (2) and GitHub (1) * 2.x: [Toolkit] Rework recipe name (#3107) [CI] Remove duplicated matrix entry for Symfony version in unit-tests.yaml Remove explicit configuration `twig.exception_controller` from Kernel for testing # Conflicts: # .github/workflows/unit-tests.yaml # src/LazyImage/tests/Kernel/TwigAppKernel.php # src/TogglePassword/tests/Kernel/TwigAppKernel.php # ux.symfony.com/importmap.php
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduce a new field "name" for Recipe (based on Recipe's folder name), and change the case of Recipe folders from PascalCase to kebab-case, in order to make things more friendly.
With this new field:
bin/console ux:install "Alert Dialog" --kit shadcnbecomesbin/console ux:install alert-dialog --kit shadcnux.symfony.com/toolkit/kits/shadcn/components/Alert%20Dialogbecomesux.symfony.com/toolkit/kits/shadcn/components/alert-dialog