PowerShell / PowerShell/PSScriptAnalyzer
Auto Correct Aliases incorrectly expands DSC resources name thinking its an alias of a cmdlet
Open
Nobody has claimed this yet.
Issue-Bug
- Dominant language
- C#
- Stars
- 2.2k
- Forks
- 414
- Avg merge
- 13h 1m
- Merged PRs (30d)
- 2
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the formatter path handling the powershell.codeFormatting.autoCorrectAliases setting, then reproduce the issue with the provided DSC Package configuration. Verify how the formatter distinguishes cmdlet aliases from DSC resource names, and confirm that formatting preserves Package while still correcting applicable aliases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100