sensiolabs / StorybookBundle

MIT License
30 stars 2 forks source link

Create a recipes #22

Open kells64000 opened 1 month ago

kells64000 commented 1 month ago

It would be cool to have a recipe in the contrib repository.

This would allow you to manage the prerequisites at the installation stage instead of doing a bin/console storybook:init?

What do you think?

jmwamser commented 1 month ago

Would be happy to assist with the recipe. I noticed that this is currently in active development. Does it make sense to have storybook:init as a recipe at this point, or to wait just a little longer?

squrious commented 1 month ago

Hi! Yes a recipe would be a great improvement. The storybook:init command have some parts that could be extracted to a recipe, but the Storybook configuration files generation still requires a PHP script.

The recipe would contain:

Then we'll still use the init command for preview template, main.ts and preview.ts generation and the example story (its location depends on the main.ts file).

WDYT?

jmwamser commented 1 month ago

I agree with the files you mentioned. I will have to think about the package.json file though.

Would there be a need to check if the user is using AssetMapper versus Encore versus just a package.json file?

squrious commented 1 month ago

Would there be a need to check if the user is using AssetMapper versus Encore versus just a package.json file?

For the moment this bundle works only with AssetMapper. In order to make it work with Encore, we'll have to provide an alternative configuration/compilation mode to use Encore's webpack config in Storybook. But this is another story :smile:

jmwamser commented 1 month ago

It would be cool to have a recipe in the contrib repository.

@squrious, should this go in the "contrib" repository, or should it go in the "official" repository?

As I started to build it out I noticed we could do the following:

Here is my initial thoughts on a fork of the "office" recipes lib.

squrious commented 1 month ago

Hi!

@squrious, should this go in the "contrib" repository, or should it go in the "official" repository?

This should go to the contrib repo :)

Here is my initial thoughts on a fork of the "office" recipes lib.

Looks great to me, thanks for working on this!

Just a few comments before we go to the PR:

jmwamser commented 1 month ago

Morning @squrious,

I have created symfony/recipes-contrib#1623

It appears that the bundle's strict compatibility with Symfony 7 is causing some issues. Is there any particular reason we don't want this bundle to be available for Symfony 6.4 as well?

squrious commented 1 month ago

It appears that the bundle's strict compatibility with Symfony 7 is causing some issues. Is there any particular reason we don't want this bundle to be available for Symfony 6.4 as well?

Hum no real reason, I think it's a misconfiguration in our composer.json. I just tested with 6.4 packages and it works fine :smile:

jmwamser commented 3 days ago

It looks like the PR for the recipe was merged in. @squrious or @kells64000 I believe this one can be marked as closed now :D