Skip to content

CSF: Improve controls parameters #31745

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

Open
wants to merge 1 commit into
base: next
Choose a base branch
from
Open

Conversation

kasperpeulen
Copy link
Contributor

@kasperpeulen kasperpeulen commented Jun 11, 2025

Closes #

What I did

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 pull request has been released as version 0.0.0-pr-31745-sha-ba0de02d. Try it out in a new sandbox by running npx [email protected] sandbox or in an existing project with npx [email protected] upgrade.

More information
Published version 0.0.0-pr-31745-sha-ba0de02d
Triggered by @kasperpeulen
Repository storybookjs/storybook
Branch kasper/improve-controls
Commit ba0de02d
Datetime Wed Jun 11 09:40:23 UTC 2025 (1749634823)
Workflow run 15581469173

To request a new release of this pull request, mention the @storybookjs/core team.

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

Greptile Summary

Improves TypeScript support in Storybook Controls by formalizing matcher configurations for auto-detecting control types.

  • Added type definitions for matchers property in ControlsParameters interface
  • Enhanced type safety for regex-based control detection (e.g., /(background|color)$/i for colors)
  • Added proper JSDoc documentation with links to relevant documentation
  • Maintains backward compatibility while improving TypeScript integration

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.

1 file reviewed, 1 comment
Edit PR Review Bot Settings | Greptile

Comment on lines 23 to 24
/** Exclude only specific properties in the Controls panel */
include?: string[] | RegExp;
Copy link
Contributor

Choose a reason for hiding this comment

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

logic: The JSDoc comment is incorrect - this describes exclude rather than include functionality

Suggested change
/** Exclude only specific properties in the Controls panel */
include?: string[] | RegExp;
/** Include only specific properties in the Controls panel */
include?: string[] | RegExp;

Copy link

nx-cloud bot commented Jun 11, 2025

View your CI Pipeline Execution ↗ for commit ba0de02.

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

☁️ Nx Cloud last updated this comment at 2025-06-11 09:39:06 UTC

@valentinpalkovic valentinpalkovic marked this pull request as draft June 16, 2025 13:07
@kasperpeulen kasperpeulen marked this pull request as ready for review June 16, 2025 14:06
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

1 file reviewed, no comments
Edit PR Review Bot Settings | Greptile

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.

2 participants