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
+25-18Lines changed: 25 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,31 +1,38 @@
1
1
# PowerShell Editor Services
2
2
3
-
PowerShell Editor Services provides common functionality that is needed
4
-
to enable a consistent and robust PowerShell development experience
5
-
across multiple editors.
3
+
PowerShell Editor Services is a PowerShell module that provides common
4
+
functionality needed to enable a consistent and robust PowerShell development
5
+
experience in almost any editor or integrated development environment (IDE).
6
6
7
7
## Features
8
8
9
9
- The Language Service provides common editor features for the PowerShell language:
10
10
- Code navigation actions (find references, go to definition)
11
11
- Statement completions (IntelliSense)
12
12
- Real-time semantic analysis of scripts using PowerShell Script Analyzer
13
-
- Basic script evaluation
14
13
- The Debugging Service simplifies interaction with the PowerShell debugger (breakpoints, variables, call stack, etc)
15
-
- The Console Service provides a simplified interactive console interface which implements a rich PSHost implementation:
16
-
- Interactive command execution support, including basic use of native console applications
17
-
- Choice prompt support
18
-
- Input prompt support
19
-
- Get-Credential support (coming soon)
20
-
- The Extension Service provides a generalized extensibility model that allows you to
21
-
write new functionality for any host editor that uses PowerShell Editor Services
14
+
- The [$psEditor API](http://powershell.github.io/PowerShellEditorServices/guide/extensions.html) enables scripting of the host editor
15
+
- A full, terminal-based Integrated Console experience for interactive development and debugging
22
16
23
-
The core Editor Services library is intended to be consumed in any type of host application, whether
24
-
it is a WPF UI, console application, or web service. A standard console application host is included
25
-
so that you can easily consume Editor Services functionality in any editor using the JSON API that it
26
-
exposes.
17
+
### Important note regarding the .NET APIs in Microsoft.PowerShell.EditorServices.dll
27
18
28
-
## Build status of master branches
19
+
With the 1.0 release of PowerShell Editor Services, we have deprecated the public APIs
20
+
of the following classes:
21
+
22
+
- EditorSession
23
+
- LanguageService
24
+
- DebugService
25
+
- ConsoleService
26
+
- AnalysisService
27
+
- ExtensionService
28
+
- TemplateService
29
+
30
+
The intended usage model is now to host PowerShell Editor Services within powershell.exe
31
+
and communicate with it over TCP sockets via the [Language Server Protocol](https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md)
32
+
and [Debug Adapter Protocol](https://github.com/Microsoft/vscode-debugadapter-node/blob/master/protocol/src/debugProtocol.ts).
33
+
Detailed usage documentation for this module is coming soon!
34
+
35
+
## Build Status
29
36
30
37
| AppVeyor (Windows) | Travis CI (Linux / macOS) |
@@ -43,13 +50,13 @@ how to use this project. You can also read our plans for future feature developm
43
50
44
51
## Development
45
52
46
-
47
53
### 1. Install PowerShell if necessary
48
54
49
55
If you are using Windows, skip this step. If you are using Linux or macOS, you will need to
50
56
install PowerShell by following [these instructions](https://github.com/PowerShell/PowerShell#get-powershell).
51
57
52
-
If you are using macOS you will need to download the latest version of OpenSSL. The easiest way to get this is from [Homebrew](http://brew.sh/). After installing Homebrew execute the following commands:
58
+
If you are using macOS you will need to download the latest version of OpenSSL. The easiest way to get this is from
59
+
[Homebrew](http://brew.sh/). After installing Homebrew execute the following commands:
0 commit comments