Skip to content

New-ConfigurationFormat.md

Latest commit

 

History

History
564 lines (453 loc) · 12.8 KB

New-ConfigurationFormat.md

File metadata and controls

564 lines (453 loc) · 12.8 KB
Raw
external help file PSPublishModule-help.xml
Module Name PSPublishModule
online version https://github.com/EvotecIT/PSPublishModule
schema 2.0.0

New-ConfigurationFormat

SYNOPSIS

Builds formatting options for code and manifest generation during the build.

SYNTAX

__AllParameterSets

New-ConfigurationFormat -ApplyTo <string[]> [-EnableFormatting] [-Sort <string>] [-RemoveComments] [-RemoveEmptyLines] [-RemoveAllEmptyLines] [-RemoveCommentsInParamBlock] [-RemoveCommentsBeforeParamBlock] [-UpdateProjectRoot] [-PlaceOpenBraceEnable] [-PlaceOpenBraceOnSameLine] [-PlaceOpenBraceNewLineAfter] [-PlaceOpenBraceIgnoreOneLineBlock] [-PlaceCloseBraceEnable] [-PlaceCloseBraceNewLineAfter] [-PlaceCloseBraceIgnoreOneLineBlock] [-PlaceCloseBraceNoEmptyLineBefore] [-UseConsistentIndentationEnable] [-UseConsistentIndentationKind <string>] [-UseConsistentIndentationPipelineIndentation <string>] [-UseConsistentIndentationIndentationSize <int>] [-UseConsistentWhitespaceEnable] [-UseConsistentWhitespaceCheckInnerBrace] [-UseConsistentWhitespaceCheckOpenBrace] [-UseConsistentWhitespaceCheckOpenParen] [-UseConsistentWhitespaceCheckOperator] [-UseConsistentWhitespaceCheckPipe] [-UseConsistentWhitespaceCheckSeparator] [-AlignAssignmentStatementEnable] [-AlignAssignmentStatementCheckHashtable] [-UseCorrectCasingEnable] [-PSD1Style <string>] [<CommonParameters>]

DESCRIPTION

Produces a formatting configuration segment used by the build pipeline to normalize generated output (merged PSM1/PSD1) and optionally apply formatting back to the project root.

EXAMPLES

EXAMPLE 1

PS> New-ConfigurationFormat -ApplyTo OnMergePSM1,OnMergePSD1 -RemoveComments -RemoveEmptyLines

Formats the merged module output and removes comments while keeping readability.

EXAMPLE 2

PS> New-ConfigurationFormat -ApplyTo DefaultPSM1,DefaultPSD1 -EnableFormatting -UpdateProjectRoot

Applies formatting rules to the project sources as well as generated output.

PARAMETERS

-AlignAssignmentStatementCheckHashtable

For PSAlignAssignmentStatement: align hashtable assignments.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-AlignAssignmentStatementEnable

Enable PSAlignAssignmentStatement rule and optionally check hashtable alignment.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-ApplyTo

Targets to apply formatting to (OnMergePSM1, OnMergePSD1, DefaultPS1, DefaultPSM1, DefaultPSD1).

Type: String[]
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: OnMergePSM1, OnMergePSD1, DefaultPS1, DefaultPSM1, DefaultPSD1

Required: True
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-EnableFormatting

Enables formatting for the chosen ApplyTo targets even if no specific rule switches are provided.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-PlaceCloseBraceEnable

Enable PSPlaceCloseBrace rule and configure its behavior.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-PlaceCloseBraceIgnoreOneLineBlock

For PSPlaceCloseBrace: ignore single-line blocks.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-PlaceCloseBraceNewLineAfter

For PSPlaceCloseBrace: enforce a new line after the closing brace.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-PlaceCloseBraceNoEmptyLineBefore

For PSPlaceCloseBrace: do not allow an empty line before a closing brace.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-PlaceOpenBraceEnable

Enable PSPlaceOpenBrace rule and configure its behavior.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-PlaceOpenBraceIgnoreOneLineBlock

For PSPlaceOpenBrace: ignore single-line blocks.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-PlaceOpenBraceNewLineAfter

For PSPlaceOpenBrace: enforce a new line after the opening brace.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-PlaceOpenBraceOnSameLine

For PSPlaceOpenBrace: place opening brace on the same line.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-PSD1Style

Style for generated manifests (PSD1) for the selected ApplyTo targets.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: Minimal, Native

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-RemoveAllEmptyLines

Remove all empty lines (more aggressive than RemoveEmptyLines).

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-RemoveComments

Remove comments in the formatted output.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-RemoveCommentsBeforeParamBlock

Remove comments that appear immediately before the param() block.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-RemoveCommentsInParamBlock

Remove comments within the param() block.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-RemoveEmptyLines

Remove empty lines while preserving readability.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Sort

Optional ordering hint for internal processing. Accepts None, Asc, or Desc.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: None, Asc, Desc

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-UpdateProjectRoot

When set, formats PowerShell sources in the project root in addition to staging output.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-UseConsistentIndentationEnable

Enable PSUseConsistentIndentation rule and configure its behavior.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-UseConsistentIndentationIndentationSize

Number of spaces for indentation when Kind is space.

Type: Int32
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-UseConsistentIndentationKind

Indentation style for PSUseConsistentIndentation: space or tab.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: space, tab

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-UseConsistentIndentationPipelineIndentation

Pipeline indentation mode for PSUseConsistentIndentation.

Type: String
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: IncreaseIndentationAfterEveryPipeline, NoIndentation

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-UseConsistentWhitespaceCheckInnerBrace

For PSUseConsistentWhitespace: check inner brace spacing.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-UseConsistentWhitespaceCheckOpenBrace

For PSUseConsistentWhitespace: check open brace spacing.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-UseConsistentWhitespaceCheckOpenParen

For PSUseConsistentWhitespace: check open parenthesis spacing.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-UseConsistentWhitespaceCheckOperator

For PSUseConsistentWhitespace: check operator spacing.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-UseConsistentWhitespaceCheckPipe

For PSUseConsistentWhitespace: check pipeline operator spacing.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-UseConsistentWhitespaceCheckSeparator

For PSUseConsistentWhitespace: check separator (comma) spacing.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-UseConsistentWhitespaceEnable

Enable PSUseConsistentWhitespace rule and configure which elements to check.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-UseCorrectCasingEnable

Enable PSUseCorrectCasing rule.

Type: SwitchParameter
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

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

RELATED LINKS

  • None