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
CLI: Add support for Nuxt to project init #26884
base: next
Are you sure you want to change the base?
Conversation
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 09b7a3d. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
Hey @tobiasdiez thanks for your contribution! Seems like a duplicate of #23663. I'll let you, @kasperpeulen and @chakAs3 discuss about it. Thanks! |
Could you review this one @chakAs3 ? |
Ohh, I was not aware of #23663. This would have made my life easier 🙈. It looks like my PR covers the same functionality and I had all the changes of #23663 except for the removal of nuxt from the unsupported template check. The latter I just pushed. Btw, https://github.com/nuxt-modules/storybook/tree/main/examples/starter was generated using the code of this PR. |
I've put in some work on it, but since there wasn't anyone available from the team to review it at the time, I decided to create a separate CLI called 'storybook-nuxt' to expedite the process and deliver something to Nuxt developers who have been waiting for it. ✌️ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@shilman @yannbf , could it be a good moment to transition the namespace to @storybook/nuxt, making it an official implementation? A significant amount of effort has been invested since @tobiasdiez joined me in maintaining the module and preset.
I still advocate for keeping the framework preset @storybook/nuxt separate from the monorepo. This way, we can concentrate on Nuxt-specific features without being overly dependent on Storybook. The same approach could be applied to Next.js as well; extracting them from the monorepo might facilitate faster iterations and more focused developmen
@yannbf @kasperpeulen could you please review this PR? Thanks! Then we can retire our own custom cli implementation https://github.com/storybook-vue/storybook-nuxt/tree/main/packages/storybook-nuxt-cli. |
@tobiasdiez Sorry, just came back from holiday, will look at it today! |
@@ -23,13 +23,16 @@ const defaultOptions: FrameworkOptions = { | |||
staticDir: undefined, | |||
addScripts: true, | |||
addMainFile: true, | |||
addPreviewFile: true, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this option is never set to false?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, this is not used at the moment as we still have to do a bit of work on the side of the storybook nuxt module. The idea is that by default one has a zero-config setup for storybook with nuxt (i.e. no .storybook
folder) and the module provides the necessary config. It would also enable us to specify the storybook config via the nuxt.config
file. This is the common pattern with nuxt, see https://nuxt.com/docs/getting-started/configuration#external-configuration-files.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So should I wait for that work, before merging this PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cc @tobiasdiez and @chakAs3
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added some type fixes, I have a couple of questions, and kicked off a canary so that I can do some e2e testing.
We plan to merge this into the 8.2 alpha branch after the 8.1 release Wednesday! And patch it back to 8.1 when we have some more feedback.
i noticed that the .storybook generated files are .js instead of .ts, However the project is a typescript project ? there is issue with project type detection when it is Nuxt project i guess |
@chakAs3 I think our logic is mainly checking if |
What I did
Add support for nuxt projects when initializing a new project. This uses the nuxt module https://github.com/nuxt-modules/storybook and the underlying framework implementation https://github.com/storybook-vue/storybook-nuxt.
This module, as most nuxt modules, follows a "batteries included" approach and provides all necessary dependencies. In particular,
storybook
and the storybook-nuxt framework. Thus, a few changes needed to be done in thebaseGenerator
code to disable a few features for the nuxt integrtion.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
Create a new project using
npx nuxi@latest init
followed bycode\lib\cli\bin\index.js init
.Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
bug
: Internal changes that fixes incorrect behavior.maintenance
: User-facing maintenance tasks.dependencies
: Upgrading (sometimes downgrading) dependencies.build
: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup
: Minor cleanup style change. Will not show up in release changelog.documentation
: Documentation only changes. Will not show up in release changelog.feature request
: Introducing a new feature.BREAKING CHANGE
: Changes that break compatibility in some way with current major version.other
: Changes that don't fit in the above categories.🦋 Canary release
This pull request has been released as version
0.0.0-pr-26884-sha-09b7a3da
. Try it out in a new sandbox by runningnpx [email protected] sandbox
or in an existing project withnpx [email protected] upgrade
.More information
0.0.0-pr-26884-sha-09b7a3da
nuxt-generator
09b7a3da
1715608539
)To request a new release of this pull request, mention the
@storybookjs/core
team.core team members can create a new canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=26884