The Wayback Machine - https://web.archive.org/web/20220525005104/https://github.com/styleguidist/react-styleguidist/issues/1268
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

Moved component locations should be marked as breaking changes #1268

Open
benwiley4000 opened this issue Feb 7, 2019 · 3 comments
Open

Moved component locations should be marked as breaking changes #1268

benwiley4000 opened this issue Feb 7, 2019 · 3 comments

Comments

@benwiley4000
Copy link

@benwiley4000 benwiley4000 commented Feb 7, 2019

When upgrading to the beta I got this error:

./docs_helpers/DocsWrapper.js
Module not found: Can't resolve 'react-styleguidist/lib/rsg-components/StyleGuide/StyleGuideRenderer'

When I change the path to react-styleguidist/lib/client/rgs-components... it compiled.

Since these module locations have been treated as public API (for overrides), their change in location should be documented as a breaking change.

@sapegin
Copy link
Member

@sapegin sapegin commented Feb 8, 2019

We can't guarantee that locations or APIs of internal component will never change, and we can't treat them as breaking change ether. Feel free to send a pull request to the docs to clarify that.

@okonet
Copy link
Member

@okonet okonet commented Aug 30, 2019

Maybe we should maintain a public API mapping where we expose components? Extensibility is one of the great aspects of styleguidist and I think it's a valid point that such changes should not break existing usages.

@sapegin
Copy link
Member

@sapegin sapegin commented Aug 30, 2019

This sounds great in theory but in practice I don't see it practical. And like with any “we should do”, someone will actually have to do this work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants