Clarify uses for results of `Get-PSReadLineOptions`
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
Research direction
Start by locating the implementation and output formatting for Get-PSReadLineOption, then compare it with the formatting used by Get-PSReadLineKeyHandlers. Determine how color-specific keys should be distinguished from other options and confirm whether the proposed presentation preserves existing behavior; done means the output clearly explains which keys Set-PSReadLineOption -Colors accepts.
Written by the indexing model from the issue text.
Description
Prerequisites
- Write a descriptive title.
Description of the new feature/enhancement
When I was exploring some of the coloring options available in PSReadLine I was confused when the options I got from Get-PSReadLine were not working when I did Set-PSReadLineOption -Colors @{<KEY>='Green'} . The options were expressed like "Color" but in order for them to work you just need "". An example of this confusion can be seen in screenshot below:

Proposed technical implementation details (optional)
Have more clear formatting to show the color options verses the other options available in PSReadLine, perhaps a header showing these are color specific keys. Maybe utilize the same formatting that Get-PSReadLineKeyHandlers use.
i.e
PS /Users/stevenbucher> Get-PSReadLineOption
Editmode
=======
Option Value Description
--- -------- -----------
EditMode : Emacs. Some description
History Options
============
AddToHistoryHandler : System.Func`2[System.String,System.Object]
HistoryNoDuplicates : True
HistorySavePath : /Users/stevenbucher/.local/share/powershell/PSReadLine/ConsoleHost_history.txt
HistorySaveStyle : SaveIncrementally
HistorySearchCaseSensitive : False
HistorySearchCursorMovesToEnd : False
MaximumHistoryCount : 4096
....
Color Options
==========
Option Value Description
--- -------- -----------
Command : "`e[93m" PowerShell Cmdlets
Comment : "`e[32m"
ContinuationPrompt : "`e[37m"
DefaultToken : "`e[37m"
Emphasis : "`e[96m"
Error : "`e[91m"
InlinePrediction : "`e[38;5;238m"
Keyword : "`e[92m"
ListPrediction : "`e[92m"
ListPredictionSelected : "`e[48;5;238m"
Member : "`e[97m"
Number : "`e[97m"
Operator : "`e[90m"
Parameter : "`e[90m"
Selection : "`e[30;47m"
String : "`e[36m"
Type : "`e[37m"
Variable : "`e[92m"
Very rough design but just a thought for potential way to do this.
NOTE: this would be a breaking change so may not be worth however my personal preference is having more detailed and categorization of these options.
- Dominant language
- C#
- Stars
- 4.4k
- Forks
- 341
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from PowerShell/PSReadLine
-
Needs-Triage :mag:
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
PowerShell/PSReadLine#5205 ·
-
Needs-Triage :mag:
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
PowerShell/PSReadLine#5195 ·
-
Needs-Triage :mag:
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
PowerShell/PSReadLine#5121 ·
-
Needs-Triage :mag:
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
PowerShell/PSReadLine#5045 ·
-
Area-CommandHelp Issue-Enhancement
Difficulty 1/5 Under an hour Newbie friendliness 68/100
PowerShell/PSReadLine#3470 · 3 reactions ·
All issues in PowerShell/PSReadLine
Similar issues
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 75/100
sillsdev/languageforge-lexbox#2665 ·
-
bug documentation frontend
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
azurenoops/spin_agent#975 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
:watch: Not Triaged 11.0 fundamentals/subsvc
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
dotnet/AspNetCore.Docs#37699 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
SubtitleEdit/subtitleedit#15108 · 1 comment ·