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 2 commits into
base: next
Choose a base branch
from
Open

Tags: Add MDX test cases #29655

wants to merge 2 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 78.5 MB 78.5 MB 0 B 4.28 0%
initSize 144 MB 144 MB 0 B 1.82 0%
diffSize 65.2 MB 65.2 MB 0 B 0.55 0%
buildSize 6.83 MB 6.83 MB 0 B -0.36 0%
buildSbAddonsSize 1.51 MB 1.51 MB 0 B -3 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 1.86 MB 1.86 MB 0 B -0.35 0%
buildSbPreviewSize 271 kB 271 kB 0 B -3 0%
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 3.83 MB 3.83 MB 0 B -0.36 0%
buildPreviewSize 3 MB 3 MB 0 B 0.51 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 6.4s 22.4s 16s 0.84 71.4%
generateTime 18.6s 20.3s 1.6s -0.02 8.2%
initTime 13.5s 14.4s 908ms 0.01 6.3%
buildTime 8.7s 7.4s -1s -264ms -1.08 -16.9%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 5.5s 6.1s 612ms 0.58 9.9%
devManagerResponsive 3.5s 3.8s 323ms 0.74 8.4%
devManagerHeaderVisible 677ms 565ms -112ms -0.3 -19.8%
devManagerIndexVisible 744ms 604ms -140ms -0.72 -23.2%
devStoryVisibleUncached 929ms 1s 119ms 0.09 11.4%
devStoryVisible 701ms 602ms -99ms -0.57 -16.4%
devAutodocsVisible 376ms 459ms 83ms -0.54 18.1%
devMDXVisible 577ms 494ms -83ms -0.47 -16.8%
buildManagerHeaderVisible 717ms 562ms -155ms -0.17 -27.6%
buildManagerIndexVisible 753ms 578ms -175ms -0.19 -30.3%
buildStoryVisible 716ms 554ms -162ms -0.25 -29.2%
buildAutodocsVisible 549ms 428ms -121ms -0.75 -28.3%
buildMDXVisible 503ms 468ms -35ms -0.18 -7.5%

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

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 36e9ed7. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@storybook-pr-benchmarking
Copy link

storybook-pr-benchmarking bot commented Nov 25, 2024

Package Benchmarks

Commit: 36e9ed7, ran on 26 November 2024 at 01:02:56 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.

2 participants