storybookjs/storybook

[Bug]: Bad error message when trying to use JSX in .js file

Open

#21,662 opened on Mar 17, 2023

View on GitHub
 (5 comments) (18 reactions) (0 assignees)TypeScript (89,909 stars) (10,058 forks)batch import
bugbuilder-vitehelp wanted

Description

Describe the bug

[storybook:inject-export-order-plugin] Parse error @:22:29
file: ........./src/stories/ApiDocumentation.stories.js
ERR! Error: Parse error @:22:29
ERR!     at parse ........./node_modules/es-module-lexer/dist/lexer.cjs:1:402)
ERR!     at Object.transform (........./node_modules/@storybook/builder-vite/dist/index.js:1:3217)
ERR!     at file:///.........//node_modules/rollup/dist/es/shared/node-entry.js:24343:40

The above error will happen if your .stories.js file contains any JSX. Renaming the file to .jsx fixes the issue. I spent hours trying to figure out the problem. Some better error messaging would be nice here.

To Reproduce

Happens in sandbox project with React and Vite.

System

No response

Additional context

No response

Contributor guide

Tech stack
javascripttypescriptreactvite
Domain
frontenddeveloper experience
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
StorybookViteJavaScript/JSX
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
The fix involves improving the error message when JSX is detected in a .js file. The error originates from the inject export order plugin in the storybook/builder vite package. The solution could add a validation step to check for JSX before the es module lexer parse, and provide a more descriptive error suggesting renaming to .jsx. Look at the source file at @storybook/builder vite or the inject export order plugin. Consider using Babel or a simple regex to detect JSX.