Skip to content
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.

Sign up for GitHub

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

Docs: Add PowerShell Support Statement #2201

Merged
merged 3 commits into from
Nov 18, 2024
Merged

Docs: Add PowerShell Support Statement #2201

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
671cb37
Docs: Add PowerShell Support Statement
JustinGrote Nov 18, 2024
c960bf9
Docs: Clarify Azure Data Studio and outside support
JustinGrote Nov 18, 2024
5d2c456
Docs: Clarify LSP client support
JustinGrote Nov 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,25 @@ experience in almost any editor or integrated development environment (IDE).

## [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) clients using PowerShell Editor Services:

- [PowerShell for Visual Studio Code](https://github.com/PowerShell/vscode-powershell)
> [!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](#Usage) with your client if possible.

- [PowerShell for Visual Studio Code](https://github.com/PowerShell/vscode-powershell), also available in Azure Data Studio
- [lsp-pwsh](https://github.com/emacs-lsp/lsp-mode/blob/master/clients/lsp-pwsh.el), an Emacs PowerShell plugin
- [intellij-powershell](https://github.com/ant-druha/intellij-powershell), adds PowerShell language support to IntelliJ-based IDEs
- [coc-powershell](https://github.com/yatli/coc-powershell), a Vim and Neovim plugin
- [powershell.nvim](https://github.com/TheLeoP/powershell.nvim) a Neovim plugin

Please note that other than PowerShell for Visual Studio Code, these clients are community maintained and may be very out of date.
It is recommended that you simply use an LSP plugin for your editor and configure it as demonstrated [below](#Usage).
## Supported PowerShell Versions

PSES runs as a PowerShell Module in [currently supported versions of PowerShell 7+](https://learn.microsoft.com/en-us/powershell/scripting/install/powershell-support-lifecycle).

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

## Features

Expand Down Expand Up @@ -146,7 +155,8 @@ The types of PowerShell Editor Services can change at any moment and should not

## Development

> NOTE: The easiest way to manually test changes you've made in PowerShellEditorServices is to follow the [vscode-powershell development doc](https://github.com/PowerShell/vscode-powershell/blob/main/docs/development.md) to get a local build of the VS Code extension to use your local build of PowerShellEditorServices.
> [!TIP]
> The easiest way to manually test changes you've made in PowerShellEditorServices is to follow the [vscode-powershell development doc](https://github.com/PowerShell/vscode-powershell/blob/main/docs/development.md).

### 1. Install PowerShell 7+

Expand Down