Skip to content

Commit 22bb84c

Browse files
authored
Move PSReadLine release notes to new article (MicrosoftDocs#11412)
* Move PSReadLine release notes to new article * Fix broken links * Fix description
1 parent b6dabac commit 22bb84c

File tree

12 files changed

+858
-415
lines changed

12 files changed

+858
-415
lines changed

reference/5.1/PSReadLine/About/about_PSReadLine.md

Lines changed: 20 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: PSReadLine provides an improved command-line editing experience in the PowerShell console.
33
Locale: en-US
4-
ms.date: 11/14/2023
4+
ms.date: 09/17/2024
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-5.1&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine
@@ -13,10 +13,22 @@ title: about_PSReadLine
1313
PSReadLine provides an improved command-line editing experience in the
1414
PowerShell console.
1515

16+
There have been many updates to PSReadLine since the version that ships in
17+
Windows PowerShell 5.1.
18+
19+
- v2.3.5 first shipped in PowerShell 7.4.2 and 7.5.0-preview.3
20+
- v2.3.4 first shipped in PowerShell 7.4.0-rc.1
21+
- v2.2.6 first shipped in PowerShell 7.3.0
22+
- v2.1.0 first shipped in PowerShell 7.2.5
23+
- v2.0.4 first shipped in PowerShell 7.0.11
24+
- v2.0.0 ships in Windows PowerShell 5.1
25+
26+
For more information about version differences, see
27+
[about_PSReadLine_Release_Notes](about_PSReadLine_Release_Notes.md).
28+
1629
## Long Description
1730

18-
PowerShell 5.1 ships with PSReadLine 2.0.0. The current version is PSReadLine
19-
2.3.4. The current version of PSReadLine can be installed and used on Windows
31+
The current version of PSReadLine can be installed and used on Windows
2032
PowerShell 5.1 and newer. For some features, you need to be running PowerShell
2133
7.2 or higher.
2234

@@ -110,7 +122,8 @@ APIs are documented in [about_PSReadLine_Functions][02].
110122

111123
### Command History
112124

113-
PSReadLine maintains a history file containing all the commands and data you've entered from the command line. The history files are a file named
125+
PSReadLine maintains a history file containing all the commands and data you've
126+
entered from the command line. The history files are a file named
114127
`$($host.Name)_history.txt`. On Windows systems the history file is stored at
115128
`$env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`.
116129

@@ -202,87 +215,6 @@ az account get-access-token --resource=https://app.contoso.com --query accessTok
202215
$env:PGPASS = gcloud auth print-access-token
203216
```
204217

205-
### PSReadLine release history
206-
207-
There have been many updates to PSReadLine since the version that ships in
208-
Windows PowerShell 5.1.
209-
210-
- Current release is PSReadLine 2.3.4
211-
- PowerShell 7.4 ships with PSReadLine 2.3.4
212-
- PowerShell 7.3 ships with PSReadLine 2.2.6
213-
- PowerShell 7.2 ships with PSReadLine 2.1.0
214-
- PowerShell 7.0.11 shipped with PSReadLine 2.0.4
215-
- PowerShell 5.1 ships with PSReadLine 2.0.0
216-
217-
For a full list of changes, see the PSReadLine [ChangeLog][04].
218-
219-
- **PSReadLine 2.3.4**
220-
221-
In addition to several bug fixes, this release includes the following
222-
enhancements:
223-
224-
- Scrollable **ListView** for Predictive IntelliSense
225-
- Autoadjusts the size based on the size of the terminal window
226-
- Can contain up to 50 prediction results
227-
- Dynamic list header that shows the number of results and the current
228-
prediction source
229-
- Improved sensitive history scrubbing to allow retrieving token from `az`,
230-
`gcloud`, and `kubectl`
231-
- Improve the default sensitive history scrubbing to allow safe property access
232-
- Added support for upcasing, downcasing, and capitalizing words
233-
- Make tab completion show results whose `ListItemText` are different by case
234-
only
235-
- Supports the text-object command `<d,i,w>` in the VI edit mode
236-
- Change default color for inline prediction to dim
237-
- Add a sample to README for transforming Unicode code point to Unicode char by
238-
`Alt+x`
239-
- Add the TerminateOrphanedConsoleApps option on Windows to kill orphaned
240-
console-attached process that may mess up reading from Console input
241-
242-
- **PSReadLine 2.2.6**
243-
244-
In this release, the Predictive IntelliSense feature is enabled by default
245-
depending on the following conditions:
246-
247-
- If Virtual Terminal (VT) is supported and PSReadLine running in PowerShell
248-
7.2 or higher, **PredictionSource** is set to `HistoryAndPlugin`
249-
- If VT is supported and PSReadLine running in PowerShell prior to 7.2,
250-
**PredictionSource** is set to `History`
251-
- If VT isn't supported, **PredictionSource** is set to `None`
252-
253-
- **PSReadLine 2.2.5**
254-
255-
Official servicing release with minor bug fixes.
256-
257-
- **PSReadLine 2.2.2**
258-
259-
- PSReadLine added two new predictive IntelliSense features:
260-
- Added the **PredictionViewStyle** parameter to allow for the selection of
261-
the new `ListView`.
262-
- Connected PSReadLine to the `CommandPrediction` APIs introduced in
263-
PowerShell 7.2 to allow a user can import a predictor module that can
264-
render the suggestions from a custom source.
265-
- Updated to use the 1.0.0 version of `Microsoft.PowerShell.Pager` for
266-
dynamic help
267-
- Improved the scrubbing of sensitive history items
268-
- Lots of bug fixes and smaller improvements
269-
270-
- **PSReadLine 2.1.0**
271-
272-
This release rolls up the following enhancements added since the 2.0.4
273-
release:
274-
275-
- Add Predictive IntelliSense suggestions from the command history
276-
- Many bug fixes and API enhancements
277-
278-
- **PSReadLine 2.0.4**
279-
280-
This release rolls up the following enhancements added since the 2.0.0
281-
release:
282-
283-
- Added the `-Chord` parameter to `Get-PSReadLineKeyHandler` to allow
284-
searching for specific key bindings
285-
286218
### Feedback & contributing to PSReadLine
287219

288220
[PSReadLine on GitHub][03]
@@ -291,11 +223,10 @@ Feel free to submit a pull request or submit feedback on the GitHub page.
291223

292224
## See Also
293225

294-
- PSReadLine is heavily influenced by the GNU [readline][05] library.
226+
- PSReadLine is heavily influenced by the GNU [readline][04] library.
295227

296228
<!-- link references -->
297-
[01]: /powershell/module/psreadline/set-psreadlineoption#example-7-use-historyhandler-to-filter-commands-added-to-history
229+
[01]: xref:PSReadLine.Set-PSReadLineOption#example-7-use-historyhandler-to-filter-commands-added-to-history
298230
[02]: about_PSReadLine_Functions.md
299231
[03]: https://github.com/PowerShell/PSReadLine
300-
[04]: https://github.com/PowerShell/PSReadLine/blob/master/PSReadLine/Changes.txt
301-
[05]: https://tiswww.case.edu/php/chet/readline/rltop.html
232+
[04]: https://tiswww.case.edu/php/chet/readline/rltop.html
Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
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

reference/5.1/PSReadLine/PSReadLine.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Help Version: 5.2.0.0
44
Locale: en-US
55
Module Guid: 5714753b-2afd-4492-a5fd-01d9e2cff8b5
66
Module Name: PSReadLine
7-
ms.date: 12/04/2023
7+
ms.date: 09/17/2024
88
schema: 2.0.0
99
title: PSReadLine
1010
---
@@ -18,11 +18,15 @@ editing environment in PowerShell.
1818
There have been many updates to PSReadLine since the version that ships in
1919
Windows PowerShell 5.1.
2020

21-
- PowerShell 7.4.0 ships with PSReadLine 2.3.4
22-
- PowerShell 7.3.0 ships with PSReadLine 2.2.6
23-
- PowerShell 7.2.5 ships with PSReadLine 2.1.0
24-
- PowerShell 7.0.11 ships with PSReadLine 2.0.4
25-
- PowerShell 5.1 ships with PSReadLine 2.0.0
21+
- v2.3.5 first shipped in PowerShell 7.4.2 and 7.5.0-preview.3
22+
- v2.3.4 first shipped in PowerShell 7.4.0-rc.1
23+
- v2.2.6 first shipped in PowerShell 7.3.0
24+
- v2.1.0 first shipped in PowerShell 7.2.5
25+
- v2.0.4 first shipped in PowerShell 7.0.11
26+
- v2.0.0 ships in Windows PowerShell 5.1
27+
28+
For more information about version differences, see
29+
[about_PSReadLine_Release_Notes](about/about_PSReadLine_Release_Notes.md).
2630

2731
These articles document version 2.0.0 of PSReadLine.
2832

0 commit comments

Comments
 (0)