New-PesterOption
#
SYNOPSISCreates an object that contains advanced options for Invoke-Pester
#
SYNTAX#
DESCRIPTIONBy using New-PesterOption you can set options what allow easier integration with external applications or modifies output generated by Invoke-Pester. The result of New-PesterOption need to be assigned to the parameter 'PesterOption' of the Invoke-Pester function.
#
EXAMPLES#
EXAMPLE 1The result of commands will be execution of tests and saving results of them in a NUnitMXL file where the root "test-suite" will be named "Tests - Set A".
#
PARAMETERS#
-IncludeVSCodeMarkerWhen this switch is set, an extra line of output will be written to the console for test failures, making it easier for VSCode's parser to provide highlighting / tooltips on the line where the error occurred.
#
-TestSuiteNameWhen generating NUnit XML output, this controls the name assigned to the root "test-suite" element. Defaults to "Pester".
#
-ExperimentalEnables experimental features of Pester to be enabled.
#
-ShowScopeHintsEXPERIMENTAL: Enables debugging output for debugging tranisition among scopes. (Experimental flag needs to be used to enable this.)
#
-ScriptBlockFilterFilters scriptblock based on the path and line number. This is intended for integration with external tools so we don't rely on names (strings) that can have expandable variables in them.
#
CommonParametersThis 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#
You cannot pipe input to this command.#
OUTPUTS#
System.Management.Automation.PSObject#
NOTES#
RELATED LINKShttps://pester.dev/docs/v4/commands/Invoke-Pester
#
EDIT THIS PAGEThis 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.