You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the need
There are a lot of repeated questions in the solidjs discord group around solid's eslinting errors. Red lines are scary.
A linting error is not the right place for detailed and nuanced descriptions, so I believe we need another space where we can go into more depth.
Suggested Solution
Add a URL to each linting-error that links to a deeper description about the linting-error and the advised way how to mitigate the error.
Additional context
I would be willing to contribute a PR to implement this feature
The text was updated successfully, but these errors were encountered:
Thanks for the suggestion, I agree that a prominent reference to troubleshooting docs would be a lot more helpful than lint warnings alone.
Have you come across the troubleshooting section in the solid/reactivity docs? It's also linked in the main README.
I used to have a link in the warnings, but the docs weren't as complete then and it bloated the message length. There is a way for VSCode to take you directly to the rule documentation from an IDE warning, but it's a little subtle.
So I think you may be right--I could just see if there's any pushback after adding the links.
A lovely, the troubleshooting section could definitely serve as the base.
I would propose a different structure, something like:
error-message 1 , p.ex The reactive variable ... should be used within JSX, a tracked scope...
case 1
example
solution
case 2
example
solution
Regarding bloat: maybe we could minimize the URL? get a subdomain from solidjs that redirects to the eslint FAQ lint.solidjs.com redirects to https://github.com/solidjs-community/eslint-plugin-solid/blob/main/docs/reactivity.md and then link w a hash-query to the error? So something like lint.solidjs.com/#1?
Describe the need
There are a lot of repeated questions in the solidjs discord group around solid's eslinting errors. Red lines are scary.
A linting error is not the right place for detailed and nuanced descriptions, so I believe we need another space where we can go into more depth.
Suggested Solution
Add a URL to each linting-error that links to a deeper description about the linting-error and the advised way how to mitigate the error.
Additional context
The text was updated successfully, but these errors were encountered: