Skip to content

Commit bb7cd0f

Browse files
author
Kapil Borle
authored
Merge pull request #601 from TravisEz13/AddRuleReadme
Add a table of contents for rules
2 parents 6accad6 + 7120d45 commit bb7cd0f

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

‎RuleDocumentation/README.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# PowerShell Script Analyzer Rules
2+
## Table of Contents
3+
4+
| Rule | Severity |
5+
|------|----------------------------------|
6+
|[AvoidAlias](./AvoidAlias.md) | Warning |
7+
|[AvoidDefaultTrueValueSwitchParameter](./AvoidDefaultTrueValueSwitchParameter.md) | Warning|
8+
|[AvoidEmptyCatchBlock](./AvoidEmptyCatchBlock.md) | Warning|
9+
|[AvoidGlobalVars](./AvoidGlobalVars.md) | Warning|
10+
|[AvoidInvokingEmptyMembers](./AvoidInvokingEmptyMembers.md) | Warning|
11+
|[AvoidNullOrEmptyHelpMessageAttribute](./AvoidNullOrEmptyHelpMessageAttribute.md) | Warning|
12+
|[AvoidReservedCharInCmdlet](./AvoidReservedCharInCmdlet.md) | Error |
13+
|[AvoidReservedParams](./AvoidReservedParams.md) | Error |
14+
|[AvoidShouldContinueWithoutForce](./AvoidShouldContinueWithoutForce.md) | Warning|
15+
|[AvoidTrapStatement](./AvoidTrapStatement.md) | Warning|
16+
|[AvoidUninitializedVariable](./AvoidUninitializedVariable.md) | Warning|
17+
|[AvoidUsingComputerNameHardcoded](./AvoidUsingComputerNameHardcoded.md) | Error |
18+
|[AvoidUsingConvertToSecureStringWithPlainText](./AvoidUsingConvertToSecureStringWithPlainText.md) | Error |
19+
|[AvoidUsingDeprecatedManifestFields](./AvoidUsingDeprecatedManifestFields.md) | Warning|
20+
|[AvoidUsingFilePath](./AvoidUsingFilePath.md) | Error |
21+
|[AvoidUsingInvokeExpression](./AvoidUsingInvokeExpression.md) | Warning|
22+
|[AvoidUsingPlainTextForPassword](./AvoidUsingPlainTextForPassword.md) | Warning|
23+
|[AvoidUsingPositionalParameters](./AvoidUsingPositionalParameters.md) | Warning|
24+
|[AvoidUsingUsernameAndPasswordParams](./AvoidUsingUsernameAndPasswordParams.md) | Error |
25+
|[AvoidUsingWMICmdlet](./AvoidUsingWMICmdlet.md) | Warning|
26+
|[AvoidUsingWriteHost](./AvoidUsingWriteHost.md) | Warning|
27+
|[DscExamplesPresent](./DscExamplesPresent.md) | Information |
28+
|[DscTestsPresent](./DscTestsPresent.md) | Information |
29+
|[MissingModuleManifestField](./MissingModuleManifestField.md) | Warning|
30+
|[PossibleIncorrectComparisonWithNull](./PossibleIncorrectComparisonWithNull.md) | Warning|
31+
|[ProvideCommentHelp](./ProvideCommentHelp.md) | Information|
32+
|[ProvideDefaultParameterValue](./ProvideDefaultParameterValue.md) | Warning|
33+
|[ProvideVerboseMessage](./ProvideVerboseMessage.md) | Information |
34+
|[ReturnCorrectTypeDSCFunctions](./ReturnCorrectTypeDSCFunctions.md) | Information |
35+
|[UseApprovedVerbs](./UseApprovedVerbs.md) | Warning|
36+
|[UseBOMForUnicodeEncodedFile](./UseBOMForUnicodeEncodedFile.md) | Warning|
37+
|[UseCmdletCorrectly](./UseCmdletCorrectly.md) | Warning|
38+
|[UseDeclaredVarsMoreThanAssignments](./UseDeclaredVarsMoreThanAssignments.md) | Warning|
39+
|[UseIdenticalMandatoryParametersDSC](./UseIdenticalMandatoryParametersDSC.md) | Error |
40+
|[UseIdenticalParametersDSC](./UseIdenticalParametersDSC.md) | Error |
41+
|[UseOutputTypeCorrectly](./UseOutputTypeCorrectly.md) | Information|
42+
|[UsePSCredentialType](./UsePSCredentialType.md) | Warning|
43+
|[UseShouldProcessCorrectly](./UseShouldProcessCorrectly.md) | Warning|
44+
|[UseShouldProcessForStateChangingFunctions](./UseShouldProcessForStateChangingFunctions.md) | Warning|
45+
|[UseSingularNouns](./UseSingularNouns.md) | Warning|
46+
|[UseStandardDSCFunctionsInResource](./UseStandardDSCFunctionsInResource.md) | Error |
47+
|[UseToExportFieldsInManifest](./UseToExportFieldsInManifest.md) | Warning|

0 commit comments

Comments
 (0)