From 11a04a95dbf6414671fab5d885d0309907a10701 Mon Sep 17 00:00:00 2001 From: Kapil Borle Date: Fri, 31 Mar 2017 10:25:22 -0700 Subject: [PATCH 1/4] Make rule doc filenames consistent with rule names --- ...arameterValue.md => AvoidDefaultValueForMandatoryParameter.md} | 0 ...alueSwitchParameter.md => AvoidDefaultValueSwitchParameter.md} | 0 RuleDocumentation/{AvoidAlias.md => AvoidUsingCmdletAliases.md} | 0 .../{AvoidEmptyCatchBlock.md => AvoidUsingEmptyCatchBlock.md} | 0 .../{AvoidReservedCharInCmdlet.md => ReservedCmdletChar.md} | 0 RuleDocumentation/{AvoidReservedParams.md => ReservedParams.md} | 0 ...ctTypeDSCFunctions.md => ReturnCorrectTypesForDSCFunctions.md} | 0 .../{UseShouldProcessCorrectly.md => ShouldProcess.md} | 0 ...SCFunctionsInResource.md => StandardDSCFunctionsInResource.md} | 0 ...yParametersDSC.md => UseIdenticalMandatoryParametersForDSC.md} | 0 ...eIdenticalParametersDSC.md => UseIdenticalParametersForDSC.md} | 0 ...ProvideVerboseMessage.md => UseVerboseMessageInDSCResource.md} | 0 12 files changed, 0 insertions(+), 0 deletions(-) rename RuleDocumentation/{ProvideDefaultParameterValue.md => AvoidDefaultValueForMandatoryParameter.md} (100%) rename RuleDocumentation/{AvoidDefaultTrueValueSwitchParameter.md => AvoidDefaultValueSwitchParameter.md} (100%) rename RuleDocumentation/{AvoidAlias.md => AvoidUsingCmdletAliases.md} (100%) rename RuleDocumentation/{AvoidEmptyCatchBlock.md => AvoidUsingEmptyCatchBlock.md} (100%) rename RuleDocumentation/{AvoidReservedCharInCmdlet.md => ReservedCmdletChar.md} (100%) rename RuleDocumentation/{AvoidReservedParams.md => ReservedParams.md} (100%) rename RuleDocumentation/{ReturnCorrectTypeDSCFunctions.md => ReturnCorrectTypesForDSCFunctions.md} (100%) rename RuleDocumentation/{UseShouldProcessCorrectly.md => ShouldProcess.md} (100%) rename RuleDocumentation/{UseStandardDSCFunctionsInResource.md => StandardDSCFunctionsInResource.md} (100%) rename RuleDocumentation/{UseIdenticalMandatoryParametersDSC.md => UseIdenticalMandatoryParametersForDSC.md} (100%) rename RuleDocumentation/{UseIdenticalParametersDSC.md => UseIdenticalParametersForDSC.md} (100%) rename RuleDocumentation/{ProvideVerboseMessage.md => UseVerboseMessageInDSCResource.md} (100%) diff --git a/RuleDocumentation/ProvideDefaultParameterValue.md b/RuleDocumentation/AvoidDefaultValueForMandatoryParameter.md similarity index 100% rename from RuleDocumentation/ProvideDefaultParameterValue.md rename to RuleDocumentation/AvoidDefaultValueForMandatoryParameter.md diff --git a/RuleDocumentation/AvoidDefaultTrueValueSwitchParameter.md b/RuleDocumentation/AvoidDefaultValueSwitchParameter.md similarity index 100% rename from RuleDocumentation/AvoidDefaultTrueValueSwitchParameter.md rename to RuleDocumentation/AvoidDefaultValueSwitchParameter.md diff --git a/RuleDocumentation/AvoidAlias.md b/RuleDocumentation/AvoidUsingCmdletAliases.md similarity index 100% rename from RuleDocumentation/AvoidAlias.md rename to RuleDocumentation/AvoidUsingCmdletAliases.md diff --git a/RuleDocumentation/AvoidEmptyCatchBlock.md b/RuleDocumentation/AvoidUsingEmptyCatchBlock.md similarity index 100% rename from RuleDocumentation/AvoidEmptyCatchBlock.md rename to RuleDocumentation/AvoidUsingEmptyCatchBlock.md diff --git a/RuleDocumentation/AvoidReservedCharInCmdlet.md b/RuleDocumentation/ReservedCmdletChar.md similarity index 100% rename from RuleDocumentation/AvoidReservedCharInCmdlet.md rename to RuleDocumentation/ReservedCmdletChar.md diff --git a/RuleDocumentation/AvoidReservedParams.md b/RuleDocumentation/ReservedParams.md similarity index 100% rename from RuleDocumentation/AvoidReservedParams.md rename to RuleDocumentation/ReservedParams.md diff --git a/RuleDocumentation/ReturnCorrectTypeDSCFunctions.md b/RuleDocumentation/ReturnCorrectTypesForDSCFunctions.md similarity index 100% rename from RuleDocumentation/ReturnCorrectTypeDSCFunctions.md rename to RuleDocumentation/ReturnCorrectTypesForDSCFunctions.md diff --git a/RuleDocumentation/UseShouldProcessCorrectly.md b/RuleDocumentation/ShouldProcess.md similarity index 100% rename from RuleDocumentation/UseShouldProcessCorrectly.md rename to RuleDocumentation/ShouldProcess.md diff --git a/RuleDocumentation/UseStandardDSCFunctionsInResource.md b/RuleDocumentation/StandardDSCFunctionsInResource.md similarity index 100% rename from RuleDocumentation/UseStandardDSCFunctionsInResource.md rename to RuleDocumentation/StandardDSCFunctionsInResource.md diff --git a/RuleDocumentation/UseIdenticalMandatoryParametersDSC.md b/RuleDocumentation/UseIdenticalMandatoryParametersForDSC.md similarity index 100% rename from RuleDocumentation/UseIdenticalMandatoryParametersDSC.md rename to RuleDocumentation/UseIdenticalMandatoryParametersForDSC.md diff --git a/RuleDocumentation/UseIdenticalParametersDSC.md b/RuleDocumentation/UseIdenticalParametersForDSC.md similarity index 100% rename from RuleDocumentation/UseIdenticalParametersDSC.md rename to RuleDocumentation/UseIdenticalParametersForDSC.md diff --git a/RuleDocumentation/ProvideVerboseMessage.md b/RuleDocumentation/UseVerboseMessageInDSCResource.md similarity index 100% rename from RuleDocumentation/ProvideVerboseMessage.md rename to RuleDocumentation/UseVerboseMessageInDSCResource.md From d4435ec2cc62a43667bebe1cf5e2a0802a52cd79 Mon Sep 17 00:00:00 2001 From: Kapil Borle Date: Fri, 31 Mar 2017 10:34:40 -0700 Subject: [PATCH 2/4] Update rule names in rule documentation --- RuleDocumentation/AvoidDefaultValueForMandatoryParameter.md | 2 +- RuleDocumentation/AvoidDefaultValueSwitchParameter.md | 2 +- RuleDocumentation/AvoidUsingCmdletAliases.md | 2 +- RuleDocumentation/AvoidUsingEmptyCatchBlock.md | 2 +- RuleDocumentation/ReservedCmdletChar.md | 2 +- RuleDocumentation/ReservedParams.md | 2 +- RuleDocumentation/ReturnCorrectTypesForDSCFunctions.md | 2 +- RuleDocumentation/ShouldProcess.md | 2 +- RuleDocumentation/StandardDSCFunctionsInResource.md | 2 +- RuleDocumentation/UseIdenticalMandatoryParametersForDSC.md | 2 +- RuleDocumentation/UseIdenticalParametersForDSC.md | 2 +- RuleDocumentation/UseVerboseMessageInDSCResource.md | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/RuleDocumentation/AvoidDefaultValueForMandatoryParameter.md b/RuleDocumentation/AvoidDefaultValueForMandatoryParameter.md index d90bec0a6..70f56f783 100644 --- a/RuleDocumentation/AvoidDefaultValueForMandatoryParameter.md +++ b/RuleDocumentation/AvoidDefaultValueForMandatoryParameter.md @@ -1,4 +1,4 @@ -# ProvideDefaultParameterValue +# AvoidDefaultValueForMandatoryParameter **Severity Level: Warning** diff --git a/RuleDocumentation/AvoidDefaultValueSwitchParameter.md b/RuleDocumentation/AvoidDefaultValueSwitchParameter.md index 20ea0e7b6..bd1f3018d 100644 --- a/RuleDocumentation/AvoidDefaultValueSwitchParameter.md +++ b/RuleDocumentation/AvoidDefaultValueSwitchParameter.md @@ -1,4 +1,4 @@ -# AvoidDefaultTrueValueSwitchParameter +# AvoidDefaultValueSwitchParameter **Severity Level: Warning** diff --git a/RuleDocumentation/AvoidUsingCmdletAliases.md b/RuleDocumentation/AvoidUsingCmdletAliases.md index d19f5aa1b..0165b6d90 100644 --- a/RuleDocumentation/AvoidUsingCmdletAliases.md +++ b/RuleDocumentation/AvoidUsingCmdletAliases.md @@ -1,4 +1,4 @@ -# AvoidAlias +# AvoidUsingCmdletAliases **Severity Level: Warning** diff --git a/RuleDocumentation/AvoidUsingEmptyCatchBlock.md b/RuleDocumentation/AvoidUsingEmptyCatchBlock.md index dbb7fd735..b08930259 100644 --- a/RuleDocumentation/AvoidUsingEmptyCatchBlock.md +++ b/RuleDocumentation/AvoidUsingEmptyCatchBlock.md @@ -1,4 +1,4 @@ -# AvoidEmptyCatchBlock +# AvoidUsingEmptyCatchBlock **Severity Level: Warning** diff --git a/RuleDocumentation/ReservedCmdletChar.md b/RuleDocumentation/ReservedCmdletChar.md index 8908d4e5b..5443ae010 100644 --- a/RuleDocumentation/ReservedCmdletChar.md +++ b/RuleDocumentation/ReservedCmdletChar.md @@ -1,4 +1,4 @@ -# AvoidReservedCharInCmdlet +# ReservedCmdletChar **Severity Level: Error** diff --git a/RuleDocumentation/ReservedParams.md b/RuleDocumentation/ReservedParams.md index d9658d1ee..b00f77691 100644 --- a/RuleDocumentation/ReservedParams.md +++ b/RuleDocumentation/ReservedParams.md @@ -1,4 +1,4 @@ -# AvoidReservedParams +# ReservedParams **Severity Level: Error** diff --git a/RuleDocumentation/ReturnCorrectTypesForDSCFunctions.md b/RuleDocumentation/ReturnCorrectTypesForDSCFunctions.md index dad1eda27..f41e242e8 100644 --- a/RuleDocumentation/ReturnCorrectTypesForDSCFunctions.md +++ b/RuleDocumentation/ReturnCorrectTypesForDSCFunctions.md @@ -1,4 +1,4 @@ -# ReturnCorrectTypeDSCFunctions +# ReturnCorrectTypesForDSCFunctions **Severity Level: Information** diff --git a/RuleDocumentation/ShouldProcess.md b/RuleDocumentation/ShouldProcess.md index 80f73960d..51cff102a 100644 --- a/RuleDocumentation/ShouldProcess.md +++ b/RuleDocumentation/ShouldProcess.md @@ -1,4 +1,4 @@ -# UseShouldProcessCorrectly +# ShouldProcess **Severity Level: Warning** diff --git a/RuleDocumentation/StandardDSCFunctionsInResource.md b/RuleDocumentation/StandardDSCFunctionsInResource.md index 3b63f7195..ad37f69c8 100644 --- a/RuleDocumentation/StandardDSCFunctionsInResource.md +++ b/RuleDocumentation/StandardDSCFunctionsInResource.md @@ -1,4 +1,4 @@ -# UseStandardDSCFunctionsInResource +# StandardDSCFunctionsInResource **Severity Level: Error** diff --git a/RuleDocumentation/UseIdenticalMandatoryParametersForDSC.md b/RuleDocumentation/UseIdenticalMandatoryParametersForDSC.md index d3c0acbc7..04ae5c6bb 100644 --- a/RuleDocumentation/UseIdenticalMandatoryParametersForDSC.md +++ b/RuleDocumentation/UseIdenticalMandatoryParametersForDSC.md @@ -1,4 +1,4 @@ -# UseIdenticalMandatoryParametersDSC +# UseIdenticalMandatoryParametersForDSC **Severity Level: Error** diff --git a/RuleDocumentation/UseIdenticalParametersForDSC.md b/RuleDocumentation/UseIdenticalParametersForDSC.md index f05921506..8d595db93 100644 --- a/RuleDocumentation/UseIdenticalParametersForDSC.md +++ b/RuleDocumentation/UseIdenticalParametersForDSC.md @@ -1,4 +1,4 @@ -# UseIdenticalParametersDSC +# UseIdenticalParametersForDSC **Severity Level: Error** diff --git a/RuleDocumentation/UseVerboseMessageInDSCResource.md b/RuleDocumentation/UseVerboseMessageInDSCResource.md index 4bb5e0ff4..d96a4c28a 100644 --- a/RuleDocumentation/UseVerboseMessageInDSCResource.md +++ b/RuleDocumentation/UseVerboseMessageInDSCResource.md @@ -1,4 +1,4 @@ -# ProvideVerboseMessage +# UseVerboseMessageInDSCResource **Severity Level: Information** From f99453665173d02e8c5418b158072e8e5d076ab9 Mon Sep 17 00:00:00 2001 From: Kapil Borle Date: Fri, 31 Mar 2017 10:39:21 -0700 Subject: [PATCH 3/4] Add missing documentation for MisleadingBacktick rule --- RuleDocumentation/MisleadingBacktick.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 RuleDocumentation/MisleadingBacktick.md diff --git a/RuleDocumentation/MisleadingBacktick.md b/RuleDocumentation/MisleadingBacktick.md new file mode 100644 index 000000000..a5b581601 --- /dev/null +++ b/RuleDocumentation/MisleadingBacktick.md @@ -0,0 +1,7 @@ +# MisleadingBacktick + +**Severity Level: Warning** + +## Description + +Checks that lines don't end with a backtick followed by whitespace. \ No newline at end of file From eef5c6a3858612c1b9bac6905d5f94317fe38e2b Mon Sep 17 00:00:00 2001 From: Kapil Borle Date: Fri, 31 Mar 2017 10:45:57 -0700 Subject: [PATCH 4/4] Add missing documentation for UseUTF8EncodingForHelpFile rule --- RuleDocumentation/UseUTF8EncodingForHelpFile.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 RuleDocumentation/UseUTF8EncodingForHelpFile.md diff --git a/RuleDocumentation/UseUTF8EncodingForHelpFile.md b/RuleDocumentation/UseUTF8EncodingForHelpFile.md new file mode 100644 index 000000000..30e9691d4 --- /dev/null +++ b/RuleDocumentation/UseUTF8EncodingForHelpFile.md @@ -0,0 +1,7 @@ +# UseUTF8EncodingForHelpFile + +**Severity Level: Warning** + +## Description + +Check if help file uses utf8 encoding \ No newline at end of file