PowerShell / PowerShell/PowerShellEditorServices

Provide a way for implementations to announce supported features

Open
#615 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Area-API Issue-Enhancement
Dominant language
C#
Stars
767
Forks
266
Avg merge
3d 16h
Merged PRs (30d)
1

Description

Right now as far as I can tell there isn't a great way to tell if the editor supports a specific request. For example, if a consumer of the $psEditor API wants to request editor context with $psEditor.GetEditorContext() the only way to know if the editor supports it is to try and possibly fail.

Making things a little more complicated is every request can act a little differently. For instance, powerShell/showChoicePrompt just returns null, where as powerShell/getEditorContext will throw a NullReferenceException.

We should have an API where the editor explicitly states which requests they support. That way an extension module can send only the requests they know will work.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the $psEditor API and the handling for powerShell/getEditorContext and powerShell/showChoicePrompt named in the issue. Done means an editor can expose its supported requests and an extension module can query that information before sending requests.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, powershell
Domain
api, backend-api-design, developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.