Skip to content

Update command reference to Pester 5.6.0 #314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fflaten merged 2 commits into from
Jun 8, 2024
Merged

Update command reference to Pester 5.6.0 #314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f9ab5f
Bump command ref to 5.6.0
fflaten Jun 8, 2024
7ea32ee
Unescape curly braces in codeblocks
fflaten Jun 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/commands/Add-ShouldOperator.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,4 +166,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/AfterAll.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/AfterEach.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,4 +104,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/Assert-MockCalled.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,4 +184,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/Assert-VerifiableMock.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/BeforeAll.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,4 +116,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/BeforeDiscovery.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/BeforeEach.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
6 changes: 4 additions & 2 deletions docs/commands/Context.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,9 @@ Accept wildcard characters: False

### -Skip

[Switch] $Focus,
Use this parameter to explicitly mark the block to be skipped.
This is preferable to temporarily
commenting out a block, because it remains listed in the output.

```yaml
Type: SwitchParameter
Expand Down Expand Up @@ -181,4 +183,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
6 changes: 3 additions & 3 deletions docs/commands/ConvertTo-JUnitReport.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Converts a Pester result-object to an JUnit-compatible XML report
## SYNTAX

```powershell
ConvertTo-JUnitReport [-Result] <Object> [-AsString] [<CommonParameters>]
ConvertTo-JUnitReport [-Result] <Run> [-AsString] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -73,7 +73,7 @@ This can be retrieved using Invoke-Pester
-Passthru or by using the Run.PassThru configuration-option.

```yaml
Type: Object
Type: Run
Parameter Sets: (All)
Aliases:

Expand Down Expand Up @@ -118,4 +118,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
6 changes: 3 additions & 3 deletions docs/commands/ConvertTo-NUnitReport.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Converts a Pester result-object to an NUnit 2.5 or 3-compatible XML-report
## SYNTAX

```powershell
ConvertTo-NUnitReport [-Result] <Object> [-AsString] [[-Format] <String>] [<CommonParameters>]
ConvertTo-NUnitReport [-Result] <Run> [-AsString] [[-Format] <String>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -84,7 +84,7 @@ This can be retrieved using Invoke-Pester
-Passthru or by using the Run.PassThru configuration-option.

```yaml
Type: Object
Type: Run
Parameter Sets: (All)
Aliases:

Expand Down Expand Up @@ -145,4 +145,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/ConvertTo-Pester4Result.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
6 changes: 4 additions & 2 deletions docs/commands/Describe.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,9 @@ Accept wildcard characters: False

### -Skip

[Switch] $Focus,
Use this parameter to explicitly mark the block to be skipped.
This is preferable to temporarily
commenting out a block, because it remains listed in the output.

```yaml
Type: SwitchParameter
Expand Down Expand Up @@ -191,4 +193,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
8 changes: 4 additions & 4 deletions docs/commands/Export-JUnitReport.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Exports a Pester result-object to an JUnit-compatible XML-report
## SYNTAX

```powershell
Export-JUnitReport [-Result] <Object> [-Path] <String> [<CommonParameters>]
Export-JUnitReport [-Result] <Run> [-Path] <String> [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -60,7 +60,7 @@ This can be retrieved using Invoke-Pester
-Passthru or by using the Run.PassThru configuration-option.

```yaml
Type: Object
Type: Run
Parameter Sets: (All)
Aliases:

Expand All @@ -73,7 +73,7 @@ Accept wildcard characters: False

### -Path

The path where the XML-report should to the ou the XML report as string.
The path where the XML-report should be saved.

```yaml
Type: String
Expand Down Expand Up @@ -105,4 +105,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
8 changes: 4 additions & 4 deletions docs/commands/Export-NUnitReport.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Exports a Pester result-object to an NUnit-compatible XML-report
## SYNTAX

```powershell
Export-NUnitReport [-Result] <Object> [-Path] <String> [[-Format] <String>] [<CommonParameters>]
Export-NUnitReport [-Result] <Run> [-Path] <String> [[-Format] <String>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -60,7 +60,7 @@ This can be retrieved using Invoke-Pester
-Passthru or by using the Run.PassThru configuration-option.

```yaml
Type: Object
Type: Run
Parameter Sets: (All)
Aliases:

Expand All @@ -73,7 +73,7 @@ Accept wildcard characters: False

### -Path

The path where the XML-report should to the ou the XML report as string.
The path where the XML-report should be saved.

```yaml
Type: String
Expand Down Expand Up @@ -121,4 +121,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/Get-ShouldOperator.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,4 @@ standard PowerShell discovery patterns (like `Get-Help Should -Parameter *`).

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/InModuleScope.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,4 +204,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/Invoke-Pester.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -653,4 +653,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
6 changes: 2 additions & 4 deletions docs/commands/It.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ the expectation of the test.
In addition to using your own logic to test expectations and throw exceptions,
you may also use Pester's Should command to perform assertions in plain language.

You can intentionally mark It block result as inconclusive by using Set-TestInconclusive
You can intentionally mark It block result as inconclusive by using Set-ItResult -Inconclusive
command as the first tested statement in the It block.

## EXAMPLES
Expand Down Expand Up @@ -227,8 +227,6 @@ Accept wildcard characters: False
Use this parameter to explicitly mark the test to be skipped.
This is preferable to temporarily
commenting out a test, because the test remains listed in the output.
Use the Strict parameter
of Invoke-Pester to force all skipped tests to fail.

```yaml
Type: SwitchParameter
Expand Down Expand Up @@ -264,4 +262,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/Mock.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,4 +339,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/New-Fixture.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,4 +142,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/New-MockObject.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,4 +194,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/New-PesterConfiguration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,4 +272,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/New-PesterContainer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,4 +152,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
15 changes: 10 additions & 5 deletions docs/commands/Set-ItResult.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@ backwards compatible

```powershell
Describe "Example" {
It "Inconclusive test" {
Set-ItResult -Inconclusive -Because "we want it to be inconclusive"
}
It "Skipped test" {
Set-ItResult -Skipped -Because "we want it to be skipped"
}
Expand All @@ -66,16 +69,18 @@ Describe "Example" {
the output should be

```
[!] Skipped test is skipped, because we want it to be skipped
Tests completed in 0ms
Tests Passed: 0, Failed: 0, Skipped: 0, Pending: 0, Inconclusive 1
Describing Example
[?] Inconclusive test is inconclusive, because we want it to be inconclusive 35ms (32ms|3ms)
[!] Skipped test is skipped, because we want it to be skipped 3ms (2ms|1ms)
Tests completed in 78ms
Tests Passed: 0, Failed: 0, Skipped: 1, Inconclusive: 1, NotRun: 0
```

## PARAMETERS

### -Inconclusive

**DEPRECATED** Sets the test result to inconclusive.
Sets the test result to inconclusive.
Cannot be used at the same time as -Pending or -Skipped

```yaml
Expand Down Expand Up @@ -158,4 +163,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
16 changes: 5 additions & 11 deletions docs/commands/Should.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -810,12 +810,9 @@ Accept wildcard characters: False

### -FileContentMatchMultiline

As opposed to FileContentMatch and FileContentMatchExactly operators,
FileContentMatchMultiline presents content of the file being tested as one string object,
so that the expression you are comparing it to can consist of several lines.
As opposed to FileContentMatch and FileContentMatchExactly operators, FileContentMatchMultiline presents content of the file being tested as one string object, so that the expression you are comparing it to can consist of several lines.

When using FileContentMatchMultiline operator, '^' and '$' represent the beginning and end
of the whole file, instead of the beginning and end of a line.
When using FileContentMatchMultiline operator, '^' and '$' represent the beginning and end of the whole file, instead of the beginning and end of a line

```yaml
Type: SwitchParameter
Expand All @@ -831,12 +828,9 @@ Accept wildcard characters: False

### -FileContentMatchMultilineExactly

As opposed to FileContentMatch and FileContentMatchExactly operators,
FileContentMatchMultilineExactly presents content of the file being tested as one string object,
so that the case sensitive expression you are comparing it to can consist of several lines.
As opposed to FileContentMatch and FileContentMatchExactly operators, FileContentMatchMultilineExactly presents content of the file being tested as one string object, so that the case sensitive expression you are comparing it to can consist of several lines.

When using FileContentMatchMultilineExactly operator, '^' and '$' represent the beginning and end
of the whole file, instead of the beginning and end of a line.
When using FileContentMatchMultilineExactly operator, '^' and '$' represent the beginning and end of the whole file, instead of the beginning and end of a line.

```yaml
Type: SwitchParameter
Expand Down Expand Up @@ -1187,4 +1181,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.5.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
2 changes: 1 addition & 1 deletion docs/commands/docusaurus.sidebar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Import this file in your Docusaurus `sidebars.js` file.
*
* Auto-generated by Alt3.Docusaurus.Powershell 1.0.34.
* Auto-generated by Alt3.Docusaurus.Powershell 1.0.36.
*
* Copyright (c) 2019-present, ALT3 B.V.
*
Expand Down