< Back

Set-ModuleFormat

Sun Jan 12, 2020 6:50 pm

NAME Set-ModuleFormat



SYNOPSIS

EXPIRIMENTAL: Set FormatsToProcess



[string]$FormatsPath in a module manifest





SYNTAX

Set-ModuleFormat [[-Name] <String>] [[-FormatsToProcess] <String[]>] [[-FormatsRelativePath] <String>] [-WhatIf]

[-Confirm] [<CommonParameters>]





DESCRIPTION

EXPIRIMENTAL: Set FormatsToProcess



[string]$FormatsPath in a module manifest





PARAMETERS

-Name <String>

Name or path to module to inspect. Defaults to ProjectPath\\ProjectName via Get-BuildVariable



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-FormatsToProcess <String[]>

Array of .ps1xml files



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-FormatsRelativePath <String>

Path to the ps1xml files relatives to the root of the module (example: ".\\Format")



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



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





Major thanks to Joel Bennett for the code behind working with the psd1

Source: https://github.com/PoshCode/Configuration



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Set-ModuleFormat -FormatsRelativePath '.\\Format'



Update module manifiest FormatsToProcess parameters with all the .ps1xml present in the .\\Format folder.











RELATED LINKS

https://github.com/RamblingCookieMonster/BuildHelpers

about_BuildHelpers