Skip to content

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

Closed
@rjmholt

Description

@rjmholt

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions