Skip to content

Commit

Permalink
minor #908 [StimulusBundle] Marking only the AssetMapper integration …
Browse files Browse the repository at this point in the history
…as experimental (weaverryan)

This PR was squashed before being merged into the 2.x branch.

Discussion
----------

[StimulusBundle] Marking only the AssetMapper integration as experimental

| Q             | A
| ------------- | ---
| Bug fix?      | yesish
| New feature?  | no
| Tickets       | Addresses symfony/ux#907 (comment)
| License       | MIT

StimulusBundle should not really be experimental. The `stimulus_*` Twig functions were ported from WebpackEncoreBundle and should work the same (if they don't, that would be a bug).

The only part that should be experimental is the AssetMapper integration.

Cheers!

Commits
-------

71abb6fa [StimulusBundle] Marking only the AssetMapper integration as experimental
  • Loading branch information
jameswebapp committed May 30, 2023
2 parents a0360b0 + 0a851ce commit 74e22d7
Show file tree
Hide file tree
Showing 7 changed files with 3 additions and 18 deletions.
5 changes: 1 addition & 4 deletions src/StimulusBundle/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
# StimulusBundle: Symfony integration with Stimulus!

**EXPERIMENTAL** This bundle is currently experimental. It is possible that
backwards-compatibility breaks could happen between minor versions.

This bundle adds integration between Symfony, Stimulus and Symfony UX:

- A) Twig `stimulus_*` functions & filters to add Stimulus controllers, actions & targets in your templates;
- B) Integration with Symfony UX & AssetMapper;
- B) Integration with Symfony UX & AssetMapper (this integration is [experimental](https://symfony.com/doc/current/contributing/code/experimental.html)
- C) A helper service to build the Stimulus data attributes and use them in your services.

[Read the documentation][1]
Expand Down
6 changes: 2 additions & 4 deletions src/StimulusBundle/doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
StimulusBundle: Symfony integration with Stimulus
=================================================

**EXPERIMENTAL** This bundle is currently experimental. It is possible that
backwards-compatibility breaks could happen between minor versions.

This bundle adds integration between Symfony, `Stimulus`_ and Symfony UX:

A) Twig `stimulus_*` functions & filters to add Stimulus controllers, actions & targets in your templates;
B) Integration with Symfony UX & AssetMapper;
B) Integration with Symfony UX & AssetMapper (this integration is `experimental`_)
C) A helper service to build the Stimulus data attributes and use them in your services.

Installation
Expand Down Expand Up @@ -314,3 +311,4 @@ is running in debug mode.
.. _`parameters`: https://stimulus.hotwired.dev/reference/actions#action-parameters
.. _`Stimulus Targets`: https://stimulus.hotwired.dev/reference/targets
.. _`StimulusBundle Flex recipe`: https://github.com/symfony/recipes/tree/main/symfony/stimulus-bundle
.. _`experimental`: https://symfony.com/doc/current/contributing/code/experimental.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@
use Symfony\Component\HttpKernel\DependencyInjection\Extension;

/**
* @experimental
*
* @author Ryan Weaver <[email protected]>
*/
final class StimulusExtension extends Extension implements PrependExtensionInterface, ConfigurationInterface
Expand Down
2 changes: 0 additions & 2 deletions src/StimulusBundle/src/Dto/StimulusAttributes.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@
/**
* Helper to build Stimulus-related HTML attributes.
*
* @experimental
*
* @author Ryan Weaver <[email protected]>
*/
class StimulusAttributes implements \Stringable, \IteratorAggregate
Expand Down
2 changes: 0 additions & 2 deletions src/StimulusBundle/src/Helper/StimulusHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@
use Twig\Loader\ArrayLoader;

/**
* @experimental
*
* @author Ryan Weaver <[email protected]>
*/
final class StimulusHelper
Expand Down
2 changes: 0 additions & 2 deletions src/StimulusBundle/src/StimulusBundle.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@
use Symfony\UX\StimulusBundle\DependencyInjection\Compiler\RemoveAssetMapperServicesCompiler;

/**
* @experimental
*
* @author Ryan Weaver <[email protected]>
*/
final class StimulusBundle extends Bundle
Expand Down
2 changes: 0 additions & 2 deletions src/StimulusBundle/src/Twig/StimulusTwigExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@
use Twig\TwigFunction;

/**
* @experimental
*
* @author Ryan Weaver <[email protected]>
*/
final class StimulusTwigExtension extends AbstractExtension
Expand Down

0 comments on commit 74e22d7

Please sign in to comment.