< Back
Invoke-DbatoolsFormatter
Post
NAME Invoke-DbatoolsFormatter
SYNOPSIS
Helps formatting function files to dbatools' standards
SYNTAX
Invoke-DbatoolsFormatter [-Path] <System.Object[]> [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Uses PSSA's Invoke-Formatter to format the target files and saves it without the BOM.
PARAMETERS
-EnableException [<Switch>]
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables
advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own
try/catch.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Path [<System.Object[]>]
The path to the ps1 file that needs to be formatted
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Module, Support
Author: Simone Bizzotto
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Invoke-DbatoolsFormatter -Path C:\\dbatools\\functions\\Get-DbaDatabase.ps1
Reformats C:\\dbatools\\functions\\Get-DbaDatabase.ps1 to dbatools' standards
RELATED LINKS
https://dbatools.io/Invoke-DbatoolsFormatter
SYNOPSIS
Helps formatting function files to dbatools' standards
SYNTAX
Invoke-DbatoolsFormatter [-Path] <System.Object[]> [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Uses PSSA's Invoke-Formatter to format the target files and saves it without the BOM.
PARAMETERS
-EnableException [<Switch>]
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables
advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own
try/catch.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Path [<System.Object[]>]
The path to the ps1 file that needs to be formatted
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Module, Support
Author: Simone Bizzotto
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Invoke-DbatoolsFormatter -Path C:\\dbatools\\functions\\Get-DbaDatabase.ps1
Reformats C:\\dbatools\\functions\\Get-DbaDatabase.ps1 to dbatools' standards
RELATED LINKS
https://dbatools.io/Invoke-DbatoolsFormatter