PowerShell / PowerShell/PSScriptAnalyzer
Auto Correct Aliases incorrectly expands DSC resources name thinking its an alias of a cmdlet
未關閉
還沒有人認領這個 Issue。
Issue-Bug
- 主要語言
- C#
- 星號
- 2.2k
- 分支
- 415
- 平均合併
- 13 小時 1 分鐘
- 30 天內合併 PR
- 2
描述
Prerequisites
- I have written a descriptive issue title.
- I have searched all open and closed issues to ensure it has not already been reported.
- I have read the troubleshooting guide.
- I am sure this issue is with the extension itself and does not reproduce in a standalone PowerShell instance.
- I have verified that I am using the latest version of Visual Studio Code and the PowerShell extension.
- If this is a security issue, I have read the security issue reporting guidance.
Summary
When using the powershell formatter to format a DSC script, it incorrectly expands DSC resource e.g Package gets expanded to Get-Package which is incorrect in context of DSC.
PowerShell Version
Name Value
---- -----
PSVersion 7.4.3
PSEdition Core
GitCommitId 7.4.3
OS Microsoft Windows 10.0.26100
Platform Win32NT
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0
Name : ConsoleHost
Version : 7.4.3
InstanceId : 18115bb7-f7da-45d7-bb4b-e3714de77d09
UI : System.Management.Automation.Internal.Host.InternalHostUserInterface
CurrentCulture : en-US
CurrentUICulture : en-US
PrivateData : Microsoft.PowerShell.ConsoleHost+ConsoleColorProxy
DebuggerEnabled : True
IsRunspacePushed : False
Runspace : System.Management.Automation.Runspaces.LocalRunspace
Visual Studio Code Version
1.91.0
ea1445cc7016315d0f5728f8e8b12a45dc0a7286
arm64
Extension Version
ms-vscode.powershell@2024.2.2
Steps to Reproduce
- Add below snippet to VSCode with
"powershell.codeFormatting.autoCorrectAliases": trueset. - Make sure VSCode detects the langugae as Poweshell or manually set it, then run formatter using
Alt+Shift+F
Code Snippet
Configuration PackageTest
{
Import-DscResource -ModuleName 'PSDesiredStateConfiguration'
Package PackageExample
{
Ensure = "Present"
Path = "$Env:SystemDrive\TestFolder\TestProject.msi"
Name = "TestPackage"
ProductId = "ACDDCDAF-80C6-41E6-A1B9-8ABD8A05027E"
}
}
Expected behavior
Configuration PackageTest {
Import-DscResource -ModuleName 'PSDesiredStateConfiguration'
Package PackageExample
{
Ensure = 'Present'
Path = "$Env:SystemDrive\TestFolder\TestProject.msi"
Name = 'TestPackage'
ProductId = 'ACDDCDAF-80C6-41E6-A1B9-8ABD8A05027E'
}
}
Actual behavior
Configuration PackageTest {
Import-DscResource -ModuleName 'PSDesiredStateConfiguration'
Get-Package PackageExample
{
Ensure = 'Present'
Path = "$Env:SystemDrive\TestFolder\TestProject.msi"
Name = 'TestPackage'
ProductId = 'ACDDCDAF-80C6-41E6-A1B9-8ABD8A05027E'
}
}
Visuals
No response
Logs
No response
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
首先定位處理 powershell.codeFormatting.autoCorrectAliases 設定的 formatter 路徑,然後使用提供的 DSC Package 設定重現問題。驗證 formatter 如何區分 cmdlet 別名與 DSC 資源名稱,並確認格式化會保留 Package,同時仍會更正適用的別名。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- powershell
- 領域
- tooling
- Issue 類型
- 缺陷
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100