Merge branch 'NewRule' into BugFixes

Author: yutingc

RuleDocumentation/UseShouldProcessForStateChangingFunctions.md

@@ -0,0 +1,30 @@
+#UseShouldProcessForStateChangingFunctions
+**Severity Level: Warning**
+
+##Description
+
+Functions that have verbs like New, Start, Stop, Set, Reset and Restart that change system state should support 'ShouldProcess'
+
+##How to Fix
+
+To fix a violation of this rule, please add attribute SupportsShouldProcess. eg: [CmdletBinding(SupportsShouldProcess = $true)] to the function.
+
+##Example
+
+Wrong:
+```
+	function Set-ServiceObject
+	{
+	    [CmdletBinding()]
+    	    param ([string]$c)
+	}
+```
+
+Correct: 
+```
+	function Set-ServiceObject
+	{
+	    [CmdletBinding(SupportsShouldProcess = $true)]
+	    param ([string]$c)
+	}
+```

Rules/Strings.Designer.cs

@@ -658,7 +658,7 @@
     <value>Use ShouldProcess For State Changing Functions</value>
   </data>
   <data name="UseShouldProcessForStateChangingFunctionsDescrption" xml:space="preserve">
-    <value>Functions that have verbs like New, Start, Stop, Set, Reset that change system state should support 'ShouldProcess'.</value>
+    <value>Functions that have verbs like New, Start, Stop, Set, Reset, Restart that change system state should support 'ShouldProcess'.</value>
   </data>
   <data name="UseShouldProcessForStateChangingFunctionsError" xml:space="preserve">
     <value>Function ’{0}’ has verb that could change system state. Therefore, the function has to support 'ShouldProcess'.</value>

Rules/Strings.resx

@@ -44,7 +44,8 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
                 string funcName = funcDefAst.Name;
                 bool hasShouldProcessAttribute = false;
 
-                if (funcName.StartsWith("Stop-", StringComparison.OrdinalIgnoreCase)||
+                if (funcName.StartsWith("Restart-", StringComparison.OrdinalIgnoreCase) ||
+                    funcName.StartsWith("Stop-", StringComparison.OrdinalIgnoreCase)||
                     funcName.StartsWith("New-", StringComparison.OrdinalIgnoreCase) ||
                     funcName.StartsWith("Set-", StringComparison.OrdinalIgnoreCase) ||
                     funcName.StartsWith("Update-", StringComparison.OrdinalIgnoreCase) ||
@@ -75,7 +76,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
                         if (!hasShouldProcessAttribute)
                         {
                             yield return
-                                new DiagnosticRecord(string.Format(CultureInfo.CurrentCulture,Strings.UseShouldProcessForStateChangingFunctionsError, funcName),funcDefAst.Extent, GetName(), DiagnosticSeverity.Warning, fileName);
+                                 new DiagnosticRecord(string.Format(CultureInfo.CurrentCulture,Strings.UseShouldProcessForStateChangingFunctionsError, funcName),funcDefAst.Extent, GetName(), DiagnosticSeverity.Warning, fileName);
                         }
                     }
                 }