Version: v5

Invoke-Pester

SYNOPSIS

{{ Fill in the Synopsis }}

SYNTAX

Simple (Default)

Invoke-Pester [[-Path] <String[]>] [-ExcludePath <String[]>] [[-TagFilter] <String[]>]
[-ExcludeTagFilter <String[]>] [-FullNameFilter <String[]>] [-CI] [-Output <String>] [-PassThru]
[<CommonParameters>]

Legacy

Invoke-Pester [[-Path] <String[]>] [[-TagFilter] <String[]>] [-ExcludeTagFilter <String[]>]
[-FullNameFilter <String[]>] [-PassThru] [-EnableExit] [-CodeCoverage <Object[]>]
[-CodeCoverageOutputFile <String>] [-CodeCoverageOutputFileEncoding <String>]
[-CodeCoverageOutputFileFormat <String>] [-Strict] [-OutputFile <String>] [-OutputFormat <String>] [-Quiet]
[-PesterOption <Object>] [-Show <OutputTypes>] [<CommonParameters>]

Advanced

Invoke-Pester [-Configuration <PesterConfiguration>] [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

Example 1

PS C:\> {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-CI

{{ Fill CI Description }}

Type: SwitchParameter
Parameter Sets: Simple
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CodeCoverage

{{ Fill CodeCoverage Description }}

Type: Object[]
Parameter Sets: Legacy
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CodeCoverageOutputFile

{{ Fill CodeCoverageOutputFile Description }}

Type: String
Parameter Sets: Legacy
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CodeCoverageOutputFileEncoding

{{ Fill CodeCoverageOutputFileEncoding Description }}

Type: String
Parameter Sets: Legacy
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CodeCoverageOutputFileFormat

{{ Fill CodeCoverageOutputFileFormat Description }}

Type: String
Parameter Sets: Legacy
Aliases:
Accepted values: JaCoCo
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Configuration

{{ Fill Configuration Description }}

Type: PesterConfiguration
Parameter Sets: Advanced
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EnableExit

{{ Fill EnableExit Description }}

Type: SwitchParameter
Parameter Sets: Legacy
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExcludePath

{{ Fill ExcludePath Description }}

Type: String[]
Parameter Sets: Simple
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExcludeTagFilter

{{ Fill ExcludeTagFilter Description }}

Type: String[]
Parameter Sets: Simple, Legacy
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FullNameFilter

{{ Fill FullNameFilter Description }}

Type: String[]
Parameter Sets: Simple, Legacy
Aliases: Name
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Output

{{ Fill Output Description }}

Type: String
Parameter Sets: Simple
Aliases:
Accepted values: Diagnostic, Detailed, Normal, Minimal, None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OutputFile

{{ Fill OutputFile Description }}

Type: String
Parameter Sets: Legacy
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OutputFormat

{{ Fill OutputFormat Description }}

Type: String
Parameter Sets: Legacy
Aliases:
Accepted values: NUnitXml, JUnitXml
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

{{ Fill PassThru Description }}

Type: SwitchParameter
Parameter Sets: Simple, Legacy
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Path

{{ Fill Path Description }}

Type: String[]
Parameter Sets: Simple, Legacy
Aliases: Script
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PesterOption

{{ Fill PesterOption Description }}

Type: Object
Parameter Sets: Legacy
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Quiet

{{ Fill Quiet Description }}

Type: SwitchParameter
Parameter Sets: Legacy
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Show

{{ Fill Show Description }}

Type: OutputTypes
Parameter Sets: Legacy
Aliases:
Accepted values: None, Default, Passed, Failed, Pending, Skipped, Inconclusive, Describe, Context, Summary, Header, Fails, All
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Strict

{{ Fill Strict Description }}

Type: SwitchParameter
Parameter Sets: Legacy
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TagFilter

{{ Fill TagFilter Description }}

Type: String[]
Parameter Sets: Simple, Legacy
Aliases: Tags, Tag
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object

NOTES

RELATED LINKS

EDIT THIS PAGE

This page was auto-generated using Pester's comment based help. To edit the content of this page, change the corresponding help in the pester/Pester repository. See our contribution guide for more information.