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

Better copy for the empty state message #387

Closed
okonet opened this issue Apr 12, 2017 · 5 comments
Closed

Better copy for the empty state message #387

okonet opened this issue Apr 12, 2017 · 5 comments

Comments

@okonet
Copy link
Member

okonet commented Apr 12, 2017

Right now, if SG wasn't able to locate components at the provided paths, it will try to locate them in the default path. If this also fails, the empty message will be displayed saying:

We couldn't find any components defined in your style guide config or using the default pattern src/components/**/*.js.

I believe this is a bit confusing since it displays only the default path explicitly. This made me think my config wasn't read by SG. Reading the whole message carefully explained it but I think this can be improved by showing the list of all paths where SG was trying to locate components:

We looked at following paths:
- [path 1 from user config]
- [path 2 from user config]
- [fallback default path]
but couldn't find any components. Please make sure you have your components there and try again.
@sapegin
Copy link
Member

sapegin commented Apr 12, 2017

Yeah, that was the plan, just haven’t have time to implement it yet ;-) It won’t use the default value if you have your own patterns in the config.

@okonet
Copy link
Member Author

okonet commented Apr 12, 2017

So this means the message is even more confusing then :)

@sapegin
Copy link
Member

sapegin commented Apr 12, 2017

Yeah 😬

@sapegin
Copy link
Member

sapegin commented Apr 12, 2017

Call it MVP ;-)

sapegin added a commit that referenced this issue Apr 23, 2017
## New features

### React 15.5 compatibility

No warnings when running with React 15.5.

(#389 by @ldabiralai, @kulakowka)

### New config option to change Buble configuration

New config option [compilerConfig](https://github.com/styleguidist/react-styleguidist/blob/master/docs/Configuration.md#compilerconfig).

(#392 by @dylanmoz)

### Change default dev server host to 0.0.0.0

This allows users to connect from outside their local machines.

(#374 by @Knorcedger)

## Bug fixes

* Pass resolver and handlers to `propsParser` (#377 by @stepancar)
* Use `[name]` in output filenames (#381 by @jskeate)
* Show actual glob patterns on welcome screen (#387).
* Show correct types in config validation errors (for example do not show `null` as `object`).
* Do not print clean-webpack-plugin log messages.
* Allow working without webpack config.
sapegin added a commit that referenced this issue Apr 23, 2017
## New features

### React 15.5 compatibility

No warnings when running with React 15.5.

(#389 by @ldabiralai, @kulakowka)

### New config option to change Buble configuration

New config option [compilerConfig](https://github.com/styleguidist/react-styleguidist/blob/master/docs/Configuration.md#compilerconfig).

(#392 by @dylanmoz)

### Change default dev server host to 0.0.0.0

This allows users to connect from outside their local machines.

(#374 by @Knorcedger)

## Bug fixes

* Pass resolver and handlers to `propsParser` (#377 by @stepancar)
* Use `[name]` in output filenames (#381 by @jskeate)
* Show actual glob patterns on welcome screen (#387).
* Show correct types in config validation errors (for example do not show `null` as `object`).
* Do not print clean-webpack-plugin log messages.
* Allow working without webpack config.
@KumarKelashMeghwar

This comment was marked as off-topic.

@styleguidist styleguidist locked as resolved and limited conversation to collaborators Jul 11, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants