Skip to content

Commit b20c1de

Browse files
committed
Update README.md with API deprecation statement
1 parent 2aa43c1 commit b20c1de

File tree

1 file changed

+25
-18
lines changed

1 file changed

+25
-18
lines changed

README.md

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,38 @@
11
# PowerShell Editor Services
22

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).
66

77
## Features
88

99
- The Language Service provides common editor features for the PowerShell language:
1010
- Code navigation actions (find references, go to definition)
1111
- Statement completions (IntelliSense)
1212
- Real-time semantic analysis of scripts using PowerShell Script Analyzer
13-
- Basic script evaluation
1413
- 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
2216

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
2718

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
2936

3037
| AppVeyor (Windows) | Travis CI (Linux / macOS) |
3138
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -43,13 +50,13 @@ how to use this project. You can also read our plans for future feature developm
4350

4451
## Development
4552

46-
4753
### 1. Install PowerShell if necessary
4854

4955
If you are using Windows, skip this step. If you are using Linux or macOS, you will need to
5056
install PowerShell by following [these instructions](https://github.com/PowerShell/PowerShell#get-powershell).
5157

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:
5360

5461
```
5562
brew update

0 commit comments

Comments
 (0)