Do not output helplink for custom check diags#10923
Conversation
|
Alternatively we should allow for custom checks to register a help URL as part of their definitions/reports. We can decide separately to render that or not but the ability to link to external documentation is pretty fundamental to all modern diagnostic reporting experiences (see VS and VSCode problem displays for example). |
I was woried of security concerns. But now I can see there is a prior art for this: https://learn.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.diagnosticdescriptor.helplinkuri Lm try to imporove here |
What is the concern? That users would click on links that seem trustworthy because they come from MSBuild or something else? Perhaps we could wrap the link to something like |
Yes - exactly this Let's wait with wrapping till we see some initial usages of cusom buildchecks |
Context
Buildcheck is outputing helplinks as part of its diagnostics - e.g.:
However the link is missleading for custom checks - as we do not have any help for those
Changes Made
The help link is provided only for internaly reported diagnostics
Testing
Existing tests