Skip to content

Add links/explanations for PSScriptAnalyzer diagnostics in hover-over/lightbulb #1348

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

Closed
rjmholt opened this issue Jun 4, 2018 · 3 comments
Labels
Area-Script Analysis Issue-Enhancement A feature request (enhancement). Up for Grabs Will shepherd PRs.

Comments

@rjmholt
Copy link
Contributor

rjmholt commented Jun 4, 2018

Summary of the new feature

@bergmeister suggested that PSScriptAnalyzer rules should carry an explanation of themselves in VSCode.

If we put some work into making help for each rule available at runtime in PSScriptAnalyzer, it would probably only be a little bit more work to link it up to VSCode.

As a user I want PSScriptAnalyzer red squigglies to link to the documentation of the relevant rule (or show it in a popup) so that I can understand what PSScriptAnalyzer rule is firing and why.

Proposed technical implementation details (optional)

PSScriptAnalyzer will need a way to access its own help, either in pre-stored form or by URL. From there we could either embed the link or the help documentation itself into a popup/hover-over/lightbulby-thing.

See: PowerShell/PSScriptAnalyzer#816

@rjmholt rjmholt added Issue-Enhancement A feature request (enhancement). Area-UI labels Jun 4, 2018
@rjmholt
Copy link
Contributor Author

rjmholt commented Jun 5, 2018

It would also be nice to include a "Suppress this rule" option

@stukey
Copy link

stukey commented Jul 17, 2018

I would love to see both of these ideas implemented.

@rjmholt rjmholt added the Up for Grabs Will shepherd PRs. label Jul 17, 2018
@TylerLeonhardt
Copy link
Member

This is already implemented :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Script Analysis Issue-Enhancement A feature request (enhancement). Up for Grabs Will shepherd PRs.
Projects
None yet
Development

No branches or pull requests

3 participants