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

CLI: Add automigration for GFM in MDX #21186

Merged
merged 8 commits into from
Feb 22, 2023
Merged

CLI: Add automigration for GFM in MDX #21186

merged 8 commits into from
Feb 22, 2023

Conversation

ndelangen
Copy link
Member

Closes #20091

What I did

I've added an automigration that adds GFM support to addon-docs via adding an addon
I've created the addon that adds GFM config

The addon is a tool to assist users migrate, it's not supposed to be used indefinitely.

The reaosn we did it this way, is because it made writing the auto-migration much much much easier. User will have to do a manual step, but it should get them into a working state

How to test

After running the automigration you should get an extra addon in your addon array
You should also heb the addon added to your package.json
Your storybook should now support GFM without having to configure addon-docs.

There should be a deprecation notice in the command-loine telling you (once again) that you should perform the manual migration.

@socket-security
Copy link

Socket Security Pull Request Report

👍 No new dependency issues detected in pull request

Pull request report summary
Issue Status
Install scripts ✅ 0 issues
Native code ✅ 0 issues
Bin script confusion ✅ 0 issues
Bin script shell injection ✅ 0 issues
Shell access ✅ 0 issues
Uses eval ✅ 0 issues
Unresolved require ✅ 0 issues
Invalid package.json ✅ 0 issues
HTTP dependency ✅ 0 issues
Git dependency ✅ 0 issues
GitHub dependency ✅ 0 issues
New author ✅ 0 issues
Potential typo squat ✅ 0 issues
Known Malware ✅ 0 issues
Telemetry ✅ 0 issues
Protestware/Troll package ✅ 0 issues
AI detected malware ✅ 0 issues
Bot Commands

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of package-name@version specifiers. e.g. @SocketSecurity ignore foo@1.0.0 bar@2.4.2

Powered by socket.dev

@shilman shilman changed the title Tech: add automigration for GFM support CLI: Add automigration for GFM in MDX Feb 21, 2023
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This generally LGTM.

Two points:

  1. @yannbf should def review this as he's up on all the latest subtleties around modifying main.js
  2. any chance we can add the new addon OUTSIDE of the monorepo? i understand the reasons not to, but the monorepo is just getting bigger & bigger...

@yannbf
Copy link
Member

yannbf commented Feb 22, 2023

Good stuff @ndelangen ! I made some changes regarding bug fixes and documentation.
Still, this has to be handled: the automigration gets triggered on sb init, which isn't optimal.

@ndelangen ndelangen merged commit 5368f69 into next Feb 22, 2023
@ndelangen ndelangen deleted the norbert/gfm-migration branch February 22, 2023 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

MDX2: Add automigration for GFM support
3 participants