|
| 1 | +--- |
| 2 | +description: This article contains the list of changes for each released version of PSReadLine. |
| 3 | +Locale: en-US |
| 4 | +ms.date: 09/17/2024 |
| 5 | +online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-5.1&WT.mc_id=ps-gethelp |
| 6 | +schema: 2.0.0 |
| 7 | +title: about_PSReadLine_Release_Notes |
| 8 | +--- |
| 9 | +# about_PSReadLine_Release_Notes |
| 10 | + |
| 11 | +This is a summary of changes to the **PSReadLine** module. For a full list of |
| 12 | +changes, see the **PSReadLine** [ChangeLog][01]. |
| 13 | + |
| 14 | +- Current preview: v2.4.0-beta0 |
| 15 | +- Current stable release: v2.3.5 |
| 16 | + |
| 17 | +## PSReadLine release history |
| 18 | + |
| 19 | +There have been many updates to PSReadLine since the version that ships in |
| 20 | +Windows PowerShell 5.1. |
| 21 | + |
| 22 | +- v2.3.5 first shipped in PowerShell 7.4.2 and 7.5.0-preview.3 |
| 23 | +- v2.3.4 first shipped in PowerShell 7.4.0-rc.1 |
| 24 | +- v2.2.6 first shipped in PowerShell 7.3.0 |
| 25 | +- v2.1.0 first shipped in PowerShell 7.2.5 |
| 26 | +- v2.0.4 first shipped in PowerShell 7.0.11 |
| 27 | +- v2.0.0 ships in Windows PowerShell 5.1 |
| 28 | + |
| 29 | +## Release Notes |
| 30 | + |
| 31 | +### v2.4.0-beta0 - 2024-03-01 |
| 32 | + |
| 33 | +- Fix copying text to system clipboard on Linux using `xclip` |
| 34 | +- Tab completion uses the correct directory separator for the platform |
| 35 | +- PowerShell version 5.1 is now the minimum supported version |
| 36 | +- Get the Windows keyboard layout from the parent terminal process |
| 37 | +- Fix a few VI key handlers to correctly close the edit group |
| 38 | +- Read the history file in the streaming way to handle large files efficiently |
| 39 | + |
| 40 | +### v2.3.5 - 2024-04-02 |
| 41 | + |
| 42 | +This is a servicing release that excludes test components from SBOM generation. |
| 43 | + |
| 44 | +### v2.3.4 - 2023-10-02 |
| 45 | + |
| 46 | +In addition to several bug fixes, this release includes the following |
| 47 | +enhancements: |
| 48 | + |
| 49 | +- Scrollable **ListView** for Predictive IntelliSense |
| 50 | + - Autoadjusts the size based on the size of the terminal window |
| 51 | + - Can contain up to 50 prediction results |
| 52 | + - Dynamic list header that shows the number of results and the current |
| 53 | + prediction source |
| 54 | + - Show tooltips in the prediction list view |
| 55 | +- Improved sensitive history scrubbing to allow retrieving token from `az`, |
| 56 | + `gcloud`, and `kubectl` |
| 57 | +- Improve the default sensitive history scrubbing to allow safe property access |
| 58 | +- Added support for upcasing, downcasing, and capitalizing words |
| 59 | +- Make tab completion show results whose `ListItemText` are different by case |
| 60 | + only |
| 61 | +- Supports the text-object command `<d,i,w>` in the VI edit mode |
| 62 | +- Change default color for inline prediction to dim |
| 63 | +- Add a sample to README for transforming Unicode code point to Unicode char by |
| 64 | + `Alt+x` |
| 65 | +- Add the `TerminateOrphanedConsoleApps` option on Windows to kill orphaned |
| 66 | + console-attached process that may mess up reading from Console input |
| 67 | +- De-duplicate prediction results with the history results |
| 68 | +- Make tab completion show results whose `ListItemText` are different by case only |
| 69 | +- Add support for upcasing, downcasing, and capitalizing word |
| 70 | +- Handle multi-line description for parameter help content |
| 71 | + |
| 72 | +### v2.2.6 - 2022-06-27 |
| 73 | + |
| 74 | +In this release, the Predictive IntelliSense feature is enabled by default |
| 75 | +depending on the following conditions: |
| 76 | + |
| 77 | +- If Virtual Terminal (VT) is supported and PSReadLine running in PowerShell |
| 78 | + 7.2 or higher, **PredictionSource** is set to `HistoryAndPlugin` |
| 79 | +- If VT is supported and PSReadLine running in PowerShell prior to 7.2, |
| 80 | + **PredictionSource** is set to `History` |
| 81 | +- If VT isn't supported, **PredictionSource** is set to `None` |
| 82 | + |
| 83 | +### v2.2.5 - 2022-05-03 |
| 84 | + |
| 85 | +Official servicing release with minor bug fixes. |
| 86 | + |
| 87 | +### v2.2.3 - 2022-04-20 |
| 88 | + |
| 89 | +- Respect cancellation in `ReadOneOrMoreKeys()` |
| 90 | + |
| 91 | +### v2.2.2 - 2022-02-22 |
| 92 | + |
| 93 | +- PSReadLine added two new predictive IntelliSense features: |
| 94 | + - Added the **PredictionViewStyle** parameter to allow for the selection of |
| 95 | + the new `ListView`. |
| 96 | + - Connected PSReadLine to the `CommandPrediction` APIs introduced in |
| 97 | + PowerShell 7.2 to allow a user can import a predictor module that can |
| 98 | + render the suggestions from a custom source. |
| 99 | +- Updated to use the 1.0.0 version of `Microsoft.PowerShell.Pager` for |
| 100 | + dynamic help |
| 101 | +- Improved the scrubbing of sensitive history items |
| 102 | +- Make `Ctrl+r` and `Ctrl+s` in `Vi` edit mode work the same way as in `Emacs` |
| 103 | + edit mode |
| 104 | +- Make `d0` to delete to the start of the current logical line in a multiline |
| 105 | + buffer in VI mode |
| 106 | +- Use `d^` to delete from the first non-blank character of a logical line |
| 107 | +- VI Mode: `Undo` now leaves the cursor under the position at the start of the |
| 108 | + deletion |
| 109 | +- Make `HistorySearchBackward` and `HistorySearchForward` able to navigate the |
| 110 | + list view |
| 111 | +- Add the `SelectCommandArgument` bind-able function |
| 112 | +- Remove `LineIsMultiline` in favor of multi-line agnostic algorithms |
| 113 | +- Lots of bug fixes and smaller improvements |
| 114 | + |
| 115 | +### v2.1.0 - 2020-11-02 |
| 116 | + |
| 117 | +This release rolls up the following enhancements added since the 2.0.4 |
| 118 | +release: |
| 119 | + |
| 120 | +- Add Predictive IntelliSense suggestions from the command history |
| 121 | +- Many bug fixes and API enhancements |
| 122 | + |
| 123 | +### v2.0.4 - 2020-08-05 |
| 124 | + |
| 125 | +- vi-mode: Make `dd` deletes the logical line instead of the entire buffer |
| 126 | +- vi-mode: Add `dG` to delete to the end of multiline buffer |
| 127 | +- vi-mode: `dd` now handles single line or multiline buffers consistently |
| 128 | +- vi-mode: Make `D` and `d$` delete to the end of the current logical line |
| 129 | +- vi-mode - Make `dj` delete the current and next `n` logical lines |
| 130 | +- vi-mode: Use `dk` to delete the previous `n` logical lines and the current |
| 131 | + logical line in a multi-line buffer |
| 132 | +- vi-mode: Add `dgg` to delete from the beginning of the buffer to the current |
| 133 | + logical line |
| 134 | +- Rename `PredictionColor` to `InlinePredictionColor` |
| 135 | +- Allow `MaximumHistoryCount` to be set from user's profile |
| 136 | +- Add the parameter `-PredictionSource` to `Set-PSReadLineOption`, with the options `None` and `History` |
| 137 | +- Make the functions `AcceptSuggestion` and `AcceptNextSuggestionWord` bindable |
| 138 | +- Relax the sensitive words we filter by changing `key` to `apikey` to reduce false positives |
| 139 | +- Make `ViForwardChar` able to accept suggestions |
| 140 | +- Expose `ViBackwardChar` and `ViForwardChar` as bindable functions |
| 141 | + |
| 142 | +### v2.0.3 - 2020-07-22 |
| 143 | + |
| 144 | +- Minor bug fixes |
| 145 | + |
| 146 | +### v2.0.2 - 2020-06-05 |
| 147 | + |
| 148 | +- Run script in local scope to make PSReadLine works in PSES in |
| 149 | + `ConstrainedLanguageMode` |
| 150 | +- Other bug fixes |
| 151 | + |
| 152 | +### v2.0.1 - 2020-04-01 |
| 153 | + |
| 154 | +- Add the `-Chord` parameter to `Get-PSReadLineKeyHandler` to allow searching |
| 155 | + for specific key bindings |
| 156 | +- Other minor bug fixes |
| 157 | + |
| 158 | +### v2.0.0 - 2020-02-11 |
| 159 | + |
| 160 | +- Allow `InsertPairedBraces` to wrap selected text |
| 161 | +- Lots of bug fixes and smaller improvements |
| 162 | +- Filter sensitive history items and avoid writing them to the history file |
| 163 | +- Supporting line-wise yanks, including paste and undo |
| 164 | +- Make `y0` yank up to the start of the logical line in `VI` mode |
| 165 | +- Add API to detect if the screen reader is active |
| 166 | +- Make `PageUp/PageDown` and `CtrlPageUp/CtrlPageDown` windows only |
| 167 | +- Add script block vi mode indicator option |
| 168 | +- Support vi mode `G` and `gg` movements in multi-line buffers |
| 169 | +- Supports `_` and `$` to move to the beginning and end of the logical line in |
| 170 | + vi mode |
| 171 | +- Add `xtermjs` keybindings |
| 172 | +- Support `Ctrl+u` in vi insert mode |
| 173 | +- Enable `Ctrl+c` on non-Windows |
| 174 | +- Interactive filtering during menu complete |
| 175 | +- `Shift+Insert` bound to Paste in Windows mode |
| 176 | +- `Ctrl+t` bound to `SwapCharacters` in Emacs mode |
| 177 | +- `Ctrl+x,Ctrl+e` bound to `ViEditVisually` in Emacs |
| 178 | +- `HistoryNoDuplicates` is now on by default |
| 179 | + |
| 180 | +<!-- link references --> |
| 181 | +[01]: https://github.com/PowerShell/PSReadLine/blob/master/PSReadLine/Changes.txt |
0 commit comments