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

Tags: Add MDX test cases #29655

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

Tags: Add MDX test cases #29655

wants to merge 3 commits into from

Conversation

shilman
Copy link
Member

@shilman shilman commented Nov 19, 2024

Add test cases for MDX handling, which is already supported in the code.

🦋 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>

name before after diff z %
createSize 0 B 0 B 0 B - -
generateSize 77.8 MB 77.8 MB 0 B 2.27 0%
initSize 133 MB 133 MB 0 B -0.73 0%
diffSize 55.3 MB 55.3 MB 0 B -0.73 0%
buildSize 7.19 MB 7.19 MB 0 B -1.18 0%
buildSbAddonsSize 1.85 MB 1.85 MB 0 B -1.19 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 1.87 MB 1.87 MB 0 B 0.88 0%
buildSbPreviewSize 0 B 0 B 0 B - -
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 3.91 MB 3.91 MB 0 B -1.18 0%
buildPreviewSize 3.28 MB 3.28 MB 0 B - 0%
testBuildSize 0 B 0 B 0 B - -
testBuildSbAddonsSize 0 B 0 B 0 B - -
testBuildSbCommonSize 0 B 0 B 0 B - -
testBuildSbManagerSize 0 B 0 B 0 B - -
testBuildSbPreviewSize 0 B 0 B 0 B - -
testBuildStaticSize 0 B 0 B 0 B - -
testBuildPrebuildSize 0 B 0 B 0 B - -
testBuildPreviewSize 0 B 0 B 0 B - -
name before after diff z %
createTime 7s 23.9s 16.9s 2.65 🔺70.8%
generateTime 19.7s 21.6s 1.9s 0.49 8.8%
initTime 13.2s 13.8s 645ms -0.26 4.7%
buildTime 9.4s 9.1s -359ms -0.22 -3.9%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 4.5s 5s 455ms -0.34 9.1%
devManagerResponsive 3.3s 3.8s 513ms 0.06 13.2%
devManagerHeaderVisible 558ms 535ms -23ms -0.84 -4.3%
devManagerIndexVisible 569ms 546ms -23ms -0.92 -4.2%
devStoryVisibleUncached 1.9s 1.8s -73ms -0.29 -3.9%
devStoryVisible 588ms 565ms -23ms -0.89 -4.1%
devAutodocsVisible 534ms 481ms -53ms -0.97 -11%
devMDXVisible 459ms 472ms 13ms -0.77 2.8%
buildManagerHeaderVisible 548ms 565ms 17ms -0.52 3%
buildManagerIndexVisible 687ms 661ms -26ms -0.43 -3.9%
buildStoryVisible 536ms 553ms 17ms -0.52 3.1%
buildAutodocsVisible 427ms 437ms 10ms -0.89 2.3%
buildMDXVisible 423ms 465ms 42ms -0.44 9%

Greptile Summary

Added test cases to verify MDX tag handling functionality in Storybook's documentation system, ensuring proper indexing and processing of custom tags in MDX files.

  • Added code/addons/docs/template/stories/docs2/Tags.mdx demonstrating Meta component with tags property
  • Added test case in StoryIndexGenerator.test.ts to verify MDX files with tags are properly indexed
  • Added mock data file __mockdata__/src/docs2/Tags.mdx for testing tag handling
  • Modified stories-json.test.ts to validate custom tags ('foo', 'bar') are preserved alongside default tags

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

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

Copy link

nx-cloud bot commented Nov 19, 2024

View your CI Pipeline Execution ↗ for commit bc1ba19.

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

☁️ Nx Cloud last updated this comment at 2025-01-02 09:00:16 UTC

@storybook-pr-benchmarking
Copy link

storybook-pr-benchmarking bot commented Nov 25, 2024

Package Benchmarks

Commit: bc1ba19, ran on 2 January 2025 at 09:08:45 UTC

No significant changes detected, all good. 👏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Internal-facing build tooling & test updates ci:normal mdx tags
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants