Default examples #144
Default examples #144
Conversation
|
Thanks! That might be useful but I think it should be disabled by default. Not sure what to do with components with required props. I’d rather skip them or make another option to enable them.
Readme — yep, changelog — nope. |
|
Great! Agreed, probably better if it's off by default, but I did want the ability to specify the markdown file to use for the default examples. So we could either have 2-flags, which I think is unnecessarily verbose or have a flag that can be As for required prop detection, maybe I'll save that for another PR :) Thanks! |
|
I’m for a single flag ;-) |
|
@sapegin please have a look. I think this PR is ready to be merged. Let me know what you think! Thanks! |
| @@ -20,7 +20,7 @@ function getPackagePath(packageName) { | |||
| function validateWebpackConfig(webpackConfig) { | |||
| webpackConfig.module.loaders.forEach(function(loader) { | |||
| if (!loader.include && !loader.exclude) { | |||
| throw Error('Styleguidist: "include" option is missing for ' + loader.test + ' Webpack loader.'); | |||
| throw Error('Styleguidist: "include" (or "exclude") option is missing for ' + loader.test + ' Webpack loader.'); | |||
There was a problem hiding this comment.
It’s out of the scope of the PR and wouldn’t recommend using exclude, that’s why it’s not included in the warning.
There was a problem hiding this comment.
Hmm, but it satisfies the conditional you're checking. What's wrong with using exclude?
There was a problem hiding this comment.
Because exclude also works in most cases. But I believe explicit is always better than implicit. So it’s fine to use it but I don’t want to “advertise” the way I think is not the best.
There was a problem hiding this comment.
Fair enough I'll remove it from this PR
* master: Tweak title. Add examples and showcase. Move similar projects list to Wiki. Fix link. Reorganize readme. Add React Storybook and React Cards to similar projects. # Conflicts: # Readme.md
|
Thanks! 👍 |
|
Thank you! 😄 |
TL;DR Want to provide example usage automatically. This PR isn't ready to be merged, just wanted some early guidance.
I wanted a way to simply create default example usages in an existing codebase with many 'pure' components. For the most part, I found that just having something like
<COMPONENT />as example usage was sufficient, so I wanted to provide this functionality. It's clearly not very robust, but I think it's useful enough where it may be a valuable option to have for folks. In cases where it can't render the component based on the default template, just seeing an error in the styleguide was more helpful than not having any example codemirror block at all as it indicated to the developer when manually created examples would be useful.Before taking the implementation too far, however, I wanted to sense-check the approach with you, @sapegin . Please have a look and let me know if this is completely the wrong direction (very possible!) as I just spent a couple hours on this and didn't dig too deeply into the inner workings of react-styleguidist. So any direction you could provide would be very helpful before I get too far long. For example, I'm not entirely sure if it makes sense to have to pass in the
componentNameas a query param to theexample-loader, but it was the least invasive approach I could think of.Still to do:
A little more robust-ness where it can maybe detect components that have some required props? Especially for child component requirements.For another PRCHANGELOG?, etc.Thank you!