Add events for PowerShell execution status (running, completed, etc). #632
Conversation
Create notification events for when the Language Server runs PowerShell scripts, so the client is informed about the status of the running script.
TylerLeonhardt
requested review from
daviwil,
TylerLeonhardt,
rkeithhill and
SeeminglyScience
| /// </summary> | ||
| /// <param name="sender">the PowerShell context sending the execution event</param> | ||
| /// <param name="e">details of the execution status change</param> | ||
| /// <returns></returns> |
There was a problem hiding this comment.
nit: maybe delete this line unless others in the file have the same
There was a problem hiding this comment.
Looking through the file and the codebase and the documentation, I noticed we didn't have as much documentation as in the PowerShell codebase (in fact, the web docs on the code base are out of date and refer to classes that no longer exist). I was thinking that anything I contribute I should document. Ideally I'd want to see comments documenting most things, just so we can make contributing easier, but for now I think some documentation is better than none.
There was a problem hiding this comment.
@rjmholt Definitely agree! Documentation is an area needs a lot of work here :)
In this case, I believe he's referring to just the empty returns tag. I'd also prefer if they were dropped to keep it consistent. If I remember correctly even if they were public API's, the rule for returns documentation doesn't hit on properties or void methods.
There was a problem hiding this comment.
Ah I see. Yes agreed!
| /// <summary> | ||
| /// The notification type for execution status change events in the message protocol | ||
| /// </summary> | ||
| /// <returns></returns> |
Create notification events for when the Language Server runs PowerShell
scripts, so the client is informed about the status of the running
script.
This can be used by the client to alert the user when a script is running.
Solves vscode-powershell #154.