Save all files with UTF8BOM (pester#1950)

.vscode/settings.json

@@ -6,5 +6,8 @@
   "editor.formatOnSave": true,
   "powershell.codeFormatting.addWhitespaceAroundPipe": true,
   "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline",
-  "yaml.format.singleQuote": true
+  "yaml.format.singleQuote": true,
+  "[powershell]": {
+    "files.encoding": "utf8bom"
+  }
 }

PSScriptAnalyzerSettings.psd1

@@ -1,4 +1,4 @@
-@{
+@{
     Severity            = @('Error', 'Warning')
     IncludeDefaultRules = $true
     CustomRulePath      = './Pester.BuildAnalyzerRules'

Pester.BuildAnalyzerRules/Pester.BuildAnalyzerRules.psd1

@@ -1,4 +1,4 @@
-@{
+@{
 
     # Script module or binary module file associated with this manifest.
     RootModule        = 'Pester.BuildAnalyzerRules.psm1'

Pester.BuildAnalyzerRules/Pester.BuildAnalyzerRules.psm1

@@ -1,4 +1,4 @@
-# Get list of SafeCommands
+# Get list of SafeCommands
 $SafeCommands = & { . "$PSScriptRoot/../src/functions/Pester.SafeCommands.ps1"; $Script:SafeCommands }
 # Workaround as RuleSuppressionID-based suppression is bugged. returns error.
 # Should be replaced with the following line when PSScriptAnalyzer is fixed. See Invoke-Pester

build.ps1

@@ -1,4 +1,4 @@
-#! /usr/bin/pwsh
+#! /usr/bin/pwsh
 
 <#
     .SYNOPSIS

docs/Examples/Planets/Get-Planet.Tests.ps1

@@ -1,4 +1,4 @@
-# In practice tests and your code are placed in two
+# In practice tests and your code are placed in two
 # separate files. Tests belong in .Tests.ps1 file and code belongs
 # in .ps1 file. Open the Get-Planet.ps1 file as well, please.
 

docs/Examples/Planets/Get-Planet.ps1

@@ -1,4 +1,4 @@
-# This is not the best file to start from,
+# This is not the best file to start from,
 # open Get-Planet.Tests.ps1 as well :)
 
 function Get-Planet ([string]$Name = '*') {

publish/buildNugetPackage.ps1

@@ -1,4 +1,4 @@
-$VerbosePreference = 'Continue'
+$VerbosePreference = 'Continue'
 $ErrorActionPreference = 'Stop'
 
 try {

publish/chocolateyInstall.ps1

@@ -1,4 +1,4 @@
-[CmdletBinding()]
+[CmdletBinding()]
 param ( )
 
 end {

publish/cleanUpBeforeBuild.ps1

@@ -1,4 +1,4 @@
-# cleaning up remains of previous builds
+# cleaning up remains of previous builds
 # examples and all test files
 # in the next step we sign all scripts so
 # we want to reduce how many files will be signed

publish/getNugetExe.ps1

@@ -1,4 +1,4 @@
-$VerbosePreference = 'Continue'
+$VerbosePreference = 'Continue'
 $ErrorActionPreference = 'Stop'
 
 try {

publish/publishPSGalleryPackage.ps1

@@ -1,4 +1,4 @@
-param (
+param (
     [Parameter(Mandatory)]
     [string] $ApiKey,
     [Parameter(Mandatory)]

publish/release.ps1

@@ -1,4 +1,4 @@
-# build should provide '%system.teamcity.build.checkoutDir%'
+# build should provide '%system.teamcity.build.checkoutDir%'
 param (
     [Parameter(Mandatory)]
     [String] $PsGalleryApiKey,

publish/signModule.ps1

@@ -1,4 +1,4 @@
-param($Thumbprint, $Path)
+param($Thumbprint, $Path)
 $ErrorActionPreference = 'Stop'
 
 $cert = Get-ChildItem Cert:\CurrentUser\My |

publish/testRelease.ps1

@@ -1,4 +1,4 @@
-param(
+param(
     [switch] $LocalBuild
 )
 

src/Format.ps1

@@ -1,4 +1,4 @@
-# PESTER_BUILD
+# PESTER_BUILD
 if (-not (Get-Variable -Name "PESTER_BUILD" -ValueOnly -ErrorAction Ignore)) {
     . "$PSScriptRoot/functions/Pester.SafeCommands.ps1"
     . "$PSScriptRoot/TypeClass.ps1"

src/Main.ps1

@@ -1,4 +1,4 @@
-function Assert-ValidAssertionName {
+function Assert-ValidAssertionName {
     param([string]$Name)
     if ($Name -notmatch '^\S+$') {
         throw "Assertion name '$name' is invalid, assertion name must be a single word."

src/Pester.RSpec.ps1

@@ -1,4 +1,4 @@
-function Find-File {
+function Find-File {
     [CmdletBinding()]
     param (
         [Parameter(Mandatory = $true)]

src/Pester.Runtime.ps1

@@ -1,4 +1,4 @@
-# PESTER_BUILD
+# PESTER_BUILD
 if (-not (Get-Variable -Name "PESTER_BUILD" -ValueOnly -ErrorAction Ignore)) {
     . "$PSScriptRoot/Pester.Utility.ps1"
     . "$PSScriptRoot/functions/Pester.SafeCommands.ps1"

src/Pester.State.ps1

@@ -1,4 +1,4 @@
-$script:AssertionOperators = [Collections.Generic.Dictionary[string, object]]([StringComparer]::InvariantCultureIgnoreCase)
+$script:AssertionOperators = [Collections.Generic.Dictionary[string, object]]([StringComparer]::InvariantCultureIgnoreCase)
 $script:AssertionAliases = [Collections.Generic.Dictionary[string, object]]([StringComparer]::InvariantCultureIgnoreCase)
 $script:AssertionDynamicParams = [Pester.Factory]::CreateRuntimeDefinedParameterDictionary()
 $script:DisableScopeHints = $true

src/Pester.Types.ps1

@@ -1,4 +1,4 @@
-# e.g. $minimumVersionRequired = "5.1.0.0" -as [version]
+# e.g. $minimumVersionRequired = "5.1.0.0" -as [version]
 $minimumVersionRequired = $ExecutionContext.SessionState.Module.PrivateData.RequiredAssemblyVersion -as [version]
 
 # Check if the type exists, which means we have a conflict because the assembly is already loaded

src/Pester.Utility.ps1

@@ -1,4 +1,4 @@
-function or {
+function or {
     [CmdletBinding()]
     param (
         [Parameter(Mandatory = $true, Position = 0)]

src/Pester.ps1

@@ -1,4 +1,4 @@
-param ($ScriptBlock)
+param ($ScriptBlock)
 
 . $ScriptBlock
 

src/Pester.psd1

@@ -1,4 +1,4 @@
-@{
+@{
 
     # Script module or binary module file associated with this manifest.
     RootModule        = 'Pester.psm1'

src/TypeClass.ps1

@@ -1,4 +1,4 @@
-function Is-Value ($Value) {
+function Is-Value ($Value) {
     $Value = $($Value)
     $Value -is [ValueType] -or $Value -is [string] -or $value -is [scriptblock]
 }

src/functions/Context.ps1

@@ -1,4 +1,4 @@
-function Context {
+function Context {
     <#
 .SYNOPSIS
 Provides logical grouping of It blocks within a single Describe block.

src/functions/Coverage.Plugin.ps1

@@ -1,4 +1,4 @@
-function Get-CoveragePlugin {
+function Get-CoveragePlugin {
     New-PluginObject -Name "Coverage" -RunStart {
         param($Context)
 

src/functions/Coverage.ps1

@@ -1,4 +1,4 @@
-function Enter-CoverageAnalysis {
+function Enter-CoverageAnalysis {
     [CmdletBinding()]
     param (
         [object[]] $CodeCoverage,

src/functions/Describe.ps1

@@ -1,4 +1,4 @@
-function Describe {
+function Describe {
     <#
 .SYNOPSIS
 Creates a logical group of tests.

src/functions/Environment.ps1

@@ -1,4 +1,4 @@
-function GetPesterPsVersion {
+function GetPesterPsVersion {
     # accessing the value indirectly so it can be mocked
     (& $SafeCommands['Get-Variable'] 'PSVersionTable' -ValueOnly).PSVersion.Major
 }

src/functions/Get-ShouldOperator.ps1

@@ -1,4 +1,4 @@
-function Get-ShouldOperator {
+function Get-ShouldOperator {
     <#
     .SYNOPSIS
     Display the assertion operators available for use with Should.

src/functions/In.ps1

@@ -1,4 +1,4 @@
-function In {
+function In {
     <#
     .SYNOPSIS
     A convenience function that executes a script from a specified path.

src/functions/InModuleScope.ps1

@@ -1,4 +1,4 @@
-function InModuleScope {
+function InModuleScope {
     <#
 .SYNOPSIS
    Allows you to execute parts of a test script within the

src/functions/It.ps1

@@ -1,4 +1,4 @@
-function It {
+function It {
     <#
 .SYNOPSIS
 Validates the results of a test inside of a Describe block.

src/functions/New-Fixture.ps1

@@ -1,4 +1,4 @@
-function New-Fixture {
+function New-Fixture {
     <#
     .SYNOPSIS
     This function generates two scripts, one that defines a function

src/functions/New-MockObject.ps1

@@ -1,4 +1,4 @@
-function New-MockObject {
+function New-MockObject {
     <#
 .SYNOPSIS
 This function instantiates a .NET object from a type.

src/functions/Output.ps1

@@ -1,4 +1,4 @@
-$script:ReportStrings = DATA {
+$script:ReportStrings = DATA {
     @{
         StartMessage      = "Executing all tests in '{0}'"
         FilterMessage     = ' matching test name {0}'

src/functions/Pester.Debugging.ps1

@@ -1,4 +1,4 @@
-function Count-Scopes {
+function Count-Scopes {
     param(
         [Parameter(Mandatory = $true)]
         $ScriptBlock)

src/functions/Pester.SafeCommands.ps1

@@ -1,4 +1,4 @@
-# Tried using $ExecutionState.InvokeCommand.GetCmdlet() here, but it does not trigger module auto-loading the way
+# Tried using $ExecutionState.InvokeCommand.GetCmdlet() here, but it does not trigger module auto-loading the way
 # Get-Command does.  Since this is at import time, before any mocks have been defined, that's probably acceptable.
 # If someone monkeys with Get-Command before they import Pester, they may break something.
 

src/functions/Pester.Scoping.ps1

@@ -1,4 +1,4 @@
-function Set-ScriptBlockScope {
+function Set-ScriptBlockScope {
     [CmdletBinding()]
     param (
         [Parameter(Mandatory = $true)]

src/functions/Pester.SessionState.Mock.ps1

@@ -1,4 +1,4 @@
-# session state bound functions that act as endpoints,
+# session state bound functions that act as endpoints,
 # so the internal funtions can make their session state
 # consumption explicit and are testable (also prevents scrolling past
 # the whole documentation :D )

src/functions/Set-ItResult.ps1

@@ -1,4 +1,4 @@
-function Set-ItResult {
+function Set-ItResult {
     <#
     .SYNOPSIS
     Set-ItResult is used inside the It block to explicitly set the test result

src/functions/SetupTeardown.ps1

@@ -1,4 +1,4 @@
-function BeforeEach {
+function BeforeEach {
     <#
     .SYNOPSIS
         Defines a series of steps to perform at the beginning of every It block within

src/functions/TestDrive.ps1

@@ -1,4 +1,4 @@
-function Get-TestDrivePlugin {
+function Get-TestDrivePlugin {
 
     # TODO: add OnStart block and put this in it
 

src/functions/TestRegistry.ps1

@@ -1,4 +1,4 @@
-function New-TestRegistry {
+function New-TestRegistry {
     param(
         [Switch]
         $PassThru,

src/functions/TestResults.ps1

@@ -1,4 +1,4 @@
-function Get-HumanTime {
+function Get-HumanTime {
     param( [TimeSpan] $TimeSpan)
     if ($TimeSpan.Ticks -lt [timespan]::TicksPerSecond) {
         $time = [int]($TimeSpan.TotalMilliseconds)

src/functions/assertions/Be.ps1

@@ -1,4 +1,4 @@
-#Be
+#Be
 function Should-Be ($ActualValue, $ExpectedValue, [switch] $Negate, [string] $Because) {
     <#
 .SYNOPSIS

src/functions/assertions/BeGreaterThan.ps1

@@ -1,4 +1,4 @@
-function Should-BeGreaterThan($ActualValue, $ExpectedValue, [switch] $Negate, [string] $Because) {
+function Should-BeGreaterThan($ActualValue, $ExpectedValue, [switch] $Negate, [string] $Because) {
     <#
 .SYNOPSIS
 Asserts that a number (or other comparable value) is greater than an expected value.

src/functions/assertions/BeIn.ps1

@@ -1,4 +1,4 @@
-function Should-BeIn($ActualValue, $ExpectedValue, [switch] $Negate, [string] $Because) {
+function Should-BeIn($ActualValue, $ExpectedValue, [switch] $Negate, [string] $Because) {
     <#
 .SYNOPSIS
 Asserts that a collection of values contain a specific value.

src/functions/assertions/BeLessThan.ps1

@@ -1,4 +1,4 @@
-function Should-BeLessThan($ActualValue, $ExpectedValue, [switch] $Negate, [string] $Because) {
+function Should-BeLessThan($ActualValue, $ExpectedValue, [switch] $Negate, [string] $Because) {
     <#
 .SYNOPSIS
 Asserts that a number (or other comparable value) is lower than an expected value.

src/functions/assertions/BeLike.ps1

@@ -1,4 +1,4 @@
-function Should-BeLike($ActualValue, $ExpectedValue, [switch] $Negate, [String] $Because) {
+function Should-BeLike($ActualValue, $ExpectedValue, [switch] $Negate, [String] $Because) {
     <#
 .SYNOPSIS
 Asserts that the actual value matches a wildcard pattern using PowerShell's -like operator.

src/functions/assertions/BeLikeExactly.ps1

@@ -1,4 +1,4 @@
-function Should-BeLikeExactly($ActualValue, $ExpectedValue, [switch] $Negate, [String] $Because) {
+function Should-BeLikeExactly($ActualValue, $ExpectedValue, [switch] $Negate, [String] $Because) {
     <#
 .SYNOPSIS
 Asserts that the actual value matches a wildcard pattern using PowerShell's -like operator.

src/functions/assertions/BeNullOrEmpty.ps1

@@ -1,4 +1,4 @@
-
+
 function Should-BeNullOrEmpty([object[]] $ActualValue, [switch] $Negate, [string] $Because) {
     <#
 .SYNOPSIS

src/functions/assertions/BeOfType.ps1

@@ -1,4 +1,4 @@
-
+
 function Should-BeOfType($ActualValue, $ExpectedType, [switch] $Negate, [string]$Because) {
     <#
 .SYNOPSIS

src/functions/assertions/BeTrueOrFalse.ps1

@@ -1,4 +1,4 @@
-function Should-BeTrue($ActualValue, [switch] $Negate, [string] $Because) {
+function Should-BeTrue($ActualValue, [switch] $Negate, [string] $Because) {
     <#
 .SYNOPSIS
 Asserts that the value is true, or truthy.

src/functions/assertions/Contain.ps1

@@ -1,4 +1,4 @@
-function Should-Contain($ActualValue, $ExpectedValue, [switch] $Negate, [string] $Because) {
+function Should-Contain($ActualValue, $ExpectedValue, [switch] $Negate, [string] $Because) {
     <#
 .SYNOPSIS
 Asserts that collection contains a specific value.

src/functions/assertions/Exist.ps1

@@ -1,4 +1,4 @@
-function Should-Exist($ActualValue, [switch] $Negate, [string] $Because) {
+function Should-Exist($ActualValue, [switch] $Negate, [string] $Because) {
     <#
 .SYNOPSIS
 Does not perform any comparison, but checks if the object calling Exist is present in a PS Provider.

src/functions/assertions/FileContentMatch.ps1

@@ -1,4 +1,4 @@
-function Should-FileContentMatch($ActualValue, $ExpectedContent, [switch] $Negate, $Because) {
+function Should-FileContentMatch($ActualValue, $ExpectedContent, [switch] $Negate, $Because) {
     <#
 .SYNOPSIS
 Checks to see if a file contains the specified text.

src/functions/assertions/FileContentMatchExactly.ps1

@@ -1,4 +1,4 @@
-function Should-FileContentMatchExactly($ActualValue, $ExpectedContent, [switch] $Negate, [String] $Because) {
+function Should-FileContentMatchExactly($ActualValue, $ExpectedContent, [switch] $Negate, [String] $Because) {
     <#
 .SYNOPSIS
 Checks to see if a file contains the specified text.

src/functions/assertions/FileContentMatchMultiline.ps1

@@ -1,4 +1,4 @@
-function Should-FileContentMatchMultiline($ActualValue, $ExpectedContent, [switch] $Negate, [String] $Because) {
+function Should-FileContentMatchMultiline($ActualValue, $ExpectedContent, [switch] $Negate, [String] $Because) {
     <#
 .SYNOPSIS
 As opposed to FileContentMatch and FileContentMatchExactly operators,

src/functions/assertions/HaveCount.ps1

@@ -1,4 +1,4 @@
-function Should-HaveCount($ActualValue, [int] $ExpectedValue, [switch] $Negate, [string] $Because) {
+function Should-HaveCount($ActualValue, [int] $ExpectedValue, [switch] $Negate, [string] $Because) {
     <#
 .SYNOPSIS
 Asserts that a collection has the expected amount of items.

src/functions/assertions/HaveParameter.ps1

@@ -1,4 +1,4 @@
-function Should-HaveParameter (
+function Should-HaveParameter (
     $ActualValue,
     [String] $ParameterName,
     $Type,

src/functions/assertions/Match.ps1

@@ -1,4 +1,4 @@
-function Should-Match($ActualValue, $RegularExpression, [switch] $Negate, [string] $Because) {
+function Should-Match($ActualValue, $RegularExpression, [switch] $Negate, [string] $Because) {
     <#
 .SYNOPSIS
 Uses a regular expression to compare two objects.

src/functions/assertions/MatchExactly.ps1

@@ -1,4 +1,4 @@
-function Should-MatchExactly($ActualValue, $RegularExpression, [switch] $Negate, [string] $Because) {
+function Should-MatchExactly($ActualValue, $RegularExpression, [switch] $Negate, [string] $Because) {
     <#
 .SYNOPSIS
 Uses a regular expression to compare two objects.

src/functions/assertions/PesterThrow.ps1

@@ -1,4 +1,4 @@
-function Should-Throw {
+function Should-Throw {
     param (
         [ScriptBlock] $ActualValue,
         [string] $ExpectedMessage,

test.ps1

@@ -1,4 +1,4 @@
-#! /usr/bin/pwsh
+#! /usr/bin/pwsh
 
 <#
     .SYNOPSIS