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

Vite: Merge assetsInclude property with Storybook default values #26860

Merged

Conversation

yuemori
Copy link
Contributor

@yuemori yuemori commented Apr 17, 2024

What I did

In this PR, I address a configuration issue in builder-vite where the assetsInclude field was being statically set to ['/sb-preview/**'], which could potentially overwrite any user-defined configurations. The updated implementation now merges any existing entries with these required defaults, ensuring both are preserved.

Details of Changes

  • Modified how assetsInclude is initialized, ensuring it now merges ['/sb-preview/**'] with any existing patterns set by the user.
  • Implemented this using spread syntax to efficiently combine arrays, accommodating both singular and multiple existing entries.

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

Documentation

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

Workaround

You can avoid this issue by using viteFinal to further override the settings.

const config: StorybookConfig = {
  // ...,
  viteFinal(config: InlineConfig) {
    return mergeConfig(config, {
      assetsInclude: ["./src/**/*.csv"]
    })
  }
}

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>

@yannbf yannbf added bug patch:yes Bugfix & documentation PR that need to be picked to main branch builder-vite ci:normal labels Apr 29, 2024
@yannbf yannbf changed the title Fix vite-builder prevent override of assetsInclude field by default value Vite: Merge assetsInclude property with Storybook default values Apr 29, 2024
Copy link

nx-cloud bot commented Apr 29, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 435407d. 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.

@ndelangen ndelangen merged commit f6ecc28 into storybookjs:next Apr 29, 2024
51 checks passed
storybook-bot pushed a commit that referenced this pull request Apr 29, 2024
…tsinclude

Vite: Merge assetsInclude property with Storybook default values
(cherry picked from commit f6ecc28)
@github-actions github-actions bot mentioned this pull request Apr 29, 2024
9 tasks
storybook-bot pushed a commit that referenced this pull request Apr 29, 2024
…tsinclude

Vite: Merge assetsInclude property with Storybook default values
(cherry picked from commit f6ecc28)
storybook-bot pushed a commit that referenced this pull request Apr 29, 2024
…tsinclude

Vite: Merge assetsInclude property with Storybook default values
(cherry picked from commit f6ecc28)
storybook-bot pushed a commit that referenced this pull request Apr 29, 2024
…tsinclude

Vite: Merge assetsInclude property with Storybook default values
(cherry picked from commit f6ecc28)
storybook-bot pushed a commit that referenced this pull request Apr 30, 2024
…tsinclude

Vite: Merge assetsInclude property with Storybook default values
(cherry picked from commit f6ecc28)
storybook-bot pushed a commit that referenced this pull request May 1, 2024
…tsinclude

Vite: Merge assetsInclude property with Storybook default values
(cherry picked from commit f6ecc28)
storybook-bot pushed a commit that referenced this pull request May 1, 2024
…tsinclude

Vite: Merge assetsInclude property with Storybook default values
(cherry picked from commit f6ecc28)
storybook-bot pushed a commit that referenced this pull request May 1, 2024
…tsinclude

Vite: Merge assetsInclude property with Storybook default values
(cherry picked from commit f6ecc28)
storybook-bot pushed a commit that referenced this pull request May 1, 2024
…tsinclude

Vite: Merge assetsInclude property with Storybook default values
(cherry picked from commit f6ecc28)
storybook-bot pushed a commit that referenced this pull request May 2, 2024
…tsinclude

Vite: Merge assetsInclude property with Storybook default values
(cherry picked from commit f6ecc28)
storybook-bot pushed a commit that referenced this pull request May 2, 2024
…tsinclude

Vite: Merge assetsInclude property with Storybook default values
(cherry picked from commit f6ecc28)
storybook-bot pushed a commit that referenced this pull request May 2, 2024
…tsinclude

Vite: Merge assetsInclude property with Storybook default values
(cherry picked from commit f6ecc28)
storybook-bot pushed a commit that referenced this pull request May 3, 2024
…tsinclude

Vite: Merge assetsInclude property with Storybook default values
(cherry picked from commit f6ecc28)
@github-actions github-actions bot mentioned this pull request May 3, 2024
44 tasks
@yuemori yuemori deleted the fix-vite-builder-override-assetsinclude branch May 3, 2024 12:04
storybook-bot pushed a commit that referenced this pull request May 4, 2024
…tsinclude

Vite: Merge assetsInclude property with Storybook default values
(cherry picked from commit f6ecc28)
storybook-bot pushed a commit that referenced this pull request May 4, 2024
…tsinclude

Vite: Merge assetsInclude property with Storybook default values
(cherry picked from commit f6ecc28)
storybook-bot pushed a commit that referenced this pull request May 5, 2024
…tsinclude

Vite: Merge assetsInclude property with Storybook default values
(cherry picked from commit f6ecc28)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label May 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug builder-vite ci:normal patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants