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

CSF: Provide project globals to enhancers #30866

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

Conversation

mrginglymus
Copy link
Contributor

@mrginglymus mrginglymus commented Mar 20, 2025

  1. Document storyGlobals in the types
  2. Add project level globals

What I did

Ensure project level globals are provided as context to enhancers

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-storybook/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>

Greptile Summary

This PR adds project-level globals to story enhancers by introducing a new storyGlobals property in the story context, enabling better access to global state within enhancers.

  • Added storyGlobals property of type Globals to StoryContextForEnhancers interface in code/core/src/csf/story.ts
  • Modified preparePartialAnnotations in code/core/src/preview-api/modules/store/csf/prepareStory.ts to include projectAnnotations.initialGlobals
  • Fixed typo in deprecation comment (changed 'initiaGlobals' to 'initialGlobals')

The changes are focused and maintain backward compatibility while improving the enhancer context functionality.

1. Document storyGlobals in the types
2. Add project level globals
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

2 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

Copy link

nx-cloud bot commented Mar 20, 2025

View your CI Pipeline Execution ↗ for commit 99c4747.

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m 58s View ↗

☁️ Nx Cloud last updated this comment at 2025-03-20 11:56:23 UTC

@mrginglymus
Copy link
Contributor Author

Oh my, that all works quite differently than I'd initially thought...

@mrginglymus
Copy link
Contributor Author

Hmm, there's some unfortunate mismatching of types here, where StoryContextForEnhancers seems to be used outside of what is actually passed to enhancers - as the returntype of preparePartialAnnotations, and a basis for StoryContext.

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.

3 participants