Skip to content

[Docs] Add caution alert when bundle require StimulusBundle #1277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 12, 2023

Conversation

ker0x
Copy link
Contributor

@ker0x ker0x commented Nov 14, 2023

Q A
Bug fix? no
New feature? no
Issues To complement #1276
License MIT

This PR add a caution alert at the beginning of Installation section for all bundle requiring StimulusBundle

@smnandre
Copy link
Member

Imho, the "caution" may be a bit too strong (red block)... maybe a "info" should do the job ?

I made a quick check (i was not sure) so, for information, those packages require symfony/stimulus-bundle in their composer file, so the risk of installing them without Stimulus bundle is null

  • Chartjs
  • Notify
  • React
  • Svelte
  • Turbo
  • Vue

(not saying that does not deserve a message in the doc)

And those ones do not

  • Autocomplete
  • CropperJS
  • Dropzone
  • LazyImage
  • LiveComponent
  • Swup
  • TogglePassword
  • Translator
  • Typed

Finally (to cover all the packages), TwigComponent does not depend / use / require StimulusBundle.

@weaverryan
Copy link
Member

This can definitely be a gotcha. We could require stimulus-bundle in the rest of the packages. It is not technically required, but it is practically required.

@weaverryan
Copy link
Member

Thanks Romain!

@weaverryan weaverryan merged commit 4f47ed0 into symfony:2.x Dec 12, 2023
@ker0x ker0x deleted the docs/caution-alert branch December 12, 2023 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants