PowerShell / PowerShell/vscode-powershell

Enabling `powershell.codeFormatting.whitespaceBetweenParameters` and `powershell.codeFormatting.alignPropertyValuePairs` makes one of them always show a warning for Hashtable assignments

Aperta
#5,589 1 commento 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Issue-Bug Needs: Triage
Lingua principale
TypeScript
Stelle
1.9k
Fork
548
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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 having both powershell.codeFormatting.whitespaceBetweenParameters and powershell.codeFormatting.alignPropertyValuePairs enabled in the extension settings, the editor UI will always show the warning for one or the other. So multi-line hashtable assignments always have a yellow warning line under all of the key-value pairs, except the one that has the longest key-string.

In PSScriptAnalyzer, there is an option in the arguments for each of the two rules:
for PSAlightAssignmentStatement, there's CheckHashtable
for PSUseConsistentWhitespace there's IgnoreAssignmentOperatorInsideHashTable

If both of these respective options are enabled, the hashtable assignments receive no warnings when the = operators are aligned and there's only 1 space after.

The PowerShell VSCode extension should either detect when the two settings are enabled and enable the respective arguments automatically or offer the option to enable or disable the respective arguments if the settings are enabled so that multi-line hashtable assignments don't always receive warnings.

PowerShell Version
Name                           Value
----                           -----
PSVersion                      7.6.6
PSEdition                      Core
GitCommitId                    7.6.6
OS                             Microsoft Windows 10.0.26100
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.4
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

Name             : ConsoleHost
Version          : 7.6.6
InstanceId       : d8f39d3e-72c7-47bd-87fd-71c8a5f05138
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.137.0
645f29cc3176500b4b5762ba887cf2a7f0ffdf2c
x64
Extension Version
ms-vscode.powershell@2025.4.0
Steps to Reproduce

In VSCode Settings, enable both powershell.codeFormatting.whitespaceBetweenParameters and powershell.codeFormatting.alignPropertyValuePairs, then create a simple hashtable with multiple key-value pairs that have different legths of key-strings.

With Alignment:

$myHashtable = @{
    KeyOne   = 'item' # <- Warning: Use space before and after binary and assignment operators.
    Key2     = $aVariable # <- Warning: Use space before and after binary and assignment operators.
    KeyThree = 'ThirdValue' # <- No warning
    KeyFour  = $otherVariable # <- Warning: Use space before and after binary and assignment operators.
}
return @{
    Item1     = $false # <- Warning: Use space before and after binary and assignment operators.
    ItemTwo   = 2 # <- Warning: Use space before and after binary and assignment operators.
    ItemThree = $true # <- No warning
}

Without Alignment:

$myHashtable = @{
    KeyOne = 'item' # <- Warning: Assignment statements are not aligned.
    Key2 = $aVariable # <- Warning: Assignment statements are not aligned.
    KeyThree = 'ThirdValue' # <- No warning
    KeyFour = $otherVariable # <- Warning: Assignment statements are not aligned.
}
$myHashtable
return @{
    Item1 = $false # <- Warning: Assignment statements are not aligned.
    ItemTwo = 2 # <- Warning: Assignment statements are not aligned.
    ItemThree = $true # <- No warning
}
Visuals
Image Image
Logs

No response

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Riprodurre l’avviso con powershell.codeFormatting.whitespaceBetweenParameters e powershell.codeFormatting.alignPropertyValuePairs abilitati, usando gli esempi di hashtable su più righe presenti nell’issue. Iniziare tracciando il modo in cui l’estensione gestisce le opzioni di PSScriptAnalyzer PSAlightAssignmentStatement CheckHashtable e PSUseConsistentWhitespace IgnoreAssignmentOperatorInsideHashTable. Il lavoro è completato quando le assegnazioni di hashtable allineate con uno spazio dopo l’operatore non producono avvisi in conflitto con entrambe le impostazioni abilitate.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
powershell, typescript
Ambito
devtools
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Attiva
Chiarezza
Abbastanza chiara
Idoneità per principianti
68/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.