Fix parameter hints tests (but the whole feature needs work)

Author: andyleejordan

src/PowerShellEditorServices/Services/Symbols/ReferenceTable.cs

@@ -51,9 +51,14 @@ internal IEnumerable<SymbolReference> TryGetReferences(SymbolReference? symbol)
                 : Enumerable.Empty<SymbolReference>();
     }
 
+    // Gets symbol whose name contains the position
     internal SymbolReference? TryGetSymbolAtPosition(int line, int column) => GetAllReferences()
         .FirstOrDefault(i => i.NameRegion.ContainsPosition(line, column));
 
+    // Gets symbol whose whole extent contains the position
+    internal SymbolReference? TryGetSymbolContainingPosition(int line, int column) => GetAllReferences()
+        .FirstOrDefault(i => i.ScriptRegion.ContainsPosition(line, column));
+
     internal IEnumerable<SymbolReference> GetAllReferences()
     {
         EnsureInitialized();

src/PowerShellEditorServices/Services/Symbols/SymbolsService.cs

@@ -231,7 +231,9 @@ public static IEnumerable<SymbolReference> FindOccurrencesInFile(
         public async Task<ParameterSetSignatures?> FindParameterSetsInFileAsync(
             ScriptFile scriptFile, int line, int column)
         {
-            SymbolReference? symbol = FindSymbolAtLocation(scriptFile, line, column);
+            // This needs to get by whole extent, not just the name, as it completes e.g.
+            // `Get-Process -` (after the dash) and so also needs to look backwards a column.
+            SymbolReference? symbol = scriptFile.References.TryGetSymbolContainingPosition(line, column - 1);
 
             // If we are not possibly looking at a Function, we don't
             // need to continue because we won't be able to get the
@@ -255,6 +257,7 @@ await CommandHelpers.GetCommandInfoAsync(
 
             try
             {
+                // TODO: We should probably look at 'Parameters' instead of 'ParameterSets'
                 IEnumerable<CommandParameterSetInfo> commandParamSets = commandInfo.ParameterSets;
                 return new ParameterSetSignatures(commandParamSets, symbol);
             }

src/PowerShellEditorServices/Services/TextDocument/Handlers/SignatureHelpHandler.cs

@@ -34,7 +34,7 @@ public PsesSignatureHelpHandler(
         protected override SignatureHelpRegistrationOptions CreateRegistrationOptions(SignatureHelpCapability capability, ClientCapabilities clientCapabilities) => new()
         {
             DocumentSelector = LspUtils.PowerShellDocumentSelector,
-            // A sane default of " ". We may be able to include others like "-".
+            // TODO: We should evaluate what triggers (and re-triggers) signature help (like dash?)
             TriggerCharacters = new Container<string>(" ")
         };
 
@@ -54,7 +54,7 @@ await _symbolsService.FindParameterSetsInFileAsync(
                     request.Position.Line + 1,
                     request.Position.Character + 1).ConfigureAwait(false);
 
-            if (parameterSets == null)
+            if (parameterSets is null)
             {
                 return new SignatureHelp();
             }
@@ -89,7 +89,7 @@ private static ParameterInformation CreateParameterInfo(ParameterInfo parameterI
             return new ParameterInformation
             {
                 Label = parameterInfo.Name,
-                Documentation = string.Empty
+                Documentation = parameterInfo.HelpMessage
             };
         }
     }

test/PowerShellEditorServices.Test/Language/SymbolsServiceTests.cs

@@ -125,11 +125,17 @@ private IReadOnlyList<SymbolReference> GetOccurrences(ScriptRegion scriptRegion)
                 .ToArray();
         }
 
-        private IEnumerable<SymbolReference> FindSymbolsInFile(ScriptRegion scriptRegion) => symbolsService.FindSymbolsInFile(GetScriptFile(scriptRegion)).OrderBy(symbol => symbol.ScriptRegion.ToRange().Start);
+        private IEnumerable<SymbolReference> FindSymbolsInFile(ScriptRegion scriptRegion)
+        {
+            return symbolsService
+                .FindSymbolsInFile(GetScriptFile(scriptRegion))
+                .OrderBy(symbol => symbol.ScriptRegion.ToRange().Start);
+        }
 
         [Fact]
         public async Task FindsParameterHintsOnCommand()
         {
+            // TODO: Fix signatures to use parameters, not sets.
             ParameterSetSignatures signatures = await GetParamSetSignatures(FindsParameterSetsOnCommandData.SourceDetails).ConfigureAwait(true);
             Assert.NotNull(signatures);
             Assert.Equal("Get-Process", signatures.CommandName);