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.

Sign up for GitHub

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

Jump to bottom

Dependency update PR broke Storybook source snippets #1913

Closed
fredvisser opened this issue Mar 7, 2024 · 1 comment · Fixed by #1918
Closed

Dependency update PR broke Storybook source snippets #1913

fredvisser opened this issue Mar 7, 2024 · 1 comment · Fixed by #1918
Labels
bug Something isn't working

Comments

@fredvisser
Copy link
Contributor

🐛 Bug Report

It looks like PR #1905 was responsible for breaking Storybook source snippets. I.e.

Screenshot 2024-03-07 at 3 57 53 PM

💻 Repro or Code Sample

Source snippets worked with the "Select placeholder (#1842)" PR – Chromatic Storybook

Source snippets fail with [object Promise] with the "Dependency Updates March 2024 (#1905)" PR – Chromatic Storybook

🤔 Expected Behavior

Screenshot 2024-03-07 at 4 02 59 PM

😯 Current Behavior

Screenshot 2024-03-07 at 3 57 53 PM

💁 Possible Solution

🔦 Context

🌍 Your Environment

  • OS & Device: macOS
  • Browser: all
@fredvisser fredvisser added bug Something isn't working triage New issue that needs to be reviewed labels Mar 7, 2024
@rajsite
Copy link
Member

rajsite commented Mar 10, 2024

Prettier was updated as part of the dependency updates which formats the snippets and made their APIs async. The transform function in storybook does not support async yet and it's not on the roadmap.

@fredvisser fredvisser mentioned this issue Mar 11, 2024
Merged
1 task
rajsite added a commit that referenced this issue Mar 12, 2024
@fredvisser @rajsite
Fix transform source bug (#1918)
d8aa87d 
# Pull Request

## 🤨 Rationale

Fixes #1913 by using `js-beautify` instead of `prettier: ^3` in
`transformSource.js`.

## 👩‍💻 Implementation

1. Leverage a popular code formatting tool -
https://www.npmjs.com/package/js-beautify
2. Used the default formatting settings, as they looked correct to me.

## 🧪 Testing

Manual review of Storybook docs pages. 

## ✅ Checklist

<!--- Review the list and put an x in the boxes that apply or ~~strike
through~~ around items that don't (along with an explanation). -->

- [x] I have updated the project documentation to reflect my changes or
determined no changes are needed.

---------

Co-authored-by: rajsite <[email protected]>
@m-akinc m-akinc removed the triage New issue that needs to be reviewed label Apr 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
Nimble Design System Priorities
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix transform source bug ni/nimble
3 participants
@fredvisser @rajsite @m-akinc