Correct typos in comments (#2294)

Co-authored-by: Jakub Jareš <[email protected]>

Author: alexandear

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

@@ -4,7 +4,7 @@
 
 
 # You can run this test file by pressing F5, if your editor
-# suports running powershell.
+# supports running powershell.
 
 # You should see this output:
 #    Describing Get-Planet
@@ -18,7 +18,7 @@
 #      [+] Given invalid parameter -Name 'Alpha Centauri', it returns $null 22ms
 
 
-# Put the initialization code in a seperate `BeforeAll` block,
+# Put the initialization code in a separate `BeforeAll` block,
 # where you can perform i.e. your imports.
 BeforeAll {
     # First we need to import the Get-Planet.ps1 file to make the function
@@ -27,10 +27,10 @@ BeforeAll {
     . $PSScriptRoot/Get-Planet.ps1
 
     # Normally we can use a more platform agnostic and generic approach where we import
-    # the current path, but replace the ".Tests.ps1" occurences with ".ps1".
+    # the current path, but replace the ".Tests.ps1" occurrences with ".ps1".
     # . $PSCommandPath.Replace('.Tests.ps1', '.ps1')
     #
-    # We could even replace all the ".Tests" occurences in the current path
+    # We could even replace all the ".Tests" occurrences in the current path
     # with "" and end up with the right filename.
     # . $PSCommandPath.Replace('.Tests', '')
 }
@@ -124,7 +124,7 @@ Describe 'Get-Planet' {
 
 # Want to try it out yourself?
 
-## Excercise 1:
+## Exercise 1:
 # Add filter Population that returns planets with population larger
 # or equal to the given number (in billions).
 # Use 7.5 as the population of Earth. Use 0 for all other planets.
@@ -136,15 +136,15 @@ Describe 'Get-Planet' {
 
 
 
-# Excercise 2: Test that planets are returned in the correct order,
+# Exercise 2: Test that planets are returned in the correct order,
 # from the one closest to the Sun.
 # Make sure to cover these test cases:
 # - Order of planets is correct when no filters are used.
 # - Order of planets is correct when -Name filter is used.
 
 
 
-# Excercise 3 (advanced): Add function that will list moons orbiting a given planet.
+# Exercise 3 (advanced): Add function that will list moons orbiting a given planet.
 # - Make sure you can list all moons.
 # - Make sure you can filter moons for given planet.
 # - Make sure you Get-Planet and Get-Moon functions work together.

src/Module.ps1

@@ -1,5 +1,5 @@
 # Set-SessionStateHint -Hint Pester -SessionState $ExecutionContext.SessionState
-# these functions will be shared with the mock bootstrap function, or used in mocked calls so let's capture them just once instead of everytime we use a mock
+# these functions will be shared with the mock bootstrap function, or used in mocked calls so let's capture them just once instead of every time we use a mock
 $script:SafeCommands['ExecutionContext'] = $ExecutionContext
 $script:SafeCommands['Get-MockDynamicParameter'] = $ExecutionContext.SessionState.InvokeCommand.GetCommand('Get-MockDynamicParameter', 'function')
 $script:SafeCommands['Write-PesterDebugMessage'] = $ExecutionContext.SessionState.InvokeCommand.GetCommand('Write-PesterDebugMessage', 'function')

src/Pester.Runtime.ps1

@@ -1589,7 +1589,7 @@ function Invoke-ScriptBlock {
         # here we are moving into the user scope if the provided
         # scriptblock was bound to user scope, so we want to take some actions
         # typically switching between user and framework timer. There are still tiny pieces of
-        # framework code running in the scriptblock but we can safely ignore those becasue they are
+        # framework code running in the scriptblock but we can safely ignore those because they are
         # just logging, so the time difference is miniscule.
         # The code might also run just in framework scope, in that case the callback can remain empty,
         # eg when we are invoking framework setup.
@@ -1919,7 +1919,7 @@ function Invoke-Test {
     $state.PluginData = $PluginData
     $state.Configuration = $Configuration
 
-    # # TODO: this it potentially unreliable, because supressed errors are written to Error as well. And the errors are captured only from the caller state. So let's use it only as a useful indicator during migration and see how it works in production code.
+    # # TODO: this it potentially unreliable, because suppressed errors are written to Error as well. And the errors are captured only from the caller state. So let's use it only as a useful indicator during migration and see how it works in production code.
 
     # # finding if there were any non-terminating errors during the run, user can clear the array, and the array has fixed size so we can't just try to detect if there is any difference by counts before and after. So I capture the last known error in that state and try to find it in the array after the run
     # $originalErrors = $SessionState.PSVariable.Get("Error").Value
@@ -2060,7 +2060,7 @@ function PostProcess-DiscoveredBlock {
                     $t.ShouldRun = $false
                 }
                 else {
-                    # run the exlude filters before checking if the parent is included
+                    # run the exclude filters before checking if the parent is included
                     # otherwise you would include tests that could match the exclude rule
                     $shouldRun = (Test-ShouldRun -Item $t -Filter $Filter)
                     $t.Explicit = $shouldRun.Explicit
@@ -2214,7 +2214,7 @@ function PostProcess-ExecutedBlock {
             $aggregatedChildDuration = [TimeSpan]::Zero
             if (none $childBlocks) {
                 # one thing to consider here is what happens when a block fails, in the current
-                # excecution model the block can fail when a setup or teardown fails, with failed
+                # execution model the block can fail when a setup or teardown fails, with failed
                 # setup it is easy all the tests in the block are considered failed, with teardown
                 # not so much, when all tests pass and the teardown itself fails what should be the result?
 
@@ -2236,7 +2236,7 @@ function PostProcess-ExecutedBlock {
             }
             else {
                 # when we have children we first let them process themselves and
-                # then we add the results together (the recusion could reach to the parent and add the totals)
+                # then we add the results together (the recursion could reach to the parent and add the totals)
                 # but that is difficult with the duration, so this way is less error prone
                 PostProcess-ExecutedBlock -Block $childBlocks
 

src/csharp/Pester/Tracing/Tracer.cs

@@ -159,7 +159,7 @@ public static void Patch(int powerShellVersion, EngineIntrinsics context, PSHost
                 // action we just use them to get the live data without the overhead of looking 
                 // up properties all the time. This might be internally done in the reflection code
                 // did not measure the impact, and it is probably done for us in the reflection api itself
-                // in modern verisons of runtime
+                // in modern versions of runtime
                 var callStack1 = callStackField.GetValue(debugger);
                 var callStackList1 = (NonGeneric.IList)callStack1;
                 var level1 = callStackList1.Count - initialLevel;

src/functions/Coverage.ps1

@@ -246,7 +246,7 @@ function Get-CodeCoverageFilePaths {
             Get-CodeCoverageFilePaths -Paths $children -IncludeTests $IncludeTests -RecursePaths $RecursePaths
         }
         elseif (-not $item.PsIsContainer) {
-            # todo: enable this warning for non wildcarded paths? otherwise it prints a ton of warnings for documenatation and so on when using "folder/*" wildcard
+            # todo: enable this warning for non wildcarded paths? otherwise it prints a ton of warnings for documentation and so on when using "folder/*" wildcard
             # & $SafeCommands['Write-Warning'] "CodeCoverage path '$path' resolved to a non-PowerShell file '$($item.FullName)'; this path will not be part of the coverage report."
         }
     }
@@ -674,7 +674,7 @@ function Get-CoverageReport {
     if ($null -ne $Measure) {
 
         # re-key the measures to use columns that are corrected for BP placement
-        # also 1 column in tracer can map to multiple columns for BP, when there are assignements, so expand them
+        # also 1 column in tracer can map to multiple columns for BP, when there are assignments, so expand them
         $bpm = @{}
         foreach ($path in $Measure.Keys) {
             $lines = @{}

src/functions/Describe.ps1

@@ -156,9 +156,9 @@ function Invoke-Interactively ($CommandUsed, $ScriptName, $SessionState, $BoundP
 
         # there is a number of problems with this that I don't know how to solve right now
         # - the scripblock below will be discovered which shows a weird message in the console (maybe just suppress?)
-        # every block will get it's own summary if we ar running multiple of them (can we somehow get to the actuall executed code?) or know which one is the last one?
+        # every block will get it's own summary if we ar running multiple of them (can we somehow get to the actual executed code?) or know which one is the last one?
 
-        # use an intermediate module to carry the bound paremeters
+        # use an intermediate module to carry the bound parameters
         # but don't touch the session state the scriptblock is attached
         # to, this way we are still running the provided scriptblocks where
         # they are coming from (in the SessionState they are attached to),

src/functions/Mock.ps1

@@ -155,7 +155,7 @@ function Create-MockHook ($contextInfo, $InvokeMockCallback) {
 
     # MockCallState initialization is injected only into the begin block by the code that generates this prototype
     # also it is not a good idea to share it via the function local data because then it will get overwritten by nested
-    # mock if there is any, instead it should be a varible that gets defined in begin and so it survives during the whole
+    # mock if there is any, instead it should be a variable that gets defined in begin and so it survives during the whole
     # pipeline, but does not overwrite other variables, because we are running in different scopes. Mindblowing.
     & `$MyInvocation.MyCommand.Mock.Invoke_Mock -CommandName '#FUNCTIONNAME#' -ModuleName '#MODULENAME#' ```
         -BoundParameters `$PSBoundParameters ```
@@ -237,12 +237,12 @@ function Create-MockHook ($contextInfo, $InvokeMockCallback) {
     $defineFunctionAndAliases = {
         param($___Mock___parameters)
         # Make sure the you don't use _______parameters variable here, otherwise you overwrite
-        # the variable that is defined in the same scope and the subsequent invocation of scrips will
+        # the variable that is defined in the same scope and the subsequent invocation of scripts will
         # be seriously broken (e.g. you will start resolving setups). But such is life of running in once scope.
         # from upper scope for no reason. But the reason is that you deleted ______param in this scope,
         # and so ______param from the parent scope was inherited
 
-        ## THIS RUNS IN USER SCOPE, BE CAREFUL WHAT YOU PUBLISH AND COSUME
+        ## THIS RUNS IN USER SCOPE, BE CAREFUL WHAT YOU PUBLISH AND CONSUME
 
 
         # it is possible to remove the script: (and -Scope Script) from here and from the alias, which makes the Mock scope just like a function.
@@ -513,7 +513,7 @@ function Remove-MockHook {
             }
         }
         else {
-            # # this runs from OnContainerRunEnd in the mock plugin, it might be running unnecessarilly
+            # # this runs from OnContainerRunEnd in the mock plugin, it might be running unnecessarily
             # if ($Write_Debug_Enabled) {
             #     & $Write_Debug -Scope Mock -Message "ERROR: Function $($CommandName) was not found$(if ($ExecutionContext.SessionState.Module) { " in module $($ExecutionContext.SessionState.Module) session state"} else { " in script session state"})."
             # }
@@ -527,7 +527,7 @@ function Remove-MockHook {
                 }
             }
             else {
-                # # this runs from OnContainerRunEnd in the mock plugin, it might be running unnecessarilly
+                # # this runs from OnContainerRunEnd in the mock plugin, it might be running unnecessarily
                 # if ($Write_Debug_Enabled) {
                 #     & $Write_Debug -Scope Mock -Message "ERROR: Alias $($alias) was not found$(if ($ExecutionContext.SessionState.Module) { " in module $($ExecutionContext.SessionState.Module) session state"} else { " in script session state"})."
                 # }
@@ -646,7 +646,7 @@ function Resolve-Command {
     else {
         # we used to fallback to the script scope when command was not found in the module, we no longer do that
         # now we just search the script scope when module name is not specified. This was probably needed because of
-        # some incosistencies of resolving the mocks. But it never made sense to me.
+        # some inconsistencies of resolving the mocks. But it never made sense to me.
 
         if ($PesterPreference.Debug.WriteDebugMessages.Value) {
             Write-PesterDebugMessage -Scope Mock "Searching for command $CommandName in the script scope."
@@ -689,7 +689,7 @@ function Resolve-Command {
             # true if we inserted the mock into a module
             IsFromModule            = $null -ne $module
             TargetModule            = $ModuleName
-            # true if the commmand comes from the target module
+            # true if the command comes from the target module
             IsFromTargetModule      = $null -ne $module -and $ModuleName -eq $command.Mock.Hook.OriginalCommand.Module.Name
             IsMockBootstrapFunction = $true
             Hook                    = $command.Mock.Hook
@@ -1573,7 +1573,7 @@ function Test-IsClosure {
 }
 
 function Remove-MockFunctionsAndAliases ($SessionState) {
-    # when a test is terminated (e.g. by stopping at a breakpoint and then stoping the execution of the script)
+    # when a test is terminated (e.g. by stopping at a breakpoint and then stopping the execution of the script)
     # the aliases and bootstrap functions for the currently mocked functions will remain in place
     # Then on subsequent runs the bootstrap function will be picked up instead of the real command,
     # because there is still an alias associated with it, and the test will fail.
@@ -1616,7 +1616,7 @@ function Remove-MockFunctionsAndAliases ($SessionState) {
             continue
         }
 
-        # some script modules aparently can have no session state
+        # some script modules apparently can have no session state
         # https://github.com/PowerShell/PowerShell/blob/658837323599ab1c7a81fe66fcd43f7420e4402b/src/System.Management.Automation/engine/runtime/Operations/MiscOps.cs#L51-L55
         # https://github.com/pester/Pester/issues/1921
         if ('Script', 'Manifest' -contains $module.ModuleType -and $null -ne $module.SessionState) {
@@ -1651,7 +1651,7 @@ function Repair-ConflictingParameters {
             continue
         }
 
-        # rewrite the metadata to avoid defining confliting parameters
+        # rewrite the metadata to avoid defining conflicting parameters
         # in the function such as $PSEdition
         if ($conflictingParams -contains $paramMetadata.Name) {
             $paramName = $paramMetadata.Name

src/functions/Output.ps1

@@ -733,7 +733,7 @@ function Get-WriteScreenPlugin ($Verbosity) {
     if ($PesterPreference.Output.Verbosity.Value -in 'Detailed', 'Diagnostic') {
         $p.EachTestSetupStart = {
             param ($Context)
-            # we posponed writing the Describe / Context to grab the Expanded name, because that is done
+            # we postponed writing the Describe / Context to grab the Expanded name, because that is done
             # during execution to get all the variables in scope, if we are the first test then write it
             if ($Context.Test.First) {
                 Write-BlockToScreen $Context.Test.Block

src/functions/Pester.Debugging.ps1

@@ -125,7 +125,7 @@ function Set-SessionStateHint {
     }
 
     # in all places where we capture SessionState we mark its internal state with a hint
-    # the internal state does not change and we use it to invoke scriptblock in diferent
+    # the internal state does not change and we use it to invoke scriptblock in different
     # states, setting the hint on SessionState is only secondary to make is easier to debug
     $flags = [System.Reflection.BindingFlags]'Instance,NonPublic'
     $internalSessionState = $SessionState.GetType().GetProperty('Internal', $flags).GetValue($SessionState, $null)

src/functions/Pester.SessionState.Mock.ps1

@@ -1,5 +1,5 @@
 # session state bound functions that act as endpoints,
-# so the internal funtions can make their session state
+# so the internal functions can make their session state
 # consumption explicit and are testable (also prevents scrolling past
 # the whole documentation :D )
 
@@ -888,7 +888,7 @@ function Should-Invoke {
         #
         # Mock FunctionUnderTest {}
         #
-        # Consider the normal expection:
+        # Consider the normal expectation:
         # `Should -Invoke FunctionUnderTest -ExclusiveFilter { $param1 -eq 'one' }`
         #
         # | Invocations               | Should raises an error |
@@ -1153,7 +1153,7 @@ function Invoke-Mock {
                 }
             }
             else {
-                # not the targetted module, skip it
+                # not the targeted module, skip it
                 if ($PesterPreference.Debug.WriteDebugMessages.Value) {
                     Write-PesterDebugMessage -Scope Mock -Message "Behavior is not from the target module $(if ($targettingAModule) { $TargetModule } else { '$null' }), skipping it:`n$(& $getBehaviorMessage $b)"
                 }
@@ -1192,7 +1192,7 @@ function Invoke-Mock {
         }
     }
 
-    # if we are targetting a module use the behaviors for the current module, but if there is no default the fall back to the non-module default behavior.
+    # if we are targeting a module use the behaviors for the current module, but if there is no default the fall back to the non-module default behavior.
     # do not fallback to non-module filtered behaviors. This is here for safety, and for compatibility when doing Mock Remove-Item {}, and then mocking in module
     # then the default mock for Remove-Item should be effective.
     $behaviors = if ($targettingAModule) {
@@ -1210,7 +1210,7 @@ function Invoke-Mock {
         $moduleBehaviors
     }
     else {
-        # we are not targetting a mock in a module use the non module behaviors
+        # we are not targeting a mock in a module use the non module behaviors
         if ($null -ne $nonModuleDefaultBehavior) {
             # add the default non-module behavior if we have any
             $nonModuleBehaviors.Add($nonModuleDefaultBehavior)