PowerShell / PowerShell/vscode-powershell

Create a documentation page for the settings

Open
#1,399 6 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area-Documentation Issue-Enhancement Up for Grabs
Dominant language
TypeScript
Stars
1.9k
Forks
547
PR merge metrics
No merged PRs in 30d

Description

It is difficult to know what settings are available in VS Code PowerShell. This should be documented!

'As a script author I want fun small parts of my scrip using F8 and then continue to immediately author.
Turns out there is a VS Code PS setting for this called "powershell.integratedConsole.focusConsoleOnExecute". If I don't know that this is I will not be able to set it. If I'm not able to set it I will have to live with having an interrupted flow from either performing an odd piece of keyboard gymnastics to get back to my script or by moving my hand to the mouse.

This is just one simple example of settings that should be documented. I'd love to know what other gold I can configure!

Proposed technical implementation details (optional)

Create a page for the documentation of all the great settings in VS Code PS! If you have that we can all link to it and you can point to it rather than explaining the same things over and over again to people who ask! This will increase the usefulness of VS Code PS for ordinary users!

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

No file, test, or documentation entry point is named in the issue. Start by locating the VS Code PowerShell extension's existing documentation and enumerating its exposed settings; done means a linked page documents the available settings, including powershell.integratedConsole.focusConsoleOnExecute, for users.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell, vscode
Domain
devtools, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.