Merge pull request #448 from PowerShell/ExtentFixBranch

Emit accurate extents for non-approved verb violations

Author: raghushantha

Engine/Helper.cs

@@ -645,6 +645,28 @@ public bool SkipBlock(string keyword, Ast namedBlockAst)
             return false;
         }
 
+        // Obtain script extent for the function - just around the function name
+        public IScriptExtent GetScriptExtentForFunctionName(FunctionDefinitionAst functionDefinitionAst)
+        {
+            if (null == functionDefinitionAst)
+            {
+                return null;
+            }
+
+            // Obtain the index where the function name is in Tokens
+            int funcTokenIndex = Tokens.Select((s, index) => new { s, index })
+                          .Where(x => x.s.Extent.StartOffset == functionDefinitionAst.Extent.StartOffset)
+                          .Select(x => x.index).FirstOrDefault();
+
+            if (funcTokenIndex > 0 && funcTokenIndex < Helper.Instance.Tokens.Count())
+            {
+                // return the extent of the next token - this is the extent for the function name
+                return Tokens[++funcTokenIndex].Extent;
+            }
+
+            return null;
+        }
+        
         private void FindClosingParenthesis(string keyword)
         {
             if (Tokens == null || Tokens.Length == 0)

Rules/UseApprovedVerbs.cs

@@ -63,8 +63,15 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName) {
 
                     if (!approvedVerbs.Contains(verb, StringComparer.OrdinalIgnoreCase))
                     {
+                        IScriptExtent extent = Helper.Instance.GetScriptExtentForFunctionName(funcAst);
+
+                        if (null == extent)
+                        {
+                            extent = funcAst.Extent;
+                        }
+
                         yield return new DiagnosticRecord(string.Format(CultureInfo.CurrentCulture, Strings.UseApprovedVerbsError, funcName),
-                            funcAst.Extent, GetName(), DiagnosticSeverity.Warning, fileName);
+                            extent, GetName(), DiagnosticSeverity.Warning, fileName);
                     }
                 }
             }

Rules/UseSingularNouns.cs

@@ -56,8 +56,15 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName) {
 
                     if (!ps.IsSingular(noun) && ps.IsPlural(noun))
                     {
+                        IScriptExtent extent = Helper.Instance.GetScriptExtentForFunctionName(funcAst);
+
+                        if (null == extent)
+                        {
+                            extent = funcAst.Extent;
+                        }
+
                         yield return new DiagnosticRecord(string.Format(CultureInfo.CurrentCulture, Strings.UseSingularNounsError, funcAst.Name),
-                            funcAst.Extent, GetName(), DiagnosticSeverity.Warning, fileName);
+                            extent, GetName(), DiagnosticSeverity.Warning, fileName);
                     }
                 }
             }