Skip to content

New-ConfigurationFileConsistency.md

Latest commit

 

History

History
372 lines (297 loc) · 8.28 KB

New-ConfigurationFileConsistency.md

File metadata and controls

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

New-ConfigurationFileConsistency

SYNOPSIS

Creates configuration for file consistency checking (encoding and line endings) during module build.

SYNTAX

__AllParameterSets

New-ConfigurationFileConsistency [-Enable] [-FailOnInconsistency] [-Severity <ValidationSeverity>] [-RequiredEncoding <FileConsistencyEncoding>] [-RequiredLineEnding <FileConsistencyLineEnding>] [-ProjectKind <ProjectKind>] [-IncludePatterns <string[]>] [-Scope <FileConsistencyScope>] [-AutoFix] [-CreateBackups] [-MaxInconsistencyPercentage <int>] [-ExcludeDirectories <string[]>] [-ExcludeFiles <string[]>] [-EncodingOverrides <hashtable>] [-LineEndingOverrides <hashtable>] [-ExportReport] [-ReportFileName <string>] [-CheckMixedLineEndings] [-CheckMissingFinalNewline] [-UpdateProjectRoot] [<CommonParameters>]

DESCRIPTION

Adds a file-consistency validation step to the pipeline. This can enforce required encoding/line-ending rules and (optionally) auto-fix issues during a build.

EXAMPLES

EXAMPLE 1

PS> New-ConfigurationFileConsistency -Enable -FailOnInconsistency -RequiredEncoding UTF8BOM -RequiredLineEnding CRLF -AutoFix -CreateBackups -ExportReport

Enforces consistency and exports a CSV report; backups are created before fixes are applied.

EXAMPLE 2

PS> New-ConfigurationFileConsistency -Enable -RequiredEncoding UTF8BOM -RequiredLineEnding CRLF -ExportReport -Scope StagingAndProject

Runs validation on staging and project root, exports a report, and does not apply automatic fixes.

PARAMETERS

-AutoFix

Automatically fix encoding and line ending issues during build.

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

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

-CheckMissingFinalNewline

Check for files missing final newlines.

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

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

-CheckMixedLineEndings

Check for files with mixed line endings.

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

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

-CreateBackups

Create backup files before applying automatic fixes.

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

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

-Enable

Enable file consistency checking during build.

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

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

-EncodingOverrides

Per-path encoding overrides (patterns mapped to encodings).

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

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

-ExcludeDirectories

Directory names to exclude from consistency analysis.

Type: String[]
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-ExcludeFiles

File patterns to exclude from consistency analysis.

Type: String[]
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-ExportReport

Export detailed consistency report to the artifacts directory.

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

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

-FailOnInconsistency

Fail the build if consistency issues are found.

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

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

-IncludePatterns

Custom include patterns (override default project kind patterns).

Type: String[]
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-LineEndingOverrides

Per-path line ending overrides (patterns mapped to line endings).

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

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

-MaxInconsistencyPercentage

Maximum percentage of files that can have consistency issues. Default is 5.

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

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

-ProjectKind

Project kind used to derive default include patterns.

Type: Nullable`1
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-ReportFileName

Custom filename for the consistency report.

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

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

-RequiredEncoding

Required file encoding.

Type: FileConsistencyEncoding
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: ASCII, UTF8, UTF8BOM, Unicode, BigEndianUnicode, UTF7, UTF32

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

-RequiredLineEnding

Required line ending style.

Type: FileConsistencyLineEnding
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: CRLF, LF

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

-Scope

Scope for file consistency checks (staging/project).

Type: FileConsistencyScope
Parameter Sets: __AllParameterSets
Aliases: None
Possible values: StagingOnly, ProjectOnly, StagingAndProject

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

-Severity

Severity for consistency issues (overrides FailOnInconsistency when specified).

Type: Nullable`1
Parameter Sets: __AllParameterSets
Aliases: None
Possible values:

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

-UpdateProjectRoot

Legacy switch. When set, applies encoding/line-ending consistency fixes to the project root as well as 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

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