@@ -14,20 +14,20 @@ experience in almost any editor or integrated development environment (IDE).
14
14
15
15
The functionality in PowerShell Editor Services is already available in the following editor extensions:
16
16
17
- - [ The VSCode PowerShell extension] ( https://github.com/PowerShell/vscode-powershell ) , also available in Azure Data Studio
18
- - [ coc-powershell] ( https://github.com/yatli/coc-powershell ) , a vim/neovim PowerShell plugin
19
- - [ The IntelliJ PowerShell plugin] ( https://github.com/ant-druha/intellij-powershell )
20
- - [ lsp-powershell] ( https://github.com/kiennq/lsp-powershell ) , an Emacs PowerShell plugin
17
+ - [ The VSCode PowerShell extension] ( https://github.com/PowerShell/vscode-powershell ) , also available in Azure Data Studio
18
+ - [ coc-powershell] ( https://github.com/yatli/coc-powershell ) , a vim/neovim PowerShell plugin
19
+ - [ The IntelliJ PowerShell plugin] ( https://github.com/ant-druha/intellij-powershell )
20
+ - [ lsp-powershell] ( https://github.com/kiennq/lsp-powershell ) , an Emacs PowerShell plugin
21
21
22
22
## Features
23
23
24
- - The Language Service provides common editor features for the PowerShell language:
25
- - Code navigation actions (find references, go to definition)
26
- - Statement completions (IntelliSense)
27
- - Real-time semantic analysis of scripts using PowerShell Script Analyzer
28
- - The Debugging Service simplifies interaction with the PowerShell debugger (breakpoints, variables, call stack, etc)
29
- - The [ $psEditor API] ( http://powershell.github.io/PowerShellEditorServices/guide/extensions.html ) enables scripting of the host editor
30
- - A full, terminal-based Integrated Console experience for interactive development and debugging
24
+ - The Language Service provides common editor features for the PowerShell language:
25
+ - Code navigation actions (find references, go to definition)
26
+ - Statement completions (IntelliSense)
27
+ - Real-time semantic analysis of scripts using PowerShell Script Analyzer
28
+ - The Debugging Service simplifies interaction with the PowerShell debugger (breakpoints, variables, call stack, etc)
29
+ - The [ $psEditor API] ( http://powershell.github.io/PowerShellEditorServices/guide/extensions.html ) enables scripting of the host editor
30
+ - A full, terminal-based Integrated Console experience for interactive development and debugging
31
31
32
32
## Usage
33
33
@@ -39,8 +39,8 @@ If you're looking for the more feature-rich experience,
39
39
Named Pipes are the way to go.
40
40
They give you all the benefit of the Language Server Protocol with extra capabilities that you can take advantage of:
41
41
42
- - The PowerShell Integrated Console
43
- - Debugging using the [ Debug Adapter Protocol] ( https://microsoft.github.io/debug-adapter-protocol/ )
42
+ - The PowerShell Integrated Console
43
+ - Debugging using the [ Debug Adapter Protocol] ( https://microsoft.github.io/debug-adapter-protocol/ )
44
44
45
45
The typical command to start PowerShell Editor Services using named pipes is as follows:
46
46
@@ -50,8 +50,8 @@ pwsh -NoLogo -NoProfile -Command "$PSES_BUNDLE_PATH/PowerShellEditorServices/Sta
50
50
51
51
> NOTE: In the example above,
52
52
>
53
- > - ` $PSES_BUNDLE_PATH ` is the root of the PowerShellEditorServices.zip downloaded from the GitHub releases.
54
- > - ` $SESSION_TEMP_PATH ` is the folder path that you'll use for this specific editor session.
53
+ > - ` $PSES_BUNDLE_PATH ` is the root of the PowerShellEditorServices.zip downloaded from the GitHub releases.
54
+ > - ` $SESSION_TEMP_PATH ` is the folder path that you'll use for this specific editor session.
55
55
56
56
Once the command is run,
57
57
PowerShell Editor Services will wait until the client connects to the Named Pipe.
@@ -102,8 +102,8 @@ pwsh -NoLogo -NoProfile -Command "$PSES_BUNDLE_PATH/PowerShellEditorServices/Sta
102
102
103
103
> NOTE: In the example above,
104
104
>
105
- > - ` $PSES_BUNDLE_PATH ` is the root of the PowerShellEditorServices.zip downloaded from the GitHub releases.
106
- > - ` $SESSION_TEMP_PATH ` is the folder path that you'll use for this specific editor session.
105
+ > - ` $PSES_BUNDLE_PATH ` is the root of the PowerShellEditorServices.zip downloaded from the GitHub releases.
106
+ > - ` $SESSION_TEMP_PATH ` is the folder path that you'll use for this specific editor session.
107
107
108
108
The important flag is the ` -Stdio ` flag which enables this communication protocol.
109
109
@@ -113,9 +113,9 @@ Currently, the Emacs extension uses Stdio.
113
113
114
114
Please note that we only consider the following as stable APIs that can be relied on:
115
115
116
- - Language server protocol connection
117
- - Debug adapter protocol connection
118
- - Start up mechanism
116
+ - Language server protocol connection
117
+ - Debug adapter protocol connection
118
+ - Start up mechanism
119
119
120
120
The types of PowerShell Editor Services can change at any moment and should not be linked against in production environment.
121
121
@@ -127,13 +127,13 @@ The types of PowerShell Editor Services can change at any moment and should not
127
127
128
128
Install PowerShell 7+ with [ these instructions] ( https://github.com/PowerShell/PowerShell#get-powershell ) .
129
129
130
- ### 3 . Clone the GitHub repository:
130
+ ### 2 . Clone the GitHub repository
131
131
132
- ```
132
+ ``` powershell
133
133
git clone https://github.com/PowerShell/PowerShellEditorServices.git
134
134
```
135
135
136
- ### 4 . Install [ Invoke-Build] ( https://github.com/nightroman/Invoke-Build )
136
+ ### 3 . Install [ Invoke-Build] ( https://github.com/nightroman/Invoke-Build )
137
137
138
138
``` powershell
139
139
Install-Module InvokeBuild -Scope CurrentUser
@@ -152,16 +152,16 @@ PS C:\path\to\PowerShellEditorServices> Invoke-Build Build
152
152
Open the PowerShellEditorServices folder that you cloned locally and press <kbd >Ctrl+Shift+B</kbd >
153
153
(or <kbd >Cmd+Shift+B</kbd > on macOS).
154
154
155
- ## Contributions Welcome!
155
+ ## Contributions Welcome
156
156
157
157
We would love to incorporate community contributions into this project. If you would like to
158
158
contribute code, documentation, tests, or bug reports, please read our [ Contribution Guide] ( http://powershell.github.io/PowerShellEditorServices/CONTRIBUTING.html ) to learn more.
159
159
160
160
## Maintainers
161
161
162
- - [ Patrick Meinecke] ( https://github.com/SeeminglyScience ) - [ @SeeminglyScienc ] ( http://twitter.com/SeeminglyScienc )
163
- - [ Rob Holt] ( https://github.com/rjmholt ) - [ @rjmholt ] ( https://twitter.com/rjmholt )
164
- - [ Andy Schwartzmeyer] ( https://github.com/andschwa ) - [ andschwa.com] ( https://andschwa.com/ )
162
+ - [ Patrick Meinecke] ( https://github.com/SeeminglyScience ) - [ @SeeminglyScienc ] ( http://twitter.com/SeeminglyScienc )
163
+ - [ Rob Holt] ( https://github.com/rjmholt ) - [ @rjmholt ] ( https://twitter.com/rjmholt )
164
+ - [ Andy Schwartzmeyer] ( https://github.com/andschwa ) - [ andschwa.com] ( https://andschwa.com/ )
165
165
166
166
## License
167
167
0 commit comments