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

add urls with deeper explanation to linting-errors #86

Open
1 task
bigmistqke opened this issue Mar 18, 2023 · 2 comments
Open
1 task

add urls with deeper explanation to linting-errors #86

bigmistqke opened this issue Mar 18, 2023 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@bigmistqke
Copy link

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
@bigmistqke bigmistqke added the enhancement New feature or request label Mar 18, 2023
@joshwilsonvu
Copy link
Collaborator

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.

@bigmistqke
Copy link
Author

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants