GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — PSUseConsistentWhitespace: Correctly fix whitespace between command parameters when parameter value spans multiple lines by liamjpeters · Pull Request #2064 · PowerShell/PSScriptAnalyzer

Conversation

@liamjpeters

@liamjpeters Liam Peters (liamjpeters) commented Feb 21, 2025

Copy link
Copy Markdown
Contributor

PR Summary

Changes the suggested correction extent of PSUseConsistentWhitespace's parameter spacing violations.

When enabled, the CheckParameter setting of this rule checks the spacing between parameters of a command.

An erroneous correction extent was being generated when parameter values spanned multiple lines (such as for arrays, scriptblocks, and hashtables.

For instance, using the below settings to isolate only the CheckParameter part of the rule:

$Settings = @{
    IncludeRules = @('PSUseConsistentWhitespace')
    Rules        = @{
        PSUseConsistentWhitespace = @{
            Enable                                  = $true
            CheckInnerBrace                         = $false
            CheckOpenBrace                          = $false
            CheckOpenParen                          = $false
            CheckOperator                           = $false
            CheckPipe                               = $false
            CheckPipeForRedundantWhitespace         = $false
            CheckSeparator                          = $false
            CheckParameter                          = $true
            IgnoreAssignmentOperatorInsideHashTable = $false
        }
    }
}

Running the formatter against:

foo { 
    bar
}  -baz

foo @{ 
    1 = 1
}  -baz

foo @(
    1
)  -baz

Note: There are multiple spaces before each of the -baz parameters

Resulted in:

fo-baz

fo-baz

fo-baz

Fixes #2060

PR Checklist

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • Change is not breaking
  • Make sure all .cs, .ps1 and .psm1 files have the correct copyright header
  • Make sure you've added a new test if existing tests do not effectively test the code changed and/or updated documentation
  • This PR is ready to merge and is not Work in Progress.
    • If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@liamjpeters
Liam Peters (liamjpeters) requested review from Andy Jordan (andyleejordan) and Christoph Bergmeister (bergmeister) as code owners February 21, 2025 15:12
Liam Peters (liamjpeters) added 3 commits February 24, 2025 16:39
@liamjpeters @andyleejordan
Added test coverage for the scenarios of parameter values spanning mu…
d9dd860
…ltiple lines
@liamjpeters @andyleejordan
Fix erroneous double-negative in test name
ac0bce4
@liamjpeters @andyleejordan
As the correction takes place on the whitespace between two extents, …
78de299
…the correction should begin on the last line of the left extent and end on the first line of the right extent
@andyleejordan
Andy Jordan (andyleejordan) force-pushed the #2060WhiteSpaceBetweenParametersIssue branch from ad83312 to 78de299 Compare February 25, 2025 00:39
andyleejordan
Andy Jordan (andyleejordan) approved these changes Feb 25, 2025
View reviewed changes

@andyleejordan Andy Jordan (andyleejordan) left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice fix, thank you.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@andyleejordan
Andy Jordan (andyleejordan) enabled auto-merge (squash) February 25, 2025 00:41
@andyleejordan
Andy Jordan (andyleejordan) merged commit 9fa10d4 into PowerShell:main Feb 25, 2025
@liamjpeters
Liam Peters (liamjpeters) deleted the #2060WhiteSpaceBetweenParametersIssue branch February 25, 2025 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bergmeister Christoph Bergmeister (bergmeister) Awaiting requested review from bergmeister bergmeister is a code owner
1 more reviewer
@andyleejordan Andy Jordan (andyleejordan) andyleejordan approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Unexpected string with powershell.codeFormatting.whitespaceBetweenParameters enabled

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@liamjpeters @andyleejordan
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.