Skip to content

Latest commit

 

History

History
262 lines (179 loc) · 14.3 KB

README.md

File metadata and controls

262 lines (179 loc) · 14.3 KB

PowerShell Editor Services

CI Tests Discord Join the chat at https://gitter.im/PowerShell/PowerShellEditorServices

PowerShell Editor Services is a PowerShell module that provides common functionality needed to enable a consistent and robust PowerShell development experience in almost any editor or integrated development environment (IDE).

Language Server Protocol clients using PowerShell Editor Services

Note

PowerShell for Azure Data Studio will no longer be updated or maintained.

The functionality in PowerShell Editor Services is available in the following editor extensions:

Warning

These clients are community maintained and may be very out of date. It is recommended to use a generic LSP plugin with your client if possible.

Supported PowerShell Versions

PSES runs as a PowerShell Module in currently supported versions of PowerShell 7+.

Windows PowerShell 5.1 is supported on a best-effort basis.

Features

  • The Language Service provides common editor features for the PowerShell language:
    • Code navigation actions (find references, go to definition)
    • Statement completions (IntelliSense)
    • Real-time semantic analysis of scripts using PowerShell Script Analyzer
  • The Debugging Service simplifies interaction with the PowerShell debugger (breakpoints, variables, call stack, etc.)
  • The $psEditor API enables scripting of the host editor
  • A full, Extension Terminal experience for interactive development and debugging

Usage

If you're looking to integrate PowerShell Editor Services into your Language Server Protocol compliant editor or client, we support two ways of connecting.

Named Pipes / Unix Domain Sockets

If you're looking for a more feature-rich experience, named pipes (AKA sockets) are the way to go. They give you all the benefits of the Language Server Protocol with extra capabilities that you can take advantage of:

The typical command to start PowerShell Editor Services using named pipes / sockets is as follows:

pwsh -NoLogo -NoProfile -Command "./PowerShellEditorServices/Start-EditorServices.ps1 -SessionDetailsPath ./session.json"

The start script, Start-EditorServices.ps1, is found in the PowerShellEditorServices folder instead the PowerShellEditorServices.zip downloaded from the GitHub releases.

The session details (which named pipes were created) will be written to the given session details path, and the client needs to point to these in order to connect.

The Visual Studio Code, Vim, Neovim, and IntelliJ extensions use named pipes.

Standard Input and Output

Alternatively, the -SessionDetailsPath ./session.json argument can be replaced with just -Stdio. The use of stdio is the simplest way to connect with most LSP clients, but will limit some features, such as the debugger and Extension Terminal. This is because because these two features require their own IO streams and stdio only provides a single pair of streams.

Please see the emacs-simple-test.el, emacs-test.el, vim-simple-test.vim and vim-test.vim for examples of end-to-end tested configurations. They use eglot for Emacs and LanguageClient-neovim.

Advanced Usage

If you are trying to automate the service in PowerShell, you can also run it under Start-Process to prevent hanging your script. It also gives you access to process automation features like $process.Close() or $process.Kill(). The Start-EditorServices.ps1 script takes many more optional arguments, but they no longer need to be specified.

$command = @(
    "$PSES_BUNDLE_PATH/PowerShellEditorServices/Start-EditorServices.ps1",
        "-BundledModulesPath $PSES_BUNDLE_PATH",
        "-LogPath ./logs",
        "-SessionDetailsPath ./session.json",
        "-FeatureFlags @()",
        "-AdditionalModules @()",
        "-HostName 'My Client'",
        "-HostProfileId 'myclient'",
        "-HostVersion 1.0.0",
        "-LogLevel Trace"
) -join " "

$pwsh_arguments = "-NoLogo -NoProfile -Command $command"
$process = Start-Process pwsh -ArgumentList $arguments -PassThru
...
$process.Close(); #$process.Kill();

Once the command is run, PowerShell Editor Services will wait until the client connects to the named pipe. The session.json will contain the paths of the named pipes that you will connect to. There will be one you immediately connect to for Language Server Protocol messages, and once you connect to when you launch the debugger for Debug Adapter Protocol messages.

PowerShell Extension Terminal

image

The PowerShell Extension Terminal uses the host process' stdio streams for console input and output. Please note that this is mutually exclusive from using stdio for the Language Server Protocol messages.

If you want to take advantage of the PowerShell Extension Terminal, you must include the -EnableConsoleRepl switch when calling Start-EditorServices.ps1.

This is typically used if your client can create arbitrary terminals in the editor like below:

Extension Terminal in VS Code

The Visual Studio Code, Vim, and IntelliJ extensions currently use the PowerShell Extension Terminal.

Debugging

Debugging support is also exposed with PowerShell Editor Services. It is handled within the same process as the Language Server Protocol. This provides a more integrated experience for end users but is something to note as not many other language servers work in the same way. If you want to take advantage of debugging, your client must support the Debug Adapter Protocol. Your client should use the path to the debug named pipe found in the session.json file talked about above.

The debugging functionality in PowerShell Editor Services is available in the following editor extensions:

Rename Disclaimer

PowerShell is not a statically typed language. As such, the renaming of functions, parameters, and other symbols can only be done on a best effort basis. While this is sufficient for the majority of use cases, it cannot be relied upon to find all instances of a symbol and rename them across an entire code base such as in C# or TypeScript.

There are several edge case scenarios which may exist where rename is difficult or impossible, or unable to be determined due to the dynamic scoping nature of PowerShell.

The focus of the rename support is on quick updates to variables or functions within a self-contained script file. It is not intended for module developers to find and rename a symbol across multiple files, which is very difficult to do as the relationships are primarily only computed at runtime and not possible to be statically analyzed.

👍 Implemented and Tested Rename Scenarios

🤚 Unsupported Scenarios

  • ❌ Renaming can only be done within a single file. Renaming symbols across multiple files is not supported, even if those are dotsourced from the source file.
  • ❌ Functions or variables must have a corresponding definition within their scope or above to be renamed. If we cannot find the original definition of a variable or function, the rename will not be supported.
  • ❌ Dynamic Parameters are not supported
  • ❌ Dynamically constructed splat parameters will not be renamed/updated (e.g. $splat = @{};$splat.a = 5;Do-Thing @a)
  • ❌ Scoped variables (e.g. $SCRIPT:test) are not currently supported
  • ❌ Renaming a variable inside of a scriptblock that is used in unscoped operations like Foreach-Parallel or Start-Job and the variable is not defined within the scriptblock is not supported and can have unexpected results.
  • ❌ Scriptblocks part of an assignment are considered isolated scopes. For example $a = 5; $x = {$a}; & $x does not consider the two $a to be related, even though in execution this reference matches.
  • ❌ Scriptblocks that are part of a parameter are assumed to not be executing in a different runspace. For example, the renaming behavior will treat ForEach-Object -Parallel {$x} the same as Foreach-Object {$x} for purposes of finding scope definitions. To avoid unexpected renaming, define/redefine all your variables in the scriptblock using a param block.
  • ❌ A lot of the logic relies on the position of items, so for example, defining a variable in a begin block and placing it after a process block, while technically correct in PowerShell, will not rename as expected.
  • ❌ Similarly, defining a function, and having the function rely on a variable that is assigned outside the function and after the function definition, will not find the outer variable reference.
  • ❌ Get-Variable and Set-Variable are not considered and not currently searched for renames

📄 Filing a Rename Issue

If there is a rename scenario you feel can be reasonably supported in PowerShell, please file a bug report in the PowerShellEditorServices repository with the "Expected" and "Actual" being the before and after rename. We will evaluate it and accept or reject it and give reasons why. Items that fall under the Unsupported Scenarios above will be summarily rejected, however that does not mean that they may not be supported in the future if we come up with a reasonably safe way to implement a scenario.

API Usage

Please note that we only consider the following as stable APIs that can be relied on:

  • Language Server Protocol connection
  • Debug Adapter Protocol connection
  • Start-up mechanism

The types of PowerShell Editor Services can change at any moment and should not be linked against in a production environment.

Development Environment

Tip

The easiest way to manually test changes you've made in PowerShellEditorServices is to follow the vscode-powershell development doc.

1. Install PowerShell 7+

Install PowerShell 7+ with these instructions.

2. Clone the GitHub repository

git clone https://github.com/PowerShell/PowerShellEditorServices.git

3. Install Invoke-Build

Install-Module InvokeBuild -Scope CurrentUser
Install-Module platyPS -Scope CurrentUser

4. Adjust nuget.config if necessary

Our NuGet configuration uses a secure feed with allow-listed third party dependency packages. If your contribution requires any changes to the included NuGet packages, you must disable this secure feed.

First, run this command to prevent accidentally commiting changes to this file

git update-index --skip-worktree nuget.config

Then, either delete the file or remove the packagesources section to use nuget.org again. Your PR will fail automated build checks and you must inform us at the top of your PR so the appropriate packages can be added if approved.

Build PowerShell Editor Services

Now you're ready to build the code. You can do so in one of two ways:

PowerShell

PS C:\src\PowerShellEditorServices> Invoke-Build

Visual Studio Code

Open the PowerShellEditorServices folder that you cloned locally and press Ctrl+Shift+B (or Cmd+Shift+B on macOS) which will run the default build task.

Code of Conduct

Please see our Code of Conduct before participating in this project.

Contributions Welcome

We would love to incorporate community contributions into this project. If you would like to contribute code, documentation, tests, or bug reports, please read our Contribution Guide to learn more.

Security Note

For any security issues, please see here.

Maintainers

Emeriti

License

This project is licensed under the MIT License. Please see the third-party notices file for details on the third-party binaries that we include with releases of this project.