Skip to content

Commit 23fbab4

Browse files
committed
Update PowerShellBestPractices.md
1 parent 515b7d8 commit 23fbab4

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

PowerShellBestPractices.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ The following guidelines come from a combined effort from both the PowerShell te
1212
- Support Confirmation Requests [UseShouldProcessCorrectly](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/RuleDocumentation/UseShouldProcessCorrectly.md) and [UseShouldProcessForStateChangingFunctions](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/RuleDocumentation/UseShouldProcessForStateChangingFunctions.md)
1313
- Nouns should be singular [UseSingularNouns](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/RuleDocumentation/UseSingularNouns.md)
1414
- Module Manifest Fields [MissingModuleManifestField](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/RuleDocumentation/MissingModuleManifestField.md)
15-
- Version
16-
- Author
17-
- Description
18-
- LicenseUri (for PowerShell Gallery)
15+
- Version
16+
- Author
17+
- Description
18+
- LicenseUri (for PowerShell Gallery)
1919
- Must call ShouldProcess when ShouldProcess attribute is present and vice versa.[UseShouldProcessCorrectly](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/RuleDocumentation/UseShouldProcessCorrectly.md)
2020
- Switch parameters should not default to true  [AvoidDefaultTrueValueSwtichParameter](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/RuleDocumentation/AvoidDefaultTrueValueSwitchParameter.md)
2121

@@ -34,7 +34,6 @@ The following guidelines come from a combined effort from both the PowerShell te
3434
- Specify the OutputType Attribute
3535
- Write Single Records to the Pipeline
3636
- Make Cmdlets Case-Insensitive and Case-Preserving
37-
3837

3938
##Script Functions
4039
###Severity: Error
@@ -91,8 +90,8 @@ The following guidelines come from a combined effort from both the PowerShell te
9190
###Severity: Error
9291
- Password should be secure string [AvoidUsingPlainTextForPassword](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/RuleDocumentation/AvoidUsingPlainTextForPassword.md)- Should never have both -Username and -Password parameters (should take credentials)[UsePSCredentialType](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/RuleDocumentation/UsePSCredentialType.md)
9392
- -ComputerName hardcoded should not be used (information disclosure)[AvoidUsingComputerNameHardcoded](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/RuleDocumentation/AvoidUsingComputerNameHardcoded.md)
94-
- - ConvertTo-SecureString with plaintext should not be used (information disclosure)
95-
-
93+
- ConvertTo-SecureString with plaintext should not be used (information disclosure)
94+
9695
###Severity: Warning
9796
- Password = 'string' should not be used. (information disclosure) [AvoidUsingUsernameAndPasswordParams](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/RuleDocumentation/AvoidUsingUsernameAndPasswordParams.md)
9897
- Internal URLs should not be used (information disclosure)[AvoidUsingFilePath](https://github.com/PowerShell/PSScriptAnalyzer/blob/master/RuleDocumentation/AvoidUsingFilePath.md)
@@ -131,4 +130,4 @@ The following guidelines come from a combined effort from both the PowerShell te
131130
###Reference:
132131
Cmdlet Development Guidelines from MSDN site (Cmdlet Development Guidelines)
133132

134-
The Community Book of PowerShell Practices (Compiled by Don Jones and Matt Penny and the Windows PowerShell Community)
133+
The Community Book of PowerShell Practices (Compiled by Don Jones and Matt Penny and the Windows PowerShell Community)

0 commit comments

Comments
 (0)