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

Types: Add type for addons, renderers and frameworks #30417

Merged
merged 5 commits into from
Jan 31, 2025

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Jan 29, 2025

Closes #

What I did

This PR introduces types for addons' Parameters and Globals:

  • viewports
  • measure
  • outline
  • controls
  • actions
  • highlight
  • docs
  • essentials (combination of the addons in a single type)
  • links
  • jest
  • a11y
  • storysource
  • test
  • interactions
  • themes

renderers:

  • react

frameworks:

  • nextjs
  • experimental-nextjs-vite

I tried my best to add jsdoc to them and refer to the proper documentation pages. It was really tricky to document addon docs types, please help me check if I missed anything.

These types will later be used as part of the definePreview function used by addons

For Storybook core types we already had them, so we should it them later on as well:

import type { StorybookParameters } from 'storybook/internal/types';

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>

Copy link

nx-cloud bot commented Jan 29, 2025

View your CI Pipeline Execution ↗ for commit d0c668b.

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

☁️ Nx Cloud last updated this comment at 2025-01-31 16:07:51 UTC

@yannbf yannbf added typescript feature request ci:normal ci:merged Run the CI jobs that normally run when merged. and removed ci:normal labels Jan 30, 2025
@yannbf yannbf self-assigned this Jan 30, 2025
@storybook-pr-benchmarking
Copy link

storybook-pr-benchmarking bot commented Jan 30, 2025

Package Benchmarks

Commit: 23c49db, ran on 30 January 2025 at 10:52:58 UTC

The following packages have significant changes to their size or dependencies:

@storybook/addon-essentials

Before After Difference
Dependency count 36 36 0
Self size 18 KB 18 KB 0 B
Dependency size 13.93 MB 13.95 MB 🚨 +14 KB 🚨
Bundle Size Analyzer Link Link

@storybook/addon-storysource

Before After Difference
Dependency count 7 7 0
Self size 1.89 MB 1.89 MB 🚨 +1 KB 🚨
Dependency size 10.73 MB 10.79 MB 🚨 +63 KB 🚨
Bundle Size Analyzer Link Link

@storybook/cli

Before After Difference
Dependency count 390 390 0
Self size 530 KB 530 KB 0 B
Dependency size 75.30 MB 75.37 MB 🚨 +64 KB 🚨
Bundle Size Analyzer Link Link

@storybook/codemod

Before After Difference
Dependency count 277 277 0
Self size 612 KB 612 KB 0 B
Dependency size 65.37 MB 65.43 MB 🚨 +64 KB 🚨
Bundle Size Analyzer Link Link

@storybook/source-loader

Before After Difference
Dependency count 5 5 0
Self size 41 KB 41 KB 0 B
Dependency size 10.67 MB 10.73 MB 🚨 +63 KB 🚨
Bundle Size Analyzer Link Link

Copy link
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

This will be a really nice improvement for folks!

Left a few comments to address or consider. I'll go ahead and approve from a docs perspective, though.

code/addons/a11y/src/types.ts Outdated Show resolved Hide resolved
code/addons/a11y/src/types.ts Show resolved Hide resolved
code/addons/a11y/src/types.ts Outdated Show resolved Hide resolved
code/addons/docs/src/types.ts Outdated Show resolved Hide resolved
code/addons/docs/src/types.ts Show resolved Hide resolved
code/addons/docs/src/types.ts Outdated Show resolved Hide resolved
code/addons/test/src/types.ts Outdated Show resolved Hide resolved
code/renderers/react/src/types.ts Outdated Show resolved Hide resolved
@yannbf yannbf merged commit 66131f1 into kasper/csf-factories Jan 31, 2025
5 of 8 checks passed
@yannbf yannbf deleted the yann/add-parameter-and-globals-types branch January 31, 2025 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:merged Run the CI jobs that normally run when merged. feature request typescript
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants