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

CLI: Deprecate --mdx option #12285

Closed
tooppaaa opened this issue Aug 27, 2020 · 6 comments
Closed

CLI: Deprecate --mdx option #12285

tooppaaa opened this issue Aug 27, 2020 · 6 comments
Labels
cli maintenance User-facing maintenance tasks mdx
Milestone
6.1 essentials

Comments

@tooppaaa
Copy link
Contributor

Part of the CLI revamping, we added addon-essentials and a Introduciton.mdx story.

This bring the question, should we deprecate --mdx completely ?

Refers to: #12252

Pros:

  • Only a few framework had it implemented
  • Shows the capacity to include stories from MDX

Cons

  • Loose demo of creating stories in MDX directly
@shilman
Copy link
Member

shilman commented Aug 28, 2020 •
edited

We should probably deprecate it now and get rid of it in 7.0 for simplicity's sake.

@ndelangen @tmeasday thoughts?

@tmeasday
Copy link
Member

I suspect folks ain't using such options

@tooppaaa tooppaaa changed the title CLI: should we deprecate --mdx format ? CLI: Deprecate --mdx option Aug 28, 2020
@tooppaaa
Copy link
Contributor Author

Objective is to make option no-op with a warning. It should fallback to detect ts or js.

@shilman
Copy link
Member

shilman commented Aug 28, 2020

That makes sense @tooppaaa. Great solution. 💯

@tooppaaa tooppaaa added maintenance User-facing maintenance tasks and removed discussion maintenance User-facing maintenance tasks labels Aug 28, 2020
@stale
Copy link

stale bot commented Sep 20, 2020

Hi everyone! Seems like there hasn't been much going on in this issue lately. If there are still questions, comments, or bugs, please feel free to continue the discussion. Unfortunately, we don't have time to get to every issue. We are always open to contributions so please send us a pull request if you would like to help. Inactive issues will be closed after 30 days. Thanks!

@stale stale bot added the inactive label Sep 20, 2020
@shilman shilman added the todo label Sep 22, 2020
@stale stale bot removed the inactive label Sep 22, 2020
@shilman shilman added the maintenance User-facing maintenance tasks label Sep 22, 2020
@shilman shilman added this to the 6.1 essentials milestone Sep 22, 2020
@tooppaaa tooppaaa mentioned this issue Oct 25, 2020
Merged
@shilman
Copy link
Member

shilman commented Oct 26, 2020

Ooh-la-la!! I just released https://github.com/storybookjs/storybook/releases/tag/v6.1.0-alpha.30 containing PR #12905 that references this issue. Upgrade today to the @next NPM tag to try it out!

npx sb upgrade --prerelease

Closing this issue. Please re-open if you think there's still more to do.

@shilman shilman closed this as completed Oct 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cli maintenance User-facing maintenance tasks mdx
Projects
None yet
Milestone
6.1 essentials
Development

No branches or pull requests
3 participants
@tmeasday @shilman @tooppaaa