Portable stories: Make setProjectAnnotations accept multiple types of imports

[yannbf]

Closes #

What I did

Before, it was tricky for users to know how to set project annotations because they can either come from a file such as:

1 -

// .storybook/preview.ts
const preview = {
	parameters: {}
}

export default preview;

2 -

// .storybook/preview.ts
export const parameters = {}

Meaning they would have to know whether to import them like so (in a Vitest setup file for instance):

// setup-file.ts
import * as annotations from '../.storybook/preview' // or some-addon/preview
import { setProjectAnnotations } from '@storybook/react'
setProjectAnnotations(annotations)

or like so:

// setup-file.ts
import annotations from '../.storybook/preview' // or some-addon/preview
import { setProjectAnnotations } from '@storybook/react'
setProjectAnnotations(annotations)

It gets tricky because annotations can come differently from where users are importing.

This PR fixes that issue by accepting both formats, and in the documentation we will be telling users to use import * as even if the file has just a default export. This way, the code will always be concise such as:

import * as sbAnnotations from '../.storybook/preview'
import * as addonAnnotations from 'some-addon/preview'
import { setProjectAnnotations } from '@storybook/react'
setProjectAnnotations([sbAnnotations, addonAnnotations])

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

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

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>

[JReinhold]

🚀

[storybook-bot]

Failed to publish canary version of this pull request, triggered by @yannbf. See the failed workflow run at: https://github.com/storybookjs/storybook/actions/runs/8160773211

[nx-cloud]

☁️ Nx Cloud Report

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

• nx run-many --target=prep --all --parallel=8 --max-parallel=3 -- --reset --optimized

---

Sent with 💌 from NxCloud.