-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
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
source-loader: Fix parser imports from prettier #29669
base: next
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
3 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile
@@ -1,4 +1,4 @@ | |||
import parseFlow from 'prettier/plugins/flow'; | |||
import * as parseFlow from 'prettier/plugins/flow'; | |||
|
|||
function parse(source) { | |||
return parseFlow.parsers.flow.parse(source); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logic: Unlike the JS and TS parsers, this parser has no error handling around parse() calls. Consider adding try/catch blocks for consistency.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current error handling is the reason why the TypeError
went under the radar in the first place, so I'm not sure if we should keep it or not. I'd rather leave this decision to a maintainer.
Package BenchmarksCommit: The following packages have significant changes to their size or dependencies:
|
Before | After | Difference | |
---|---|---|---|
Dependency count | 61 | 61 | 0 |
Self size | 605 KB | 587 KB | 🎉 -18 KB 🎉 |
Dependency size | 13.86 MB | 13.86 MB | 🎉 -21 B 🎉 |
Bundle Size Analyzer | Link | Link |
@storybook/angular
Before | After | Difference | |
---|---|---|---|
Dependency count | 258 | 257 | 🎉 -1 🎉 |
Self size | 362 KB | 362 KB | 🎉 -224 B 🎉 |
Dependency size | 34.49 MB | 34.20 MB | 🎉 -291 KB 🎉 |
Bundle Size Analyzer | Link | Link |
I see some CI checks are failing, but looking at the logs I can't see an obvious link with the changes I made. Should I worry about them? |
Closes #29478
What I did
After a lot of investigation, I find out that the
source-loader
code was not properly updated after bumping prettier to v3.In particular, it does not apply the following requirement from the upgrade guide:
This resulted in an error like the following when attempting to use any of the parsers,
javascript
,typescript
orflow
:This error never made its way up to the user because of the
try catch
in thejavascript
,typescript
parsers.storybook/code/lib/source-loader/src/abstract-syntax-tree/parsers/parser-ts.js
Lines 4 to 12 in 9794e35
However, setting the parser to
flow
will actually throw this error, because for some reason the flow parser does not have thetry catch
block.Anyways, fixing the import fixes the parser, which in turn fixes the
source-loader
and thestorysource
addon! 🎉Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
We can reuse the sandbox from #29478:
https://stackblitz.com/edit/github-h25xa6?file=.storybook%2Fmain.ts
In this sandbox:
code node_modules/@storybook/source-loader/dist/index.js
to edit the transpiled filesource-loader/dist/index.js
(you can get it by building the code on this PR)yarn storybook
For anyone wanting to try out the fix themselves without having to build the
source-loader
sources, here is the transpiled file (built as of version 8.4.4):Click me
Documentation
No need to update docs since its a fix.
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
bug
: Internal changes that fixes incorrect behavior.maintenance
: User-facing maintenance tasks.dependencies
: Upgrading (sometimes downgrading) dependencies.build
: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup
: Minor cleanup style change. Will not show up in release changelog.documentation
: Documentation only changes. Will not show up in release changelog.feature request
: Introducing a new feature.BREAKING CHANGE
: Changes that break compatibility in some way with current major version.other
: Changes that don't fit in the above categories.🦋 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>
Greptile Summary
Here's my efficient review of the pull request:
Updates Prettier parser imports in source-loader to use namespace imports (
import * as
) instead of default imports, fixing compatibility with Prettier v3 and restoring proper source code display in the storysource addon.code/lib/source-loader/src/abstract-syntax-tree/parsers/parser-flow.js
to use namespace import for Flow parsercode/lib/source-loader/src/abstract-syntax-tree/parsers/parser-js.js
to use namespace import for Babel parsercode/lib/source-loader/src/abstract-syntax-tree/parsers/parser-ts.js
to use namespace import for TypeScript parser