storybookjs/storybook

[Bug]: @storybook/addon-docs/jest-transform-mdx.js jest bug

Open

#24632 opened on Oct 31, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (89,909 stars) (10,058 forks)batch import
addon: docsbugcompatibility with other toolshelp wanted

Description

Describe the bug

@storybook/addon-docs/jest-transform-mdx.js file bug:

  1. jest need process function, but this file use processAsync
  2. @mdx-js/react version2 did not export mdx, but this file use mdx image

To Reproduce

No response

System

No response

Additional context

No response

Contributor guide

Tech stack
javascripttypescriptreactjest
Domain
frontendtestingdocumentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Storybook addon docsJest transformMDX js/reactNode.js module system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Look at the file `@storybook/addon docs/jest transform mdx.js` in the repository. The first issue is that the function `processAsync` is exported but Jest expects a `process` function; change the export accordingly. The second issue is that `@mdx js/react` version 2 does not export `mdx`; check the current export from that package and update the import. Also, consult any existing tests for this transform to ensure changes don't break other functionality.