Skip to content
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

Open
wants to merge 4 commits into
base: next
Choose a base branch
from

Conversation

tobiasdiez
Copy link
Contributor

@tobiasdiez tobiasdiez commented Apr 19, 2024

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 the baseGenerator 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:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

Create a new project using npx nuxi@latest init followed by code\lib\cli\bin\index.js init.

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/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 PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Copy link

nx-cloud bot commented Apr 19, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 76b1d71. 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 target

Sent with 💌 from NxCloud.

@yannbf yannbf changed the title CLI: Add support for nuxt to project init CLI: Add support for Nuxt to project init Apr 29, 2024
@yannbf
Copy link
Member

yannbf commented Apr 29, 2024

Hey @tobiasdiez thanks for your contribution! Seems like a duplicate of #23663. I'll let you, @kasperpeulen and @chakAs3 discuss about it. Thanks!

@kasperpeulen
Copy link
Contributor

Could you review this one @chakAs3 ?

@tobiasdiez
Copy link
Contributor Author

tobiasdiez commented Apr 30, 2024

Hey @tobiasdiez thanks for your contribution! Seems like a duplicate of #23663. I'll let you, @kasperpeulen and @chakAs3 discuss about it. Thanks!

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.

@chakAs3
Copy link
Contributor

chakAs3 commented Apr 30, 2024

Hey @tobiasdiez thanks for your contribution! Seems like a duplicate of #23663. I'll let you, @kasperpeulen and @chakAs3 discuss about it. Thanks!

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. ✌️

Copy link
Contributor

@chakAs3 chakAs3 left a 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants