Update-MaesterTests
SYNOPSIS
Removes copies of the built-in Maester tests from a folder.
SYNTAX
Update-MaesterTests [[-Path] <String>] [-Force] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
From Maester 3.0 the tests that ship with Maester run from the module itself. Copies of them that Install-MaesterTests wrote in Maester 2.x are not run any more. Update-MaesterTests removes those copies: every *.Tests.ps1 file outside a Custom folder whose tests all have the ID of a current, previous or retired built-in test. Files with any other test, and everything under Custom/, are kept.
A maester-config.json that is a copy of the file Maester 2.x shipped is reduced to the settings that differ from the built-in defaults.
EXAMPLES
EXAMPLE 1
Update-MaesterTests -Path ./maester-tests -WhatIf
Lists the files that would be removed.
EXAMPLE 2
Update-MaesterTests -Path ./maester-tests -Force
Removes the copies without asking.
PARAMETERS
-Path
The folder to clean up. Defaults to the current directory.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: .
Accept pipeline input: False
Accept wildcard characters: False
-Force
Does not ask for confirmation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by Write-Progress.
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
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.