Skip to content

Fix some markdownlint errors in README #1416

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.

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

Merged
merged 1 commit into from
Feb 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"MD013": false,
"MD033": false
}
54 changes: 27 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,20 @@ experience in almost any editor or integrated development environment (IDE).

The functionality in PowerShell Editor Services is already available in the following editor extensions:

- [The VSCode PowerShell extension](https://github.com/PowerShell/vscode-powershell), also available in Azure Data Studio
- [coc-powershell](https://github.com/yatli/coc-powershell), a vim/neovim PowerShell plugin
- [The IntelliJ PowerShell plugin](https://github.com/ant-druha/intellij-powershell)
- [lsp-powershell](https://github.com/kiennq/lsp-powershell), an Emacs PowerShell plugin
- [The VSCode PowerShell extension](https://github.com/PowerShell/vscode-powershell), also available in Azure Data Studio
- [coc-powershell](https://github.com/yatli/coc-powershell), a vim/neovim PowerShell plugin
- [The IntelliJ PowerShell plugin](https://github.com/ant-druha/intellij-powershell)
- [lsp-powershell](https://github.com/kiennq/lsp-powershell), an Emacs PowerShell plugin

## Features

- The Language Service provides common editor features for the PowerShell language:
- Code navigation actions (find references, go to definition)
- Statement completions (IntelliSense)
- Real-time semantic analysis of scripts using PowerShell Script Analyzer
- The Debugging Service simplifies interaction with the PowerShell debugger (breakpoints, variables, call stack, etc)
- The [$psEditor API](http://powershell.github.io/PowerShellEditorServices/guide/extensions.html) enables scripting of the host editor
- A full, terminal-based Integrated Console experience for interactive development and debugging
- The Language Service provides common editor features for the PowerShell language:
- Code navigation actions (find references, go to definition)
- Statement completions (IntelliSense)
- Real-time semantic analysis of scripts using PowerShell Script Analyzer
- The Debugging Service simplifies interaction with the PowerShell debugger (breakpoints, variables, call stack, etc)
- The [$psEditor API](http://powershell.github.io/PowerShellEditorServices/guide/extensions.html) enables scripting of the host editor
- A full, terminal-based Integrated Console experience for interactive development and debugging

## Usage

Expand All @@ -39,8 +39,8 @@ If you're looking for the more feature-rich experience,
Named Pipes are the way to go.
They give you all the benefit of the Language Server Protocol with extra capabilities that you can take advantage of:

- The PowerShell Integrated Console
- Debugging using the [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/)
- The PowerShell Integrated Console
- Debugging using the [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/)

The typical command to start PowerShell Editor Services using named pipes is as follows:

Expand All @@ -50,8 +50,8 @@ pwsh -NoLogo -NoProfile -Command "$PSES_BUNDLE_PATH/PowerShellEditorServices/Sta

> NOTE: In the example above,
>
> - `$PSES_BUNDLE_PATH` is the root of the PowerShellEditorServices.zip downloaded from the GitHub releases.
> - `$SESSION_TEMP_PATH` is the folder path that you'll use for this specific editor session.
> - `$PSES_BUNDLE_PATH` is the root of the PowerShellEditorServices.zip downloaded from the GitHub releases.
> - `$SESSION_TEMP_PATH` is the folder path that you'll use for this specific editor session.

Once the command is run,
PowerShell Editor Services will wait until the client connects to the Named Pipe.
Expand Down Expand Up @@ -102,8 +102,8 @@ pwsh -NoLogo -NoProfile -Command "$PSES_BUNDLE_PATH/PowerShellEditorServices/Sta

> NOTE: In the example above,
>
> - `$PSES_BUNDLE_PATH` is the root of the PowerShellEditorServices.zip downloaded from the GitHub releases.
> - `$SESSION_TEMP_PATH` is the folder path that you'll use for this specific editor session.
> - `$PSES_BUNDLE_PATH` is the root of the PowerShellEditorServices.zip downloaded from the GitHub releases.
> - `$SESSION_TEMP_PATH` is the folder path that you'll use for this specific editor session.

The important flag is the `-Stdio` flag which enables this communication protocol.

Expand All @@ -113,9 +113,9 @@ Currently, the Emacs extension uses Stdio.

Please note that we only consider the following as stable APIs that can be relied on:

- Language server protocol connection
- Debug adapter protocol connection
- Start up mechanism
- Language server protocol connection
- Debug adapter protocol connection
- Start up mechanism

The types of PowerShell Editor Services can change at any moment and should not be linked against in production environment.

Expand All @@ -127,13 +127,13 @@ The types of PowerShell Editor Services can change at any moment and should not

Install PowerShell 7+ with [these instructions](https://github.com/PowerShell/PowerShell#get-powershell).

### 3. Clone the GitHub repository:
### 2. Clone the GitHub repository

```
```powershell
git clone https://github.com/PowerShell/PowerShellEditorServices.git
```

### 4. Install [Invoke-Build](https://github.com/nightroman/Invoke-Build)
### 3. Install [Invoke-Build](https://github.com/nightroman/Invoke-Build)

```powershell
Install-Module InvokeBuild -Scope CurrentUser
Expand All @@ -152,16 +152,16 @@ PS C:\path\to\PowerShellEditorServices> Invoke-Build Build
Open the PowerShellEditorServices folder that you cloned locally and press <kbd>Ctrl+Shift+B</kbd>
(or <kbd>Cmd+Shift+B</kbd> on macOS).

## Contributions Welcome!
## Contributions Welcome

We would love to incorporate community contributions into this project. If you would like to
contribute code, documentation, tests, or bug reports, please read our [Contribution Guide](http://powershell.github.io/PowerShellEditorServices/CONTRIBUTING.html) to learn more.

## Maintainers

- [Patrick Meinecke](https://github.com/SeeminglyScience) - [@SeeminglyScienc](http://twitter.com/SeeminglyScienc)
- [Rob Holt](https://github.com/rjmholt) - [@rjmholt](https://twitter.com/rjmholt)
- [Andy Schwartzmeyer](https://github.com/andschwa) - [andschwa.com](https://andschwa.com/)
- [Patrick Meinecke](https://github.com/SeeminglyScience) - [@SeeminglyScienc](http://twitter.com/SeeminglyScienc)
- [Rob Holt](https://github.com/rjmholt) - [@rjmholt](https://twitter.com/rjmholt)
- [Andy Schwartzmeyer](https://github.com/andschwa) - [andschwa.com](https://andschwa.com/)

## License

Expand Down