Skip to content

Add CodeAction support to show PSSA rule documentation #1600

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

Merged
merged 1 commit into from
Nov 15, 2018

Conversation

rkeithhill
Copy link
Contributor

This corresponds to PSES PR:
PowerShell/PowerShellEditorServices#789

Currently this points to the PSSA development branch. Maybe that should
point to the master branch. Could be a setting I suppose but that seems
like overkill.

PR Summary

PR Checklist

Note: Tick the boxes below that apply to this pull request by putting an x between the square brackets.
Please mark anything not applicable to this PR NA.

  • PR has a meaningful title
  • Summarized changes
  • PR has tests
  • This PR is ready to merge and is not work in progress
    • If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready

This corresponds to PSES PR:
PowerShell/PowerShellEditorServices#789

Currently this points to the PSSA development branch.  Maybe that should
point to the master branch.  Could be a setting I suppose but that seems
like overkill.
@rkeithhill
Copy link
Contributor Author

There is more work to do here but I thought this would be a good start. For instance, the tslint extension is adding menu entries to the context menu in the Problems view. So you can right-click there and show documentation. With the PR you have to use the Code Fix icon in the source code. Still, it's a big improvement over not having it at all. :-)

@rkeithhill
Copy link
Contributor Author

Here's an example of what this looks like:
image

@bergmeister
Copy link
Contributor

I think the development branch is OK to be used, especially since that is the branch against which PRs should be made (since I expect more people to do that now with this feature)

Copy link
Contributor

@rjmholt rjmholt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks @rkeithhill!

Copy link
Member

@TylerLeonhardt TylerLeonhardt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keith... this. is. AWESOME. People are gonna love this 😄

@rkeithhill
Copy link
Contributor Author

rkeithhill commented Nov 8, 2018

Thanks. I'll merge this right after I get the PSES PR buttoned up.

@rkeithhill rkeithhill merged commit 51f7652 into master Nov 15, 2018
@rkeithhill rkeithhill deleted the rkeithhill/add-quick-fix-show-documentation branch November 15, 2018 01:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants