eslint-plugin-react-refresh icon indicating copy to clipboard operation
eslint-plugin-react-refresh copied to clipboard

Please add better description what it does

Open dzek69 opened this issue 8 months ago • 2 comments

Hello, I found this repo by accident, someone just used your library.

I took a look at readme and I completely don't know what this is all about.

Having only one sentence:

Validate that your components can safely be updated with fast refresh.

is probably not enough. As a new user I see some limitations, some options, but no answer for: why would a component be unsafe for fast refresh? It would be useful to indicate some sources describing the problem in the first place. Even explaining what a fast refresh is (in a form of external link, I don't suggest to put a encyclopedia in the README) could be useful.

Personally I'm not even sure if I need it, is this webpack specific feature, is my version of React using it? Previously we had hot module replacement, quick Googling suggests that fast refresh is replacing it. But I needed to scroll some results to get this information - Googling fast refresh react I get highlighted answer that Fast Refresh is a feature of React Native, which is probably a bad answer as this library is definitely not intented to be React Native only. But users may get a feeling this library is not useful for them if they are working with web.

Thanks

dzek69 avatar Oct 20 '23 09:10 dzek69