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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Indexers: Mark indexers as experimental #23676

Merged
merged 2 commits into from
Aug 2, 2023

Conversation

JReinhold
Copy link
Contributor

@JReinhold JReinhold commented Aug 1, 2023

Works on #23457

Telescopes on top of #23660

What I did

Changed the preset property from indexers to experimental_indexers. They are still indexers internally everywhere, only the preset.apply calls and StorybookConfig type changed so if users were to add their own indexers, they'd need to add them as experimental_indexers in main.ts.

I didn't change all the new types that the indexers use, that didn't seem necessary. I also didn't add a console warning given that we're adding default indexers which would trigger this warning every time.

I also reverted my updates to the code snippets, as I think they should get updated when we write the new docs at the end of this project, and not before that.

How to test

  1. Create a sandbox.
  2. Add an experimental indexer in the main.ts file:
...
  experimental_indexers: (existing) => {
    console.log('馃憢 from experimentals.');
    return existing
  }
  1. Start Storybook and see the log in your terminal.

Checklist

  • Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

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.

["cleanup", "BREAKING CHANGE", "feature request", "bug", "build", "documentation", "maintenance", "dependencies", "other"]

馃 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 JReinhold self-assigned this Aug 1, 2023
@JReinhold JReinhold requested review from ndelangen and shilman and removed request for shilman August 1, 2023 21:22
@JReinhold JReinhold changed the base branch from next to replace-indexers August 1, 2023 21:23
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

Thanks for this @JReinhold , and agree with the docs changes. We can revisit them later on.

Base automatically changed from replace-indexers to indexer-api August 2, 2023 22:07
@JReinhold JReinhold merged commit 8f3fbd8 into indexer-api Aug 2, 2023
57 checks passed
@JReinhold JReinhold deleted the new-indexer-experimental branch August 2, 2023 22:08
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.

None yet

4 participants