From 2ce1048bc7d3beae36a3f90d1415fa140fca28b1 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Mon, 18 Aug 2025 15:29:37 -0500 Subject: [PATCH] Update release notes for PSReadLine --- .../5.1/PSReadLine/About/about_PSReadLine.md | 9 ++++-- .../About/about_PSReadLine_Release_Notes.md | 32 +++++++++++++++++-- .../7.4/PSReadLine/About/about_PSReadLine.md | 17 ++++++---- .../About/about_PSReadLine_Release_Notes.md | 32 +++++++++++++++++-- reference/7.4/PSReadLine/PSReadLine.md | 5 +-- .../7.5/PSReadLine/About/about_PSReadLine.md | 17 ++++++---- .../About/about_PSReadLine_Release_Notes.md | 32 +++++++++++++++++-- reference/7.5/PSReadLine/PSReadLine.md | 5 +-- .../7.6/PSReadLine/About/about_PSReadLine.md | 17 ++++++---- .../About/about_PSReadLine_Release_Notes.md | 32 +++++++++++++++++-- reference/7.6/PSReadLine/PSReadLine.md | 5 +-- 11 files changed, 164 insertions(+), 39 deletions(-) diff --git a/reference/5.1/PSReadLine/About/about_PSReadLine.md b/reference/5.1/PSReadLine/About/about_PSReadLine.md index 1aef42894a94..7d5d21bf70ef 100644 --- a/reference/5.1/PSReadLine/About/about_PSReadLine.md +++ b/reference/5.1/PSReadLine/About/about_PSReadLine.md @@ -1,7 +1,7 @@ --- description: PSReadLine provides an improved command-line editing experience in the PowerShell console. Locale: en-US -ms.date: 03/03/2025 +ms.date: 08/18/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-5.1&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine @@ -124,8 +124,11 @@ APIs are documented in [about_PSReadLine_Functions][02]. ### Command History 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 -`$($Host.Name)_history.txt`. On Windows systems the history file is stored at +entered from the command line. The history file is a file named +`$($Host.Name)_history.txt`, which results in a unique file for each host. For +example, the history file for the PowerShell Extension console in Visual Studio +Code is `Visual Studio Code Host_history.txt`. +The history file is stored at `$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`. The history can contain sensitive data including passwords. PSReadLine attempts diff --git a/reference/5.1/PSReadLine/About/about_PSReadLine_Release_Notes.md b/reference/5.1/PSReadLine/About/about_PSReadLine_Release_Notes.md index 0bccf9eeda2a..64f98d46c281 100644 --- a/reference/5.1/PSReadLine/About/about_PSReadLine_Release_Notes.md +++ b/reference/5.1/PSReadLine/About/about_PSReadLine_Release_Notes.md @@ -1,7 +1,7 @@ --- description: This article contains the list of changes for each released version of PSReadLine. Locale: en-US -ms.date: 03/03/2025 +ms.date: 08/18/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-5.1&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine_Release_Notes @@ -19,7 +19,7 @@ changes, see the **PSReadLine** [ChangeLog][01]. There have been many updates to PSReadLine since the version that ships in Windows PowerShell 5.1. -- v2.3.6 shipped in PowerShell 7.5.0 +- v2.3.6 shipped in PowerShell 7.4.7 and 7.5.0 - v2.3.5 shipped in PowerShell 7.4.2 and 7.5.0-preview.3 - v2.3.4 shipped in PowerShell 7.4.0-rc.1 - v2.2.6 shipped in PowerShell 7.3.0 @@ -29,7 +29,33 @@ Windows PowerShell 5.1. ## Release Notes -### v2.4.0-beta1 - 2025-02-28 +### v2.4.3-beta3 - 2025-07-23 + +You can get the v2.4.3-beta3 version of the PSReadLine module from PowerShell +Gallery. + +This release includes the following changes: + +- Allow accepting the current input automatically from within an OnIdle event + handler +- Add VS Code tasks and debug config +- Add bound check for the cursor top value to InvokePrompt +- Fix typo in SamplePSReadLineProfile.ps1 +- Fix line ending and cache some reflection operations +- Improve test reliability by making sure the PSReadLine one-time + initialization is done + +### v2.4.2-beta2 - 2025-04-16 + +You can get the v2.4.2-beta2 version of the PSReadLine module from PowerShell +Gallery. + +This release includes the following changes: + +- Add a private field to indicate if PSReadLine is initialized and ready +- Use CFS for installing module and deploy box for module publish + +### v2.4.1-beta1 - 2025-02-28 - Avoid querying for cursor position when it's not necessary - Handle buffer changes made by an event handler diff --git a/reference/7.4/PSReadLine/About/about_PSReadLine.md b/reference/7.4/PSReadLine/About/about_PSReadLine.md index 84b0bf70d375..7e84840b4bd2 100644 --- a/reference/7.4/PSReadLine/About/about_PSReadLine.md +++ b/reference/7.4/PSReadLine/About/about_PSReadLine.md @@ -1,7 +1,7 @@ --- description: PSReadLine provides an improved command-line editing experience in the PowerShell console. Locale: en-US -ms.date: 03/03/2025 +ms.date: 08/18/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-7.4&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine @@ -159,11 +159,16 @@ APIs are documented in [about_PSReadLine_Functions][02]. ### Command History 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 -`$($Host.Name)_history.txt`. On Windows systems the history file is stored at -`$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`. On non-Windows systems, -the history files are stored at `$Env:XDG_DATA_HOME/powershell/PSReadLine` or -`$Env:HOME/.local/share/powershell/PSReadLine`. +entered from the command line. The history file is a file named +`$($Host.Name)_history.txt`, which results in a unique file for each host. For +example, the history file for the PowerShell Extension console in Visual Studio +Code is `Visual Studio Code Host_history.txt`. + +- On Windows systems, the history file is stored at + `$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`. +- On non-Windows systems, the history files are stored at + `$Env:XDG_DATA_HOME/powershell/PSReadLine` or + `$Env:HOME/.local/share/powershell/PSReadLine`. The history can contain sensitive data including passwords. PSReadLine attempts to filter out sensitive information. Any command lines containing the following diff --git a/reference/7.4/PSReadLine/About/about_PSReadLine_Release_Notes.md b/reference/7.4/PSReadLine/About/about_PSReadLine_Release_Notes.md index c010596e41a9..85713b4f0cbc 100644 --- a/reference/7.4/PSReadLine/About/about_PSReadLine_Release_Notes.md +++ b/reference/7.4/PSReadLine/About/about_PSReadLine_Release_Notes.md @@ -1,7 +1,7 @@ --- description: This article contains the list of changes for each released version of PSReadLine. Locale: en-US -ms.date: 03/03/2025 +ms.date: 08/18/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-7.4&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine_Release_Notes @@ -19,7 +19,7 @@ changes, see the **PSReadLine** [ChangeLog][01]. There have been many updates to PSReadLine since the version that ships in Windows PowerShell 5.1. -- v2.3.6 shipped in PowerShell 7.5.0 +- v2.3.6 shipped in PowerShell 7.4.7 and 7.5.0 - v2.3.5 shipped in PowerShell 7.4.2 and 7.5.0-preview.3 - v2.3.4 shipped in PowerShell 7.4.0-rc.1 - v2.2.6 shipped in PowerShell 7.3.0 @@ -29,7 +29,33 @@ Windows PowerShell 5.1. ## Release Notes -### v2.4.0-beta1 - 2025-02-28 +### v2.4.3-beta3 - 2025-07-23 + +You can get the v2.4.3-beta3 version of the PSReadLine module from PowerShell +Gallery. + +This release includes the following changes: + +- Allow accepting the current input automatically from within an OnIdle event + handler +- Add VS Code tasks and debug config +- Add bound check for the cursor top value to InvokePrompt +- Fix typo in SamplePSReadLineProfile.ps1 +- Fix line ending and cache some reflection operations +- Improve test reliability by making sure the PSReadLine one-time + initialization is done + +### v2.4.2-beta2 - 2025-04-16 + +You can get the v2.4.2-beta2 version of the PSReadLine module from PowerShell +Gallery. + +This release includes the following changes: + +- Add a private field to indicate if PSReadLine is initialized and ready +- Use CFS for installing module and deploy box for module publish + +### v2.4.1-beta1 - 2025-02-28 - Avoid querying for cursor position when it's not necessary - Handle buffer changes made by an event handler diff --git a/reference/7.4/PSReadLine/PSReadLine.md b/reference/7.4/PSReadLine/PSReadLine.md index aa11bf5ab721..a25804a8221c 100644 --- a/reference/7.4/PSReadLine/PSReadLine.md +++ b/reference/7.4/PSReadLine/PSReadLine.md @@ -4,7 +4,7 @@ Help Version: 7.4.0.0 Locale: en-US Module Guid: 5714753b-2afd-4492-a5fd-01d9e2cff8b5 Module Name: PSReadLine -ms.date: 09/17/2024 +ms.date: 08/18/2025 schema: 2.0.0 title: PSReadLine --- @@ -18,6 +18,7 @@ editing environment in PowerShell. There have been many updates to PSReadLine since the version that ships in Windows PowerShell 5.1. +- v2.3.6 first shipped in PowerShell 7.4.7 and 7.5.0 - v2.3.5 first shipped in PowerShell 7.4.2 and 7.5.0-preview.3 - v2.3.4 first shipped in PowerShell 7.4.0-rc.1 - v2.2.6 first shipped in PowerShell 7.3.0 @@ -28,7 +29,7 @@ Windows PowerShell 5.1. For more information about version differences, see [about_PSReadLine_Release_Notes](about/about_PSReadLine_Release_Notes.md). -These articles document version 2.3.5 of PSReadLine. +These articles document version 2.3.6 of PSReadLine. > [!NOTE] > Beginning with PowerShell 7.0, PowerShell skips auto-loading PSReadLine on diff --git a/reference/7.5/PSReadLine/About/about_PSReadLine.md b/reference/7.5/PSReadLine/About/about_PSReadLine.md index 12d0e9c58f2f..237e1528d91a 100644 --- a/reference/7.5/PSReadLine/About/about_PSReadLine.md +++ b/reference/7.5/PSReadLine/About/about_PSReadLine.md @@ -1,7 +1,7 @@ --- description: PSReadLine provides an improved command-line editing experience in the PowerShell console. Locale: en-US -ms.date: 03/03/2025 +ms.date: 08/18/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-7.5&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine @@ -159,11 +159,16 @@ APIs are documented in [about_PSReadLine_Functions][02]. ### Command History 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 -`$($Host.Name)_history.txt`. On Windows systems the history file is stored at -`$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`. On non-Windows systems, -the history files are stored at `$Env:XDG_DATA_HOME/powershell/PSReadLine` or -`$Env:HOME/.local/share/powershell/PSReadLine`. +entered from the command line. The history file is a file named +`$($Host.Name)_history.txt`, which results in a unique file for each host. For +example, the history file for the PowerShell Extension console in Visual Studio +Code is `Visual Studio Code Host_history.txt`. + +- On Windows systems, the history file is stored at + `$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`. +- On non-Windows systems, the history files are stored at + `$Env:XDG_DATA_HOME/powershell/PSReadLine` or + `$Env:HOME/.local/share/powershell/PSReadLine`. The history can contain sensitive data including passwords. PSReadLine attempts to filter out sensitive information. Any command lines containing the following diff --git a/reference/7.5/PSReadLine/About/about_PSReadLine_Release_Notes.md b/reference/7.5/PSReadLine/About/about_PSReadLine_Release_Notes.md index 58196ac12757..3be2a0964f81 100644 --- a/reference/7.5/PSReadLine/About/about_PSReadLine_Release_Notes.md +++ b/reference/7.5/PSReadLine/About/about_PSReadLine_Release_Notes.md @@ -1,7 +1,7 @@ --- description: This article contains the list of changes for each released version of PSReadLine. Locale: en-US -ms.date: 03/03/2025 +ms.date: 08/18/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-7.5&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine_Release_Notes @@ -19,7 +19,7 @@ changes, see the **PSReadLine** [ChangeLog][01]. There have been many updates to PSReadLine since the version that ships in Windows PowerShell 5.1. -- v2.3.6 shipped in PowerShell 7.5.0 +- v2.3.6 shipped in PowerShell 7.4.7 and 7.5.0 - v2.3.5 shipped in PowerShell 7.4.2 and 7.5.0-preview.3 - v2.3.4 shipped in PowerShell 7.4.0-rc.1 - v2.2.6 shipped in PowerShell 7.3.0 @@ -29,7 +29,33 @@ Windows PowerShell 5.1. ## Release Notes -### v2.4.0-beta1 - 2025-02-28 +### v2.4.3-beta3 - 2025-07-23 + +You can get the v2.4.3-beta3 version of the PSReadLine module from PowerShell +Gallery. + +This release includes the following changes: + +- Allow accepting the current input automatically from within an OnIdle event + handler +- Add VS Code tasks and debug config +- Add bound check for the cursor top value to InvokePrompt +- Fix typo in SamplePSReadLineProfile.ps1 +- Fix line ending and cache some reflection operations +- Improve test reliability by making sure the PSReadLine one-time + initialization is done + +### v2.4.2-beta2 - 2025-04-16 + +You can get the v2.4.2-beta2 version of the PSReadLine module from PowerShell +Gallery. + +This release includes the following changes: + +- Add a private field to indicate if PSReadLine is initialized and ready +- Use CFS for installing module and deploy box for module publish + +### v2.4.1-beta1 - 2025-02-28 - Avoid querying for cursor position when it's not necessary - Handle buffer changes made by an event handler diff --git a/reference/7.5/PSReadLine/PSReadLine.md b/reference/7.5/PSReadLine/PSReadLine.md index 7c4c046a71e6..87603ec3667b 100644 --- a/reference/7.5/PSReadLine/PSReadLine.md +++ b/reference/7.5/PSReadLine/PSReadLine.md @@ -4,7 +4,7 @@ Help Version: 7.5.0.0 Locale: en-US Module Guid: 5714753b-2afd-4492-a5fd-01d9e2cff8b5 Module Name: PSReadLine -ms.date: 09/17/2024 +ms.date: 08/18/2025 schema: 2.0.0 title: PSReadLine --- @@ -18,6 +18,7 @@ editing environment in PowerShell. There have been many updates to PSReadLine since the version that ships in Windows PowerShell 5.1. +- v2.3.6 first shipped in PowerShell 7.4.7 and 7.5.0 - v2.3.5 first shipped in PowerShell 7.4.2 and 7.5.0-preview.3 - v2.3.4 first shipped in PowerShell 7.4.0-rc.1 - v2.2.6 first shipped in PowerShell 7.3.0 @@ -28,7 +29,7 @@ Windows PowerShell 5.1. For more information about version differences, see [about_PSReadLine_Release_Notes](about/about_PSReadLine_Release_Notes.md). -These articles document version 2.3.5 of PSReadLine. +These articles document version 2.3.6 of PSReadLine. > [!NOTE] > Beginning with PowerShell 7.0, PowerShell skips auto-loading PSReadLine on diff --git a/reference/7.6/PSReadLine/About/about_PSReadLine.md b/reference/7.6/PSReadLine/About/about_PSReadLine.md index 6f61a16920e6..66c41b2e9929 100644 --- a/reference/7.6/PSReadLine/About/about_PSReadLine.md +++ b/reference/7.6/PSReadLine/About/about_PSReadLine.md @@ -1,7 +1,7 @@ --- description: PSReadLine provides an improved command-line editing experience in the PowerShell console. Locale: en-US -ms.date: 03/03/2025 +ms.date: 08/18/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline?view=powershell-7.6&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine @@ -159,11 +159,16 @@ APIs are documented in [about_PSReadLine_Functions][02]. ### Command History 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 -`$($Host.Name)_history.txt`. On Windows systems the history file is stored at -`$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`. On non-Windows systems, -the history files are stored at `$Env:XDG_DATA_HOME/powershell/PSReadLine` or -`$Env:HOME/.local/share/powershell/PSReadLine`. +entered from the command line. The history file is a file named +`$($Host.Name)_history.txt`, which results in a unique file for each host. For +example, the history file for the PowerShell Extension console in Visual Studio +Code is `Visual Studio Code Host_history.txt`. + +- On Windows systems, the history file is stored at + `$Env:APPDATA\Microsoft\Windows\PowerShell\PSReadLine`. +- On non-Windows systems, the history files are stored at + `$Env:XDG_DATA_HOME/powershell/PSReadLine` or + `$Env:HOME/.local/share/powershell/PSReadLine`. The history can contain sensitive data including passwords. PSReadLine attempts to filter out sensitive information. Any command lines containing the following diff --git a/reference/7.6/PSReadLine/About/about_PSReadLine_Release_Notes.md b/reference/7.6/PSReadLine/About/about_PSReadLine_Release_Notes.md index 58de1272cb83..3ac3f1b2bdca 100644 --- a/reference/7.6/PSReadLine/About/about_PSReadLine_Release_Notes.md +++ b/reference/7.6/PSReadLine/About/about_PSReadLine_Release_Notes.md @@ -1,7 +1,7 @@ --- description: This article contains the list of changes for each released version of PSReadLine. Locale: en-US -ms.date: 03/03/2025 +ms.date: 08/18/2025 online version: https://learn.microsoft.com/powershell/module/psreadline/about/about_psreadline_release_notes?view=powershell-7.6&WT.mc_id=ps-gethelp schema: 2.0.0 title: about_PSReadLine_Release_Notes @@ -19,7 +19,7 @@ changes, see the **PSReadLine** [ChangeLog][01]. There have been many updates to PSReadLine since the version that ships in Windows PowerShell 5.1. -- v2.3.6 shipped in PowerShell 7.5.0 +- v2.3.6 shipped in PowerShell 7.4.7 and 7.5.0 - v2.3.5 shipped in PowerShell 7.4.2 and 7.5.0-preview.3 - v2.3.4 shipped in PowerShell 7.4.0-rc.1 - v2.2.6 shipped in PowerShell 7.3.0 @@ -29,7 +29,33 @@ Windows PowerShell 5.1. ## Release Notes -### v2.4.0-beta1 - 2025-02-28 +### v2.4.3-beta3 - 2025-07-23 + +You can get the v2.4.3-beta3 version of the PSReadLine module from PowerShell +Gallery. + +This release includes the following changes: + +- Allow accepting the current input automatically from within an OnIdle event + handler +- Add VS Code tasks and debug config +- Add bound check for the cursor top value to InvokePrompt +- Fix typo in SamplePSReadLineProfile.ps1 +- Fix line ending and cache some reflection operations +- Improve test reliability by making sure the PSReadLine one-time + initialization is done + +### v2.4.2-beta2 - 2025-04-16 + +You can get the v2.4.2-beta2 version of the PSReadLine module from PowerShell +Gallery. + +This release includes the following changes: + +- Add a private field to indicate if PSReadLine is initialized and ready +- Use CFS for installing module and deploy box for module publish + +### v2.4.1-beta1 - 2025-02-28 - Avoid querying for cursor position when it's not necessary - Handle buffer changes made by an event handler diff --git a/reference/7.6/PSReadLine/PSReadLine.md b/reference/7.6/PSReadLine/PSReadLine.md index bbd074b1787f..cb4400f93fdc 100644 --- a/reference/7.6/PSReadLine/PSReadLine.md +++ b/reference/7.6/PSReadLine/PSReadLine.md @@ -4,7 +4,7 @@ Help Version: 7.6.0.0 Locale: en-US Module Guid: 5714753b-2afd-4492-a5fd-01d9e2cff8b5 Module Name: PSReadLine -ms.date: 09/17/2024 +ms.date: 08/18/2025 schema: 2.0.0 title: PSReadLine --- @@ -18,6 +18,7 @@ editing environment in PowerShell. There have been many updates to PSReadLine since the version that ships in Windows PowerShell 5.1. +- v2.3.6 first shipped in PowerShell 7.4.7 and 7.5.0 - v2.3.5 first shipped in PowerShell 7.4.2 and 7.5.0-preview.3 - v2.3.4 first shipped in PowerShell 7.4.0-rc.1 - v2.2.6 first shipped in PowerShell 7.3.0 @@ -28,7 +29,7 @@ Windows PowerShell 5.1. For more information about version differences, see [about_PSReadLine_Release_Notes](about/about_PSReadLine_Release_Notes.md). -These articles document version 2.3.5 of PSReadLine. +These articles document version 2.3.6 of PSReadLine. > [!NOTE] > Beginning with PowerShell 7.0, PowerShell skips auto-loading PSReadLine on