Skip to content

Commit 41263f2

Browse files
authored
Update release notes for PSReadLine (#11861)
1 parent f25fe44 commit 41263f2

12 files changed

+81
-37
lines changed

reference/5.1/PSReadLine/About/about_PSReadLine.md

Lines changed: 2 additions & 1 deletion
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: 09/17/2024
4+
ms.date: 03/03/2025
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
@@ -16,6 +16,7 @@ PowerShell console.
1616
There have been many updates to PSReadLine since the version that ships in
1717
Windows PowerShell 5.1.
1818

19+
- v2.3.6 first shipped in PowerShell 7.4.7 and 7.5.0
1920
- v2.3.5 first shipped in PowerShell 7.4.2 and 7.5.0-preview.3
2021
- v2.3.4 first shipped in PowerShell 7.4.0-rc.1
2122
- v2.2.6 first shipped in PowerShell 7.3.0

reference/5.1/PSReadLine/About/about_PSReadLine_Functions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ PowerShell console.
1818
## Long Description
1919

2020
PowerShell 5.1 ships with PSReadLine 2.0.0. The current version is PSReadLine
21-
2.3.4. The current version of PSReadLine can be installed and used on Windows
21+
2.3.6. The current version of PSReadLine can be installed and used on Windows
2222
PowerShell 5.1 and newer. For some features, you need to be running PowerShell
2323
7.2 or higher.
2424

25-
This article documents the functions provided by PSReadLine. These functions
25+
This article documents the functions provided by PSReadLine 2.0.0. These functions
2626
can be bound to keystrokes for easy access and invocation.
2727

2828
## Using the Microsoft.PowerShell.PSConsoleReadLine class

reference/5.1/PSReadLine/About/about_PSReadLine_Release_Notes.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: This article contains the list of changes for each released version of PSReadLine.
33
Locale: en-US
4-
ms.date: 01/23/2025
4+
ms.date: 03/03/2025
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-5.1&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine_Release_Notes
@@ -11,7 +11,7 @@ title: about_PSReadLine_Release_Notes
1111
This is a summary of changes to the **PSReadLine** module. For a full list of
1212
changes, see the **PSReadLine** [ChangeLog][01].
1313

14-
- Current preview: v2.4.0-beta0
14+
- Current preview: v2.4.0-beta1
1515
- Current stable release: v2.3.6
1616

1717
## PSReadLine release history
@@ -29,6 +29,13 @@ Windows PowerShell 5.1.
2929

3030
## Release Notes
3131

32+
### v2.4.0-beta1 - 2025-02-28
33+
34+
- Avoid querying for cursor position when it's not necessary
35+
- Handle buffer changes made by an event handler
36+
- Update SelectCommandArgument to properly handle POSIX style options for CLI
37+
commands
38+
3239
### v2.4.0-beta0 - 2024-03-01
3340

3441
- Fix copying text to system clipboard on Linux using `xclip`
@@ -75,7 +82,8 @@ enhancements:
7582
- Add the `TerminateOrphanedConsoleApps` option on Windows to kill orphaned
7683
console-attached process that may mess up reading from Console input
7784
- De-duplicate prediction results with the history results
78-
- Make tab completion show results whose `ListItemText` are different by case only
85+
- Make tab completion show results whose `ListItemText` are different by case
86+
only
7987
- Add support for upcasing, downcasing, and capitalizing word
8088
- Handle multi-line description for parameter help content
8189

@@ -143,9 +151,11 @@ release:
143151
logical line
144152
- Rename `PredictionColor` to `InlinePredictionColor`
145153
- Allow `MaximumHistoryCount` to be set from user's profile
146-
- Add the parameter `-PredictionSource` to `Set-PSReadLineOption`, with the options `None` and `History`
154+
- Add the parameter `-PredictionSource` to `Set-PSReadLineOption`, with the
155+
options `None` and `History`
147156
- Make the functions `AcceptSuggestion` and `AcceptNextSuggestionWord` bindable
148-
- Relax the sensitive words we filter by changing `key` to `apikey` to reduce false positives
157+
- Relax the sensitive words we filter by changing `key` to `apikey` to reduce
158+
false positives
149159
- Make `ViForwardChar` able to accept suggestions
150160
- Expose `ViBackwardChar` and `ViForwardChar` as bindable functions
151161

reference/7.4/PSReadLine/About/about_PSReadLine.md

Lines changed: 2 additions & 1 deletion
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: 09/17/2024
4+
ms.date: 03/03/2025
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-7.4&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine
@@ -16,6 +16,7 @@ PowerShell console.
1616
There have been many updates to PSReadLine since the version that ships in
1717
Windows PowerShell 5.1.
1818

19+
- v2.3.6 first shipped in PowerShell 7.4.7 and 7.5.0
1920
- v2.3.5 first shipped in PowerShell 7.4.2 and 7.5.0-preview.3
2021
- v2.3.4 first shipped in PowerShell 7.4.0-rc.1
2122
- v2.2.6 first shipped in PowerShell 7.3.0

reference/7.4/PSReadLine/About/about_PSReadLine_Functions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ description: >
33
This article documents the functions provided by PSReadLine. These functions
44
can be bound to keystrokes for easy access and invocation.
55
Locale: en-US
6-
ms.date: 10/16/2023
6+
ms.date: 03/03/2025
77
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_functions?view=powershell-7.4&WT.mc_id=ps-gethelp
88
schema: 2.0.0
99
title: about_PSReadLine_Functions
@@ -18,11 +18,11 @@ PowerShell console.
1818
## Long Description
1919

2020
PowerShell 7.3 ships with PSReadLine 2.2.6. The current version is PSReadLine
21-
2.3.4. The current version of PSReadLine can be installed and used on Windows
21+
2.3.6. The current version of PSReadLine can be installed and used on Windows
2222
PowerShell 5.1 and newer. For some features, you need to be running PowerShell
2323
7.2 or higher.
2424

25-
This article documents the functions provided by PSReadLine 2.3.4. These
25+
This article documents the functions provided by PSReadLine 2.3.6. These
2626
functions can be bound to keystrokes for easy access and invocation.
2727

2828
## Using the Microsoft.PowerShell.PSConsoleReadLine class

reference/7.4/PSReadLine/About/about_PSReadLine_Release_Notes.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: This article contains the list of changes for each released version of PSReadLine.
33
Locale: en-US
4-
ms.date: 01/23/2025
4+
ms.date: 03/03/2025
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-7.4&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine_Release_Notes
@@ -11,7 +11,7 @@ title: about_PSReadLine_Release_Notes
1111
This is a summary of changes to the **PSReadLine** module. For a full list of
1212
changes, see the **PSReadLine** [ChangeLog][01].
1313

14-
- Current preview: v2.4.0-beta0
14+
- Current preview: v2.4.0-beta1
1515
- Current stable release: v2.3.6
1616

1717
## PSReadLine release history
@@ -29,6 +29,13 @@ Windows PowerShell 5.1.
2929

3030
## Release Notes
3131

32+
### v2.4.0-beta1 - 2025-02-28
33+
34+
- Avoid querying for cursor position when it's not necessary
35+
- Handle buffer changes made by an event handler
36+
- Update SelectCommandArgument to properly handle POSIX style options for CLI
37+
commands
38+
3239
### v2.4.0-beta0 - 2024-03-01
3340

3441
- Fix copying text to system clipboard on Linux using `xclip`
@@ -75,7 +82,8 @@ enhancements:
7582
- Add the `TerminateOrphanedConsoleApps` option on Windows to kill orphaned
7683
console-attached process that may mess up reading from Console input
7784
- De-duplicate prediction results with the history results
78-
- Make tab completion show results whose `ListItemText` are different by case only
85+
- Make tab completion show results whose `ListItemText` are different by case
86+
only
7987
- Add support for upcasing, downcasing, and capitalizing word
8088
- Handle multi-line description for parameter help content
8189

@@ -143,9 +151,11 @@ release:
143151
logical line
144152
- Rename `PredictionColor` to `InlinePredictionColor`
145153
- Allow `MaximumHistoryCount` to be set from user's profile
146-
- Add the parameter `-PredictionSource` to `Set-PSReadLineOption`, with the options `None` and `History`
154+
- Add the parameter `-PredictionSource` to `Set-PSReadLineOption`, with the
155+
options `None` and `History`
147156
- Make the functions `AcceptSuggestion` and `AcceptNextSuggestionWord` bindable
148-
- Relax the sensitive words we filter by changing `key` to `apikey` to reduce false positives
157+
- Relax the sensitive words we filter by changing `key` to `apikey` to reduce
158+
false positives
149159
- Make `ViForwardChar` able to accept suggestions
150160
- Expose `ViBackwardChar` and `ViForwardChar` as bindable functions
151161

reference/7.5/PSReadLine/About/about_PSReadLine.md

Lines changed: 2 additions & 1 deletion
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: 09/17/2024
4+
ms.date: 03/03/2025
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-7.5&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine
@@ -16,6 +16,7 @@ PowerShell console.
1616
There have been many updates to PSReadLine since the version that ships in
1717
Windows PowerShell 5.1.
1818

19+
- v2.3.6 first shipped in PowerShell 7.4.7 and 7.5.0
1920
- v2.3.5 first shipped in PowerShell 7.4.2 and 7.5.0-preview.3
2021
- v2.3.4 first shipped in PowerShell 7.4.0-rc.1
2122
- v2.2.6 first shipped in PowerShell 7.3.0

reference/7.5/PSReadLine/About/about_PSReadLine_Functions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ description: >
33
This article documents the functions provided by PSReadLine. These functions
44
can be bound to keystrokes for easy access and invocation.
55
Locale: en-US
6-
ms.date: 10/16/2023
6+
ms.date: 03/03/2025
77
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_functions?view=powershell-7.5&WT.mc_id=ps-gethelp
88
schema: 2.0.0
99
title: about_PSReadLine_Functions
@@ -18,11 +18,11 @@ PowerShell console.
1818
## Long Description
1919

2020
PowerShell 7.3 ships with PSReadLine 2.2.6. The current version is PSReadLine
21-
2.3.4. The current version of PSReadLine can be installed and used on Windows
21+
2.3.6. The current version of PSReadLine can be installed and used on Windows
2222
PowerShell 5.1 and newer. For some features, you need to be running PowerShell
2323
7.2 or higher.
2424

25-
This article documents the functions provided by PSReadLine 2.3.4. These
25+
This article documents the functions provided by PSReadLine 2.3.6. These
2626
functions can be bound to keystrokes for easy access and invocation.
2727

2828
## Using the Microsoft.PowerShell.PSConsoleReadLine class
@@ -557,7 +557,7 @@ Deletes backwards until given character.
557557

558558
- Vi command mode: `<d,F>`
559559

560-
### ViInsertAtBeginning
560+
### ViInsertAtBegining
561561

562562
Switch to Insert mode and position the cursor at the beginning of the line.
563563

reference/7.5/PSReadLine/About/about_PSReadLine_Release_Notes.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: This article contains the list of changes for each released version of PSReadLine.
33
Locale: en-US
4-
ms.date: 01/23/2025
4+
ms.date: 03/03/2025
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-7.5&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine_Release_Notes
@@ -11,7 +11,7 @@ title: about_PSReadLine_Release_Notes
1111
This is a summary of changes to the **PSReadLine** module. For a full list of
1212
changes, see the **PSReadLine** [ChangeLog][01].
1313

14-
- Current preview: v2.4.0-beta0
14+
- Current preview: v2.4.0-beta1
1515
- Current stable release: v2.3.6
1616

1717
## PSReadLine release history
@@ -29,6 +29,13 @@ Windows PowerShell 5.1.
2929

3030
## Release Notes
3131

32+
### v2.4.0-beta1 - 2025-02-28
33+
34+
- Avoid querying for cursor position when it's not necessary
35+
- Handle buffer changes made by an event handler
36+
- Update SelectCommandArgument to properly handle POSIX style options for CLI
37+
commands
38+
3239
### v2.4.0-beta0 - 2024-03-01
3340

3441
- Fix copying text to system clipboard on Linux using `xclip`
@@ -75,7 +82,8 @@ enhancements:
7582
- Add the `TerminateOrphanedConsoleApps` option on Windows to kill orphaned
7683
console-attached process that may mess up reading from Console input
7784
- De-duplicate prediction results with the history results
78-
- Make tab completion show results whose `ListItemText` are different by case only
85+
- Make tab completion show results whose `ListItemText` are different by case
86+
only
7987
- Add support for upcasing, downcasing, and capitalizing word
8088
- Handle multi-line description for parameter help content
8189

@@ -143,9 +151,11 @@ release:
143151
logical line
144152
- Rename `PredictionColor` to `InlinePredictionColor`
145153
- Allow `MaximumHistoryCount` to be set from user's profile
146-
- Add the parameter `-PredictionSource` to `Set-PSReadLineOption`, with the options `None` and `History`
154+
- Add the parameter `-PredictionSource` to `Set-PSReadLineOption`, with the
155+
options `None` and `History`
147156
- Make the functions `AcceptSuggestion` and `AcceptNextSuggestionWord` bindable
148-
- Relax the sensitive words we filter by changing `key` to `apikey` to reduce false positives
157+
- Relax the sensitive words we filter by changing `key` to `apikey` to reduce
158+
false positives
149159
- Make `ViForwardChar` able to accept suggestions
150160
- Expose `ViBackwardChar` and `ViForwardChar` as bindable functions
151161

reference/7.6/PSReadLine/About/about_PSReadLine.md

Lines changed: 2 additions & 1 deletion
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: 09/17/2024
4+
ms.date: 03/03/2025
55
online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-7.6&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_PSReadLine
@@ -16,6 +16,7 @@ PowerShell console.
1616
There have been many updates to PSReadLine since the version that ships in
1717
Windows PowerShell 5.1.
1818

19+
- v2.3.6 first shipped in PowerShell 7.4.7 and 7.5.0
1920
- v2.3.5 first shipped in PowerShell 7.4.2 and 7.5.0-preview.3
2021
- v2.3.4 first shipped in PowerShell 7.4.0-rc.1
2122
- v2.2.6 first shipped in PowerShell 7.3.0

0 commit comments

Comments
 (0)