v1.4.2 release

[tpcarman]

Description

[1.4.2] - 2025-01-30

Related Issue

Fixed

• Fix password shown in plain text (Fix #55)
• Prevent execution from Windows PowerShell ISE (Fix #52)

Motivation and Context

How Has This Been Tested?

Tested in multiple lab and production environments with multiple AsBuiltReport modules

Screenshots (if appropriate):

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING page.

[github-actions]

PSScriptAnalyzer results:

Errors: [0], Warnings: [29], Information: [1]

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 29
Message    : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 30
Message    : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 31
Message    : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 44
Message    : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 45
Message    : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 46
Message    : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 74
Message    : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 75
Message    : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 76
Message    : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 150
Message    : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 151
Message    : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 152
Message    : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 207
Message    : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 208
Message    : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 209
Message    : File 'New-AsBuiltConfig.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSPossibleIncorrectComparisonWithNull
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 85
Message    : $null should be on the left side of equality comparisons.

RuleName   : PSPossibleIncorrectComparisonWithNull
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 90
Message    : $null should be on the left side of equality comparisons.

RuleName   : PSPossibleIncorrectComparisonWithNull
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 95
Message    : $null should be on the left side of equality comparisons.

RuleName   : PSPossibleIncorrectComparisonWithNull
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 118
Message    : $null should be on the left side of equality comparisons.

RuleName   : PSPossibleIncorrectComparisonWithNull
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 131
Message    : $null should be on the left side of equality comparisons.

RuleName   : PSUseShouldProcessForStateChangingFunctions
Severity   : Warning
ScriptName : New-AsBuiltConfig.ps1
Line       : 1
Message    : Function 'New-AsBuiltConfig' has verb that could change system 
             state. Therefore, the function has to support 'ShouldProcess'.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltReport.ps1
Line       : 357
Message    : File 'New-AsBuiltReport.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltReport.ps1
Line       : 358
Message    : File 'New-AsBuiltReport.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltReport.ps1
Line       : 359
Message    : File 'New-AsBuiltReport.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltReport.ps1
Line       : 409
Message    : File 'New-AsBuiltReport.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSAvoidUsingWriteHost
Severity   : Warning
ScriptName : New-AsBuiltReport.ps1
Line       : 411
Message    : File 'New-AsBuiltReport.ps1' uses Write-Host. Avoid using 
             Write-Host because it might not work in all hosts, does not work 
             when there is no host, and (prior to PS 5.0) cannot be suppressed, 
             captured, or redirected. Instead, use Write-Output, Write-Verbose, 
             or Write-Information.

RuleName   : PSUseShouldProcessForStateChangingFunctions
Severity   : Warning
ScriptName : New-AsBuiltReport.ps1
Line       : 1
Message    : Function 'New-AsBuiltReport' has verb that could change system 
             state. Therefore, the function has to support 'ShouldProcess'.

RuleName   : PSAvoidUsingPlainTextForPassword
Severity   : Warning
ScriptName : New-AsBuiltReport.ps1
Line       : 141
Message    : Parameter '$Password' should use SecureString, otherwise this will 
             expose sensitive information. See ConvertTo-SecureString for more 
             information.

RuleName   : PSUseShouldProcessForStateChangingFunctions
Severity   : Warning
ScriptName : New-AsBuiltReportConfig.ps1
Line       : 1
Message    : Function 'New-AsBuiltReportConfig' has verb that could change 
             system state. Therefore, the function has to support 
             'ShouldProcess'.

RuleName   : PSUseOutputTypeCorrectly
Severity   : Information
ScriptName : New-AsBuiltConfig.ps1
Line       : 258
Message    : The cmdlet 'New-AsBuiltConfig' returns an object of type 
             'System.Collections.Hashtable' but this type is not declared in 
             the OutputType attribute.