[🐞] ESLint rules do not point to their docs

[samijaber]

Which component is affected?

Qwik Runtime

Describe the bug

If an ESLint rule finds an issue, it will have a URL that points to https://github.com/BuilderIO/qwik instead of a more specific URL:

https://github.com/BuilderIO/qwik/blob/b98019567447814833f31e08ae9df0855fc04765/packages/eslint-plugin-qwik/src/loaderLocation.ts#L23

Reproduction

N/A

Steps to reproduce

https://github.com/BuilderIO/qwik/blob/b98019567447814833f31e08ae9df0855fc04765/packages/eslint-plugin-qwik/src/loaderLocation.ts#L23

System Info

N/A

Additional Information

I'm not sure what the best URL is for this particular eslint rule, but also some other rules also don't point to docs that explain valid/invalid code:

https://github.com/BuilderIO/qwik/blob/b98019567447814833f31e08ae9df0855fc04765/packages/eslint-plugin-qwik/src/unusedServer.ts#L10-L11

https://github.com/BuilderIO/qwik/blob/b98019567447814833f31e08ae9df0855fc04765/packages/eslint-plugin-qwik/src/useMethodUsage.ts#L12

[zanettin]

Hi @samijaber

My idea would be to offer smth similar to https://eslint.org/docs/latest/rules/. So an overview with all qwik eslint rules + a detail view where we explain good and bad examples.

i quickly hacked the overview together:

Is this going into the direction you thought about @samijaber ? And @manucorporat what do you think? continue or go with another solution instead?

[manucorporat]

i would love it so much!