Releases: PowerShell/PSReadLine
PSReadLine v2.1.0-beta1 Release
v2.1.0-beta1 - 4/7/2020
You can get the v2.1.0-beta1 version of the PSReadLine module from PowerShell Gallery.
This release includes the prototype to support the fish-like auto-suggestion in PSReadLine.
Currently:
- The only suggestion source is the
PSReadLinehistory file.
The ultimate goal is to call into a prediction API in PowerShell engine that is powered by a prediction plugin. - By default, the suggestion text is rendered with the
dark blackcolor\x1b[38;5;238m, which works OK with a black background.
You can change it by runningSet-PSReadLineOption -Colors @{ Prediction = '<your-choice-of-color>' }. - VI mode - now the suggestion is disabled when switching to the command mode, and enabled when switching to insert mode.
- Very limited efforts have been spent on the VI/Emacs experience, so it could be pretty raw for them, and feedback is very welcome.
When using this version of PSReadLine, please add the following key binding to your profile:
Set-PSReadLineKeyHandler -Key "Ctrl+f" -Function ForwardWord
- Pressing
RightArrowat the end of current typing will accept the suggestion text - Pressing
Ctrl+fat the end of current typing will accept a word from the suggestion text - Pressing
Ctrl+zwill get you back to where you were before accepting all or part of the suggestion
PSReadLine v2.0.1 Release
v2.0.1 - 3/31/2020
You can get the v2.0.1 version of the PSReadLine module from PowerShell Gallery.
This release includes the following changes:
- Correct the default foreground and background colors so the appropriate default value is set for
SelectionColor(#1435) - Add the
-Chordparameter toGet-PSReadLineKeyHandlerto allow searching for specific key bindings (#1298) (Thanks @theaquamarine) - Update docs to reflect the new
-Chordparameter toGet-PSReadLineKeyHandler(#1438)
PSReadLine v2.0.0 GA Release
v2.0.0 - 2/11/2020
You can get the v2.0.0 version of the PSReadLine module from PowerShell Gallery.
This release includes the following changes:
- Name the
ReadKeythread for debug purpose (#1313) - Compliance: Update the .NET Core version and PowerShell SDK package (#1320)
- Build: Enable F5 debugging of PSReadLine in Visual Studio (#1319) (Thanks @theaquamarine)
- Build: Simply the way to get semantic version information in build (#1324)
RC2 of PSReadLine 2.0
v2.0.0-rc2 - 1/14/2020
You can get the v2.0.0-rc2 version of the PSReadLine module from PowerShell Gallery.
This release includes the following bug fixes:
- Add
ProjectUriin module manifest (#1245) - Fix docs to note the
-PromptTextparameter ofSet-PSReadLineOptionis now of theString[]type (#1244) (Thanks @heaths) - Update key bindings in sample and docs now that the
Shiftkey is inferred (#1248) - Update
HelpInfoURIof thePSReadLinemodule to point to latest help content (#1251) - Fix
RepeatLastCharSearchandRepeatLastCharSearchBackwardsto not flip their functionalities (#1253) (Thanks @mikebattista) - Fix the exception when searching history with
ctrl+rorctrl+s(#1256) - Preserve and clear the saved current line properly to make the history operations work as expected (#1259)
- Update release build with compliance tasks (#1260)
- Update README.md to put
PSReadLineandPowerShellGetin backtick quotes (#1280) - Fix a few VI edit mode issues (#1262)
- Fix and enhance
SmartInsertQuoteto work better with closing braces, keywords and variables (#1288, #1289) (Thanks @theaquamarine) - Allow
InsertPairedBracesto wrap selected text (#1293) (Thanks @theaquamarine)
RC1 of PSReadLine 2.0
v2.0.0-rc1 - 12/11/2019
You can get the v2.0.0-rc1 version of the PSReadLine module from PowerShell Gallery.
This release includes the following bug fixes:
- Fix an assertion in debug build that crashes PSReadLine (#1199) (Thanks @springcomp)
- Fix an
IndexOutOfRangeExceptionin VI mode (#1200) (Thanks @springcomp) - Improve handling of color in prompts (#1180) (Thanks @lzybkr)
- Fix an 'ArgumentOutOfRangeException' when error prompt contains CJK (#1206)
- Add instructions for updating
PowerShellGetfor Windows PowerShell users (#1222) (Thanks @espoelstra) - Correct cursor positioning (#1221) (Thanks @msftrncs)
- Utilize LengthInBufferCells when creating Completions Menu (#1214) (Thanks @msftrncs)
- Ensure the desired column number is used while moving up or down in VI mode (#1122) (Thanks @springcomp)
- Make the continuation prompt's color sequence always explicitly specified (#1238)
Beta6 of PSReadLine 2.0
v2.0.0-beta6 - 11/14/2019
You can get the v2.0.0-beta6 version of the PSReadLine module from PowerShell Gallery.
This release includes the following bug fixes:
- Fix
GenerateRenderto not throwIndexOutOfRangeExceptionandNullReferenceException(#1049) - Filter sensitive history items and avoid writing them to the history file (#1058, #1061, #1068)
- Clear the previous menu rendering correctly (#1073)
- Fix correct way to get substring based on buffercells when encountering
CJKchars (#1100) - Correct cursor jumping from line 2 to line 1 due to line 1 being empty (#1108) (Thanks @msftrncs)
- In VI mode, moving left or right should stick cursor on logical line (#1120) (Thanks @springcomp)
- Fix for a
NullReferenceExceptionthrown whenPSEScallsForcePSEventHandling(#1097) - Return error if color property or value is invalid with
Set-PSReadLineOption -Colors(#1124) - Handle cursor being moved off the end of buffer in
MoveCursor(#1146) (Thanks @msftrncs) - Supporting line-wise yanks, including paste and undo (#811) (Thanks @springcomp)
MoveCursorshould not callSetCursorPositionwhen there is a pending rendering (#1141) (Thanks @msftrncs)- Fix
y$to yank to the end of the logical line instead of to the end of the whole buffer (#1168) (Thanks @springcomp) - Make
y0yank up to the start of the logical line inVImode (#1167) (Thanks @springcomp) - Fix
NullReferenceExceptioninOnBreak(#1179) (Thanks @lzybkr) - Set cursor via the public API
SetCursorPositioninAcceptLineImplfor better buffer check (#1182) (Thanks @msftrncs)
Beta5 of PSReadLine 2.0
v2.0.0-beta5 - 09/13/2019
You can get the v2.0.0-beta5 version of the PSReadLine module from PowerShell Gallery.
This release includes the following bug fixes:
- Handle the dead key on Windows properly (#933, #945)
- Fix duplicate menu at end of buffer (#937) (Thanks @parkovski)
- Get Buffer Info as part of the Environment data in bug reporting (#942)
- Add API to detect if the screen reader is active (#947)
- Fix
ArgumentOutOfRangeExceptionthrown when changing color of the error prompt (#967) - Fix the
ArgumentOutOfRangeExceptioncaused by top of the text being scrolled up-off the buffer (#979) - Add the missing single curly quote and double curly quote to
IsSingleQuoteandIsDoubleQuotechecks (#985) (Thanks @msftrncs) - Fix the color of operator token in the
ArgumentModein syntax highlighting (#1003) (Thanks @msftrncs) - Prioritize highlight of command names, prevent bleed from aligned nested tokens in syntax highlighting (#989) (Thanks @msftrncs)
- Prevent
ArgumentOutOfRangeExceptionwhen showing the tab completion menu (#984) (Thanks @msftrncs) - Make
PageUp/PageDownandCtrlPageUp/CtrlPageDownwindows only (#1032) - Fix
UpArrowwhen the cursor is at the end of a wrapped line in a multiple-line text (#1028)
Beta1 of PSReadLine 2.0
This is the first release from the repo supporting both PowerShell Core (all platforms) and Windows PowerShell.
The single zip file should work on platforms where PowerShell is supported, though testing on non-Windows platforms has been limited.
### Version 2.0
Pre-release notes:
There are known issues:
* Some custom key bindings are broken (#580)
Breaking changes:
* Requires PowerShell V5 or later and .Net 4.6.1
* Set-PSReadLineOption options have changed
- To specify colors, use the new `-Color` parameter and pass a Hashtable
- All other color options have been removed include `-ResetTokenColors`
- To specify background colors, you must now use a VT escape sequence.
* Changing the end of the prompt to red may not work automatically anymore if
your prompt is non-trivial. To fix, use `Set-PSReadLineOption -PromptText "> "`.
* Consistently use `PSReadLine` instead of `PSReadline` everywhere, APIs, cmdlets, files, etc.
* Building requires VS2017
New features:
* Interactive filtering during menu complete (#515) (Thanks @MVKozlov!)
* Redirected input now works (#564) (Thanks @parkovski!)
* Tooltips always on in MenuComplete (only displayed
if they give more information than the completion.)
* Get-PSReadLineKeyHandler output is grouped by category. (#114)
* Support for VT escape sequences to specify colors.
* Shift+Insert bound to Paste in Windows mode (#484)
* Ctrl+t bound to SwapCharacters in Emacs mode (#538) (Thanks andrewcromwell!)
* Ctrl+x,Ctrl+e bound to ViEditVisually in Emacs mode (#478)
* HistoryNoDuplicates is now on by default (#208)
Bug fixes:
* DeleteChar no longer deletes any text left of the cursor in Windows/Emacs
and matches vim behavior of working like <x> in command mode.
* Fix InvokePrompt when the prompt is > 1 line.
* Fix YankToPercent off by 1 error.
* Fix error reported when running in container.
* Catch and ignore execptions in InvokePrompt (#583)
* Get new completions on 2nd tab if 1st had 1 result (#238)
* Tab replaced with 4 spaces during paste (#144)
* Fix rendering after buffer resize (#418)
* Invoke external editor w/o AcceptLine (#339)
* Fix exception with UpArrow after a command line edit in vi-mode (#573) (Thanks @srdubya!)
* Treat DingDuration=0 as BellStyle.None (#364)
* Color long name parameters like --force as a parameter (#398)
* Allow CaptureScreen to be used w/o a key binding (#419)
* Ignore duplicates during tab completion (#413)
* Fix exception with negative count in Delete (#502)
* Use correct help file name (#507)
* Fix exception in ShowKeyBinding w/ custom handler (#505)
* Normalize filename for saving history (#512)
* Treat end of buffer as whitespace for vi words (#536)
* Fix exception with invalid CompletionResult (#534)
* Fix exception with negative count in Kill* (#540) (Thanks andrewcromwell!)
* Fixes to SwapCharacters (#538) (Thanks andrewcromwell!)
* Fix cursor placement with CJK characters (#542)
* Fix key bindings with certain Windows keyboard layouts (#168 #556)
* Remove Ding from Backspace on an empty line (#422)
* Fix occasional hang reading history file (#524)
* HistorySearchCursorMovesToEnd previously only worked in incremental search.
It is now on by default, honored in the non-incremental search (HistorySearch)
and also in Vi Command mode for non-search history recall. (#438 #530) (Thanks @srdubya!)
Win10 compatibility, vi mode, and bug fixes
This release is compatible with what shipped in Win10. Notable changes (and possibly breaking if coming from v1.0.0.13):
- Vi mode now supported
- Namespace change (relevant for custom key handlers) (same as in Win10)
- Default location of history file has moved (same as in Win10)
V1.0.0.13
This release contains mostly bug fixes, see https://raw.githubusercontent.com/lzybkr/PSReadLine/master/PSReadLine/Changes.txt for details.