Fix formatting in all files (#1949)

* Fix tests * Manual fix for spacing
pester · May 17, 2021 · 52067e0 · 52067e0
1 parent ea079a5
commit 52067e0
Show file tree

Hide file tree

Showing 80 changed files with 746 additions and 735 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -9,18 +9,15 @@
 			"VARIANT": "3.1"
 		}
 	},
-
 	// Set *default* container specific settings.json values on container create.
 	"settings": {
 		"terminal.integrated.shell.linux": "/bin/bash"
 	},
-
 	// Add the IDs of extensions you want installed when the container is created.
 	"extensions": [
 		"ms-vscode.powershell",
 		"ms-dotnettools.csharp"
 	],
-
 	// Use 'postCreateCommand' to run commands after the container is created.
 	// Restoring the c# projects
 	"postCreateCommand": "dotnet restore src/csharp"

diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,7 +1,7 @@
 contact_links:
-    - name: Need help?
-      url: https://pester.dev/docs/contributing/introduction#where-to-get-support
-      about: Join our online communities to get help with "How to do _____ with Pester?" questions.
-    - name: Documentation issue beyond Command Reference?
-      url: https://github.com/pester/docs/issues/new
-      about: Please report non-command documentation issue for https://pester.dev in the docs repo
+  - name: Need help?
+    url: https://pester.dev/docs/contributing/introduction#where-to-get-support
+    about: Join our online communities to get help with "How to do _____ with Pester?" questions.
+  - name: Documentation issue beyond Command Reference?
+    url: https://github.com/pester/docs/issues/new
+    about: Please report non-command documentation issue for https://pester.dev in the docs repo
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,9 @@ Test.xml
 vendor/packages/
 .DS_Store
 .vscode/
+# But don't exclude settings.json
+!.vscode/settings.json
+
 coverage.xml
 testResults.xml
 
@@ -359,3 +362,4 @@ MigrationBackup/
 .ionide/
 
 tmp/
+
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,10 +1,10 @@
 {
   "powershell.codeFormatting.preset": "Stroustrup",
-
   "files.trimTrailingWhitespace": true,
   "files.insertFinalNewline": true,
-
   "editor.tabSize": 4,
-  "editor.formatOnSave": false,
-  "powershell.codeFormatting.addWhitespaceAroundPipe": true
+  "editor.formatOnSave": true,
+  "powershell.codeFormatting.addWhitespaceAroundPipe": true,
+  "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline",
+  "yaml.format.singleQuote": true
 }
diff --git a/PSScriptAnalyzerSettings.psd1 b/PSScriptAnalyzerSettings.psd1
@@ -1,8 +1,8 @@
 @{
-    Severity = @('Error','Warning')
+    Severity            = @('Error', 'Warning')
     IncludeDefaultRules = $true
-    CustomRulePath = './Pester.BuildAnalyzerRules'
-    ExcludeRules=@(
+    CustomRulePath      = './Pester.BuildAnalyzerRules'
+    ExcludeRules        = @(
         'PSUseShouldProcessForStateChangingFunctions'
         'PSUseApprovedVerbs'
         'Measure-SafeCommands'

diff --git a/Pester.BuildAnalyzerRules/Pester.BuildAnalyzerRules.psm1 b/Pester.BuildAnalyzerRules/Pester.BuildAnalyzerRules.psm1
@@ -41,7 +41,7 @@ function Measure-SafeCommands {
             if ($null -ne $commandName -and $commandName -in $SafeCommands.Keys -and $commandName -notin $IgnoreUnsafeCommands) {
                 foreach ($cmd in $CommandAst.CommandElements) {
                     # Find extent for command name only
-                    if(($cmd -is [System.Management.Automation.Language.StringConstantExpressionAst]) -and $cmd.Value -eq $commandName) {
+                    if (($cmd -is [System.Management.Automation.Language.StringConstantExpressionAst]) -and $cmd.Value -eq $commandName) {
 
                         #Define fix-action
                         [int]$startLineNumber = $cmd.Extent.StartLineNumber

diff --git a/SECURITY.md b/SECURITY.md
@@ -4,19 +4,19 @@
 
 Any issues with Pester are generally fixed in the latest releases.  There has been no specific security patches to this date.
 
-| Version | Supported          |Notes
-| ------- | ------------------ |-----------------------
-| 5.1.x   | :white_check_mark: |Actively maintained
-| 5.0.x   | :x:                |Critical issues fixed.  
-| 4.0.x   | :white_check_mark: |Critical issues fixed.  
-| < 4.0   | :x:                |Critical issues fixed.  
-| 3.x.x   | :x:                |Not actively maintaned
+| Version | Supported          | Notes                  |
+| ------- | ------------------ | ---------------------- |
+| 5.1.x   | :white_check_mark: | Actively maintained    |
+| 5.0.x   | :x:                | Critical issues fixed. |
+| 4.0.x   | :white_check_mark: | Critical issues fixed. |
+| < 4.0   | :x:                | Critical issues fixed. |
+| 3.x.x   | :x:                | Not actively maintaned |
 
 ## Reporting a Vulnerability
 
-Pester uses a small library of C# code that depends on the .NET Framework. There are currently no known security vulnerabilities with the Pester Powershell framework. 
+Pester uses a small library of C# code that depends on the .NET Framework. There are currently no known security vulnerabilities with the Pester Powershell framework.
 
-To report security vulnerabilities in Powershell, .NET, Windows, or other Microsoft Products & Services, visit the following links: 
+To report security vulnerabilities in Powershell, .NET, Windows, or other Microsoft Products & Services, visit the following links:
 <https://www.microsoft.com/en-us/msrc/faqs-report-an-issue>
 <https://www.microsoft.com/en-us/msrc/bounty>
 

diff --git a/SUPPORT.md b/SUPPORT.md
@@ -1,10 +1,10 @@
 # Support
 
-Please review the contribution documentation located at following links before submitting an issue:  
+Please review the contribution documentation located at following links before submitting an issue:
 
-[Reporting Issues](https://pester.dev/docs/contributing/reporting-issues)  
-[Feature Requests](https://pester.dev/docs/contributing/feature-requests)  
+[Reporting Issues](https://pester.dev/docs/contributing/reporting-issues)
+[Feature Requests](https://pester.dev/docs/contributing/feature-requests)
 
 Feature Requests & Issues are reported using Github issues.
 
-[Feature Requests and Issues](https://github.com/pester/Pester/issues).  
+[Feature Requests and Issues](https://github.com/pester/Pester/issues).
diff --git a/build.ps1 b/build.ps1
@@ -5,19 +5,23 @@
         Used to build and import the Pester module during Pester development.
 
         The code that should be excluded from the build is wrapped in this if:
+        # PESTER_BUILD
         if (-not (Get-Variable -Name "PESTER_BUILD" -ValueOnly -ErrorAction Ignore)) {
             ...Your code here...
-        } # endif
+        }
+        # end PESTER_BUILD
 
         This will exclude the code from execution when dot-sourcing, but keep it when running the
         file directly. When inlining into single file, the regex below will omit the wrapped code.
         The # endif comment is significant, because it allows the regex to identify the correct end }.
 
         You can also include the code in build. Which will run the code only when dot-sources into Pester.psm1.
 
+        # PESTER_BUILD
         if ((Get-Variable -Name "PESTER_BUILD" -ValueOnly -ErrorAction Ignore)) {
             ...Your code here...
-        } # endif
+        }
+        # end PESTER_BUILD
 
         Or any other if that uses the variable.
 
@@ -231,10 +235,9 @@ foreach ($f in $files) {
         $null = $sb.AppendLine("# file $relativePath")
         $noBuild = $false
         foreach ($l in $lines) {
-            # when inlining the code skip everything wrapped in this if
-            # if (something with PESTER_BUILD) {
-            # } # endif
-            if ($l -match '^\s*if.*PESTER_BUILD') {
+            # when inlining the code skip everything wrapped in # PESTER_BUILD, # end PESTER_BUILD
+            #
+            if ($l -match '^.*#\s*PESTER_BUILD') {
                 # start skipping lines
                 $noBuild = $true
             }
@@ -244,7 +247,7 @@ foreach ($f in $files) {
                 $null = $sb.AppendLine($l)
             }
 
-            if ($l -match "\s*}\s*#\s*end\s*if\s*$") {
+            if ($l -match '^.*#\s*end\s*PESTER_BUILD') {
                 # stop skipping lines
                 $noBuild = $false
             }

diff --git a/docs/Examples/Planets/Get-Planet.ps1 b/docs/Examples/Planets/Get-Planet.ps1
@@ -4,12 +4,12 @@
 function Get-Planet ([string]$Name = '*') {
     $planets = @(
         @{ Name = 'Mercury' }
-        @{ Name = 'Venus'   }
-        @{ Name = 'Earth'   }
-        @{ Name = 'Mars'    }
+        @{ Name = 'Venus' }
+        @{ Name = 'Earth' }
+        @{ Name = 'Mars' }
         @{ Name = 'Jupiter' }
-        @{ Name = 'Saturn'  }
-        @{ Name = 'Uranus'  }
+        @{ Name = 'Saturn' }
+        @{ Name = 'Uranus' }
         @{ Name = 'Neptune' }
     ) | ForEach-Object { [PSCustomObject] $_ }
 

diff --git a/publish/release.ps1 b/publish/release.ps1
@@ -23,8 +23,7 @@ if ($LASTEXITCODE -ne 0) {
 }
 
 $m = Test-ModuleManifest $bin/Pester.psd1
-$version = if ($m.PrivateData -and $m.PrivateData.PSData -and $m.PrivateData.PSData.PreRelease)
-{
+$version = if ($m.PrivateData -and $m.PrivateData.PSData -and $m.PrivateData.PSData.PreRelease) {
     "$($m.Version)-$($m.PrivateData.PSData.PreRelease)"
 }
 else {
@@ -57,20 +56,20 @@ if ((Get-Item $bin/Pester.psm1).Length -lt 50KB) {
 
 
 $files = @(
-"nunit_schema_2.5.xsd"
-"junit_schema_4.xsd"
-"Pester.psd1"
-"Pester.psm1"
-"report.dtd"
-"bin\net452\Pester.dll"
-"bin\net452\Pester.pdb"
-"bin\netstandard2.0\Pester.dll"
-"bin\netstandard2.0\Pester.pdb"
-"en-US\about_BeforeEach_AfterEach.help.txt"
-"en-US\about_Mocking.help.txt"
-"en-US\about_Pester.help.txt"
-"en-US\about_Should.help.txt"
-"en-US\about_TestDrive.help.txt"
+    "nunit_schema_2.5.xsd"
+    "junit_schema_4.xsd"
+    "Pester.psd1"
+    "Pester.psm1"
+    "report.dtd"
+    "bin\net452\Pester.dll"
+    "bin\net452\Pester.pdb"
+    "bin\netstandard2.0\Pester.dll"
+    "bin\netstandard2.0\Pester.pdb"
+    "en-US\about_BeforeEach_AfterEach.help.txt"
+    "en-US\about_Mocking.help.txt"
+    "en-US\about_Pester.help.txt"
+    "en-US\about_Should.help.txt"
+    "en-US\about_TestDrive.help.txt"
 )
 
 $notFound = @()

diff --git a/publish/signModule.ps1 b/publish/signModule.ps1
@@ -2,7 +2,7 @@ param($Thumbprint, $Path)
 $ErrorActionPreference = 'Stop'
 
 $cert = Get-ChildItem Cert:\CurrentUser\My |
-Where-Object Thumbprint -eq $Thumbprint
+    Where-Object Thumbprint -eq $Thumbprint
 
 if ($null -eq $cert) {
     throw "No certificate was found."
@@ -29,11 +29,11 @@ if (-not @($filesToSign)) {
 }
 
 $results = $filesToSign |
-ForEach-Object {
-    $r = Set-AuthenticodeSignature $_ -Certificate $cert -TimestampServer 'http://timestamp.digicert.com' -ErrorAction Stop
-    $r | Out-String | Write-Host
-    $r
-}
+    ForEach-Object {
+        $r = Set-AuthenticodeSignature $_ -Certificate $cert -TimestampServer 'http://timestamp.digicert.com' -ErrorAction Stop
+        $r | Out-String | Write-Host
+        $r
+    }
 
 $failed = $results | Where-Object { $_.Status -ne "Valid" }
 

diff --git a/src/Format.ps1 b/src/Format.ps1
@@ -1,7 +1,9 @@
+# PESTER_BUILD
 if (-not (Get-Variable -Name "PESTER_BUILD" -ValueOnly -ErrorAction Ignore)) {
     . "$PSScriptRoot/functions/Pester.SafeCommands.ps1"
     . "$PSScriptRoot/TypeClass.ps1"
-} # endif
+}
+# end PESTER_BUILD
 
 function Format-Collection ($Value, [switch]$Pretty) {
     $Limit = 10
@@ -10,8 +12,8 @@ function Format-Collection ($Value, [switch]$Pretty) {
         $separator = ",`n"
     }
     $count = $Value.Count
-    $trimmed = $count  -gt $Limit
-    '@(' + (($Value | & $SafeCommands['Select-Object'] -First $Limit | & $SafeCommands['ForEach-Object'] { Format-Nicely -Value $_ -Pretty:$Pretty }) -join $separator) + $(if ($trimmed) {', ...'}) + ')'
+    $trimmed = $count -gt $Limit
+    '@(' + (($Value | & $SafeCommands['Select-Object'] -First $Limit | & $SafeCommands['ForEach-Object'] { Format-Nicely -Value $_ -Pretty:$Pretty }) -join $separator) + $(if ($trimmed) { ', ...' }) + ')'
 }
 
 function Format-Object ($Value, $Property, [switch]$Pretty) {
@@ -140,7 +142,7 @@ function Format-Nicely ($Value, [switch]$Pretty) {
 function Sort-Property ($InputObject, [string[]]$SignificantProperties, $Limit = 4) {
 
     $properties = @($InputObject.PSObject.Properties |
-            & $SafeCommands['Where-Object'] { $_.Name -notlike "_*"} |
+            & $SafeCommands['Where-Object'] { $_.Name -notlike "_*" } |
             & $SafeCommands['Select-Object'] -expand Name |
             & $SafeCommands['Sort-Object'])
     $significant = @()