Rename UseWhitespace rule to UseConsistentWhitespace

Author: Kapil Borle

RuleDocumentation/UseWhitespace.md renamed to RuleDocumentation/UseConsistentWhitespace.md

@@ -1,4 +1,4 @@
-# UseWhitespace
+# UseConsistentWhitespace
 **Severity Level: Warning**
 
 ## Description
@@ -9,13 +9,14 @@ This rule enforces consistent brace, parenthesis, binary operator, assignment op
 ## Configuration
 ```powershell
     Rules = @{
-        PSUseWhitespace = @{
+        PSUseConsistentWhitespace = @{
             Enable = $true
             CheckOpenBrace = $true
             CheckOpenParen = $true
             CheckOperator = $true
             CheckSeparator = $true
         }
+    }
 ```
 
 ### Parameters

Rules/ScriptAnalyzerBuiltinRules.csproj

@@ -120,7 +120,7 @@
     <Compile Include="PlaceOpenBrace.cs" />
     <Compile Include="PlaceCloseBrace.cs" />
     <Compile Include="UseConsistentIndentation.cs" />
-    <Compile Include="UseWhitespace.cs" />
+    <Compile Include="UseConsistentWhitespace.cs" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\Engine\ScriptAnalyzerEngine.csproj">

Rules/Strings.resx

@@ -915,28 +915,28 @@
   <data name="UseConsistentIndentationError" xml:space="preserve">
     <value>Indentation not consistent</value>
   </data>
-  <data name="UseWhitespaceName" xml:space="preserve">
-    <value>UseWhitespace</value>
+  <data name="UseConsistentWhitespaceName" xml:space="preserve">
+    <value>UseConsistentWhitespace</value>
   </data>
-  <data name="UseWhitespaceCommonName" xml:space="preserve">
+  <data name="UseConsistentWhitespaceCommonName" xml:space="preserve">
     <value>Use whitespaces</value>
   </data>
-  <data name="UseWhitespaceDescription" xml:space="preserve">
+  <data name="UseConsistentWhitespaceDescription" xml:space="preserve">
     <value>Check for whitespace between keyword and open paren/curly, around assigment operator ('='), around arithmetic operators and after separators (',' and ';')</value>
   </data>
-  <data name="UseWhitespaceErrorBeforeBrace" xml:space="preserve">
+  <data name="UseConsistentWhitespaceErrorBeforeBrace" xml:space="preserve">
     <value>Use space before open brace.</value>
   </data>
-  <data name="UseWhitespaceErrorBeforeParen" xml:space="preserve">
+  <data name="UseConsistentWhitespaceErrorBeforeParen" xml:space="preserve">
     <value>Use space before open parenthesis.</value>
   </data>
-  <data name="UseWhitespaceErrorOperator" xml:space="preserve">
+  <data name="UseConsistentWhitespaceErrorOperator" xml:space="preserve">
     <value>Use space before and after binary and assignment operators.</value>
   </data>
-  <data name="UseWhitespaceErrorSeparatorComma" xml:space="preserve">
+  <data name="UseConsistentWhitespaceErrorSeparatorComma" xml:space="preserve">
     <value>Use space after a comma.</value>
   </data>
-  <data name="UseWhitespaceErrorSeparatorSemi" xml:space="preserve">
+  <data name="UseConsistentWhitespaceErrorSeparatorSemi" xml:space="preserve">
     <value>Use space after a semicolon.</value>
   </data>
 </root>

Rules/UseWhitespace.cs renamed to Rules/UseConsistentWhitespace.cs

@@ -27,7 +27,7 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 #if !CORECLR
     [Export(typeof(IScriptRule))]
 #endif
-    public class UseWhitespace : ConfigurableRule
+    public class UseConsistentWhitespace : ConfigurableRule
     {
         private enum ErrorKind { Brace, Paren, Operator, SeparatorComma, SeparatorSemi };
         private const int whiteSpaceSize = 1;
@@ -100,15 +100,15 @@ private string GetError(ErrorKind kind)
             switch (kind)
             {
                 case ErrorKind.Brace:
-                    return string.Format(CultureInfo.CurrentCulture, Strings.UseWhitespaceErrorBeforeBrace);
+                    return string.Format(CultureInfo.CurrentCulture, Strings.UseConsistentWhitespaceErrorBeforeBrace);
                 case ErrorKind.Operator:
-                    return string.Format(CultureInfo.CurrentCulture, Strings.UseWhitespaceErrorOperator);
+                    return string.Format(CultureInfo.CurrentCulture, Strings.UseConsistentWhitespaceErrorOperator);
                 case ErrorKind.SeparatorComma:
-                    return string.Format(CultureInfo.CurrentCulture, Strings.UseWhitespaceErrorSeparatorComma);
+                    return string.Format(CultureInfo.CurrentCulture, Strings.UseConsistentWhitespaceErrorSeparatorComma);
                 case ErrorKind.SeparatorSemi:
-                    return string.Format(CultureInfo.CurrentCulture, Strings.UseWhitespaceErrorSeparatorSemi);
+                    return string.Format(CultureInfo.CurrentCulture, Strings.UseConsistentWhitespaceErrorSeparatorSemi);
                 default:
-                    return string.Format(CultureInfo.CurrentCulture, Strings.UseWhitespaceErrorBeforeParen);
+                    return string.Format(CultureInfo.CurrentCulture, Strings.UseConsistentWhitespaceErrorBeforeParen);
             }
         }
 
@@ -321,15 +321,15 @@ private bool IsPreviousTokenOnSameLine(LinkedListNode<Token> lparen)
         /// </summary>
         public override string GetCommonName()
         {
-            return string.Format(CultureInfo.CurrentCulture, Strings.UseWhitespaceCommonName);
+            return string.Format(CultureInfo.CurrentCulture, Strings.UseConsistentWhitespaceCommonName);
         }
 
         /// <summary>
         /// Retrieves the description of this rule.
         /// </summary>
         public override string GetDescription()
         {
-            return string.Format(CultureInfo.CurrentCulture, Strings.UseWhitespaceDescription);
+            return string.Format(CultureInfo.CurrentCulture, Strings.UseConsistentWhitespaceDescription);
         }
 
         /// <summary>
@@ -341,7 +341,7 @@ public override string GetName()
                 CultureInfo.CurrentCulture,
                 Strings.NameSpaceFormat,
                 GetSourceName(),
-                Strings.UseWhitespaceName);
+                Strings.UseConsistentWhitespaceName);
         }
 
         /// <summary>

Tests/Rules/UseWhitespace.tests.ps1 renamed to Tests/Rules/UseConsistentWhitespace.tests.ps1

@@ -4,7 +4,7 @@ $testRootDirectory = Split-Path -Parent $directory
 Import-Module PSScriptAnalyzer
 Import-Module (Join-Path $testRootDirectory "PSScriptAnalyzerTestHelper.psm1")
 
-$ruleName = "PSUseWhitespace"
+$ruleName = "PSUseConsistentWhitespace"
 $ruleConfiguration = @{
     Enable = $true
     CheckOpenBrace = $false
@@ -16,7 +16,7 @@ $ruleConfiguration = @{
 $settings = @{
     IncludeRules = @($ruleName)
     Rules = @{
-        PSUseWhitespace = $ruleConfiguration
+        PSUseConsistentWhitespace = $ruleConfiguration
     }
 }