You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -23,19 +23,19 @@ The functionality in PowerShell Editor Services is already available in the foll
23
23
- Code navigation actions (find references, go to definition)
24
24
- Statement completions (IntelliSense)
25
25
- Real-time semantic analysis of scripts using PowerShell Script Analyzer
26
-
- The Debugging Service simplifies interaction with the PowerShell debugger (breakpoints, variables, call stack, etc)
26
+
- The Debugging Service simplifies interaction with the PowerShell debugger (breakpoints, variables, call stack, etc.)
27
27
- The [$psEditor API](http://powershell.github.io/PowerShellEditorServices/guide/extensions.html) enables scripting of the host editor
28
28
- A full, terminal-based Integrated Console experience for interactive development and debugging
29
29
30
30
## Usage
31
31
32
-
Looking to integrate PowerShell Editor Services into your [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) compliant editor or client? We support two ways of connecting.
32
+
If you're looking to integrate PowerShell Editor Services into your [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) compliant editor or client, we support two ways of connecting.
33
33
34
34
### Named Pipes/Unix Domain Sockets (recommended)
35
35
36
-
If you're looking for the more feature-rich experience,
36
+
If you're looking for a more feature-rich experience,
37
37
Named Pipes are the way to go.
38
-
They give you all the benefit of the Language Server Protocol with extra capabilities that you can take advantage of:
38
+
They give you all the benefits of the Language Server Protocol with extra capabilities that you can take advantage of:
39
39
40
40
- The PowerShell Integrated Console
41
41
- Debugging using the [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/)
@@ -55,7 +55,7 @@ Once the command is run,
55
55
PowerShell Editor Services will wait until the client connects to the Named Pipe.
56
56
The `session.json` will contain the paths of the Named Pipes that you will connect to.
57
57
There will be one you immediately connect to for Language Server Protocol messages,
58
-
and one you connect to when you launch the debugger for Debug Adapter Protocol messages.
58
+
and once you connect to when you launch the debugger for Debug Adapter Protocol messages.
59
59
60
60
The Visual Studio Code, Vim, and IntelliJ extensions currently use Named Pipes.
61
61
@@ -68,7 +68,7 @@ The PowerShell Integrated Console uses the host process' Stdio streams for conso
68
68
If you want to take advantage of the PowerShell Integrated Console which automatically shares state with the editor-side,
69
69
you must include the `-EnableConsoleRepl` switch when called `Start-EditorServices.ps1`.
70
70
71
-
This is typically used if your client has the ability to create arbitrary terminals in the editor like below:
71
+
This is typically used if your client can create arbitrary terminals in the editor like below:
72
72
73
73

74
74
@@ -83,13 +83,13 @@ If you want to take advantage of debugging,
83
83
your client must support the [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/).
84
84
Your client should use the path to the debug named pipe found in the `session.json` file talked about above.
85
85
86
-
Currently only the Visual Studio Code extension supports debugging.
86
+
Currently, only the Visual Studio Code extension supports debugging.
87
87
88
88
### Stdio
89
89
90
-
Stdio is a simpler and more universal mechanism when it comes to the Language Server Protocol and is what we recommend if your editor/client doesn't need to support the PowerShell Integrated Console or debugging.
90
+
Stdio is a simpler and more universal mechanism for the Language Server Protocol. We recommend using it if your editor/client doesn't need to support the PowerShell Integrated Console or debugging.
91
91
92
-
> NOTE: Debugging and the Integrated Console are not features of the Stdio channel because each feature requires their own IO streams and since the Stdio model only provides a single set of streams (Stdio),
92
+
> NOTE: Debugging and the Integrated Console are not features of the Stdio channel because each feature requires its own IO streams and since the Stdio model only provides a single set of streams (Stdio),
93
93
> these features cannot be leveraged.
94
94
95
95
The typical command to start PowerShell Editor Services using stdio is as follows:
@@ -115,7 +115,7 @@ Please note that we only consider the following as stable APIs that can be relie
115
115
- Debug adapter protocol connection
116
116
- Start up mechanism
117
117
118
-
The types of PowerShell Editor Services can change at any moment and should not be linked against in production environment.
118
+
The types of PowerShell Editor Services can change at any moment and should not be linked against in a production environment.
119
119
120
120
## Development
121
121
@@ -168,7 +168,7 @@ This project is [licensed under the MIT License](LICENSE).
168
168
## [Code of Conduct][conduct-md]
169
169
170
170
This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code].
171
-
For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact [[email protected]][conduct-email] with any additional questions or comments.
171
+
For more information, see the [Code of Conduct FAQ][conduct-FAQ] or contact [[email protected]][conduct-email] with any additional questions or comments.
0 commit comments