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 — Split CheckPipe feature of trimming redundant whitespace out into option CheckPipeForRedundantWhitespace by bergmeister · Pull Request #1413 · PowerShell/PSScriptAnalyzer

Conversation

@bergmeister

@bergmeister Christoph Bergmeister (bergmeister) commented Feb 10, 2020 •
edited
Loading

Uh oh!

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

Copy link
Copy Markdown
Collaborator

PR Summary

This is because some people align their pipes (e.g. in Pester tests) and don't want redundant white-space to be trimmed.
Therefore the concern of the rule options is split into 2 areas:

  • Checkpipe still corrects when there is no whitespace around the pipe operator
  • The new CheckPipeForRedundantWhiteSpace option is for cases where redundant whitespace needs to be trimmed. Disabled by default.

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
Christoph Bergmeister
Split CheckPipe feature of trimming redundant whitespace out into opt…
993e119 
…ion CheckPipeForRedundantWhiteSpace
@bergmeister Christoph Bergmeister (bergmeister) added the Area - Formatter label Feb 10, 2020
Christoph Bergmeister
docs and naming tweaks
ffbec6c
@bergmeister
Christoph Bergmeister (bergmeister) marked this pull request as ready for review February 10, 2020 09:40
Christoph Bergmeister added 2 commits February 10, 2020 09:42
Christoph Bergmeister
casing
dec5517
Christoph Bergmeister
remove redundant whitespace
cd31f2a
@bergmeister
Christoph Bergmeister (bergmeister) requested review from James Truher (JamesWTruher) and Rob Holt (rjmholt) February 11, 2020 15:31
rjmholt
Rob Holt (rjmholt) approved these changes Feb 11, 2020
View reviewed changes
Comment thread RuleDocumentation/UseConsistentWhitespace.md Outdated

#### CheckPipeForRedundantWhitespace : bool (Default value is `$false`)

Checks if a pipe is surrounded by redundant whitespace (i.e. more than 1 whitespace). E.g. `foo | bar` instead of `foo|bar`.

@rjmholt Rob Holt (rjmholt) Feb 11, 2020

Copy link
Copy Markdown
Contributor

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.

Is the example here accurate? Or is it something like:

foo    | bar

vs

foo | bar

(GitHub seems to normalise spaces in inline code...)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
bergmeister reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

@bergmeister Christoph Bergmeister (bergmeister) Feb 11, 2020

Copy link
Copy Markdown
Collaborator Author

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.

Yes, you're right, I forgot to update the example as well.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
bergmeister
Christoph Bergmeister (bergmeister) commented Feb 11, 2020
View reviewed changes
Comment thread RuleDocumentation/UseConsistentWhitespace.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
Christoph Bergmeister (bergmeister) and others added 2 commits February 11, 2020 17:26
@bergmeister
Update RuleDocumentation/UseConsistentWhitespace.md
842475f
Christoph Bergmeister
remove redundant newline
c2f3357
@bergmeister
Christoph Bergmeister (bergmeister) merged commit 163d2c2 into PowerShell:master Feb 11, 2020
@bergmeister Christoph Bergmeister (bergmeister) changed the title Split CheckPipe feature of trimming redundant whitespace out into option CheckPipeForRedundantWhiteSpace Split CheckPipe feature of trimming redundant whitespace out into option CheckPipeForRedundantWhitespace Feb 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JamesWTruher James Truher (JamesWTruher) Awaiting requested review from JamesWTruher
1 more reviewer
@rjmholt Rob Holt (rjmholt) rjmholt 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

Area - Formatter

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

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

2 participants

@bergmeister @rjmholt
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 01402520 — 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.