Implementation for issue #98 - shorting file path completion list.

This commit not only addresses issue #98 but also improves completion list support overall for commands (shows resolved command or path to exe), parameters (shows parameter type) as well as .NET properties and methods (shows signature).

Author: rkeithhill

src/PowerShellEditorServices.Protocol/Server/LanguageServer.cs

@@ -431,10 +431,6 @@ await editorSession.LanguageService.GetCompletionsInFile(
 
             if (completionResults != null)
             {
-                // By default, insert the completion at the current location
-                int startEditColumn = textDocumentPosition.Position.Character;
-                int endEditColumn = textDocumentPosition.Position.Character;
-
                 completionItems =
                     completionResults
                         .Completions
@@ -918,7 +914,7 @@ await PublishScriptDiagnostics(
             Logger.Write(LogLevel.Verbose, "Analysis complete.");
         }
 
-        private async static Task PublishScriptDiagnostics(
+        private static async Task PublishScriptDiagnostics(
             ScriptFile scriptFile,
             ScriptFileMarker[] semanticMarkers,
             EventContext eventContext)
@@ -989,23 +985,59 @@ private static CompletionItem CreateCompletionItem(
             BufferRange completionRange)
         {
             string detailString = null;
+            string documentationString = null;
+            string labelString = completionDetails.ListItemText;
 
-            if (completionDetails.CompletionType == CompletionType.Variable)
+            if ((completionDetails.CompletionType == CompletionType.Variable) ||
+                (completionDetails.CompletionType == CompletionType.ParameterName))
             {
-                // Look for variable type encoded in the tooltip
+                // Look for type encoded in the tooltip for parameters and variables.
+                // Display PowerShell type names in [] to be consistent with PowerShell syntax
+                // and now the debugger displays type names.
                 var matches = Regex.Matches(completionDetails.ToolTipText, @"^\[(.+)\]");
+                if ((matches.Count > 0) && (matches[0].Groups.Count > 1))
+                {
+                    detailString = "[" + matches[0].Groups[1].Value + "]";
+                }
 
-                if (matches.Count > 0 && matches[0].Groups.Count > 1)
+                // PowerShell returns ListItemText for parameters & variables that is not prefixed
+                // and it needs to be or the completion will not appear for these CompletionTypes.
+                string prefix = (completionDetails.CompletionType == CompletionType.Variable) ? "$" : "-";
+                labelString = prefix + completionDetails.ListItemText;
+            }
+            else if ((completionDetails.CompletionType == CompletionType.Method) ||
+                     (completionDetails.CompletionType == CompletionType.Property))
+            {
+                // We have a raw signature for .NET members, heck let's display it.  It's
+                // better than nothing.
+                documentationString = completionDetails.ToolTipText;
+            }
+            else if (completionDetails.CompletionType == CompletionType.Command)
+            {
+                // For Commands, let's extract the resolved command or the path for an exe
+                // from the ToolTipText - if there is any ToolTipText.
+                if (completionDetails.ToolTipText != null)
                 {
-                    detailString = matches[0].Groups[1].Value;
+                    // Don't display ToolTipText if it is the same as the ListItemText.
+                    // Reject command syntax ToolTipText - it's too much to display as a detailString.
+                    if (!completionDetails.ListItemText.Equals(
+                            completionDetails.ToolTipText,
+                            StringComparison.OrdinalIgnoreCase) &&
+                        !Regex.IsMatch(completionDetails.ToolTipText, 
+                            @"^\s*" + completionDetails.ListItemText + @"\s+\["))
+                    {
+                        detailString = completionDetails.ToolTipText;
+                    }
                 }
             }
 
             return new CompletionItem
             {
-                Label = completionDetails.CompletionText,
+                InsertText = completionDetails.CompletionText,
+                Label = labelString,
                 Kind = MapCompletionKind(completionDetails.CompletionType),
                 Detail = detailString,
+                Documentation = documentationString,
                 TextEdit = new TextEdit
                 {
                     NewText = completionDetails.CompletionText,

src/PowerShellEditorServices/Language/CompletionResults.cs

@@ -107,6 +107,11 @@ public enum CompletionType
         /// </summary>
         ParameterValue,
 
+        /// <summary>
+        /// Identifies a completion for a .NET property.
+        /// </summary>
+        Property,
+
         /// <summary>
         /// Identifies a completion for a variable name.
         /// </summary>
@@ -147,6 +152,11 @@ public sealed class CompletionDetails
         /// </summary>
         public string CompletionText { get; private set; }
 
+        /// <summary>
+        /// Gets the text that should be dispayed in a drop-down completion list.
+        /// </summary>
+        public string ListItemText { get; private set; }
+
         /// <summary>
         /// Gets the text that can be used to display a tooltip for
         /// the statement at the requested file offset.
@@ -183,6 +193,7 @@ internal static CompletionDetails Create(CompletionResult completionResult)
             return new CompletionDetails
             {
                 CompletionText = completionResult.CompletionText,
+                ListItemText = completionResult.ListItemText,
                 ToolTipText = toolTipText,
                 SymbolTypeName = ExtractSymbolTypeNameFromToolTip(completionResult.ToolTip),
                 CompletionType = 
@@ -195,12 +206,14 @@ internal static CompletionDetails Create(
             string completionText,
             CompletionType completionType,
             string toolTipText = null,
-            string symbolTypeName = null)
+            string symbolTypeName = null,
+            string listItemText = null)
         {
             return new CompletionDetails
             {
                 CompletionText = completionText,
                 CompletionType = completionType,
+                ListItemText = listItemText,
                 ToolTipText = toolTipText,
                 SymbolTypeName = symbolTypeName
             };
@@ -238,9 +251,10 @@ public override int GetHashCode()
         {
             return
                 string.Format(
-                    "{0}{1}{2}{3}",
+                    "{0}{1}{2}{3}{4}",
                     this.CompletionText,
                     this.CompletionType,
+                    this.ListItemText,
                     this.ToolTipText,
                     this.SymbolTypeName).GetHashCode();
         }
@@ -266,6 +280,9 @@ private static CompletionType ConvertCompletionResultType(
                 case CompletionResultType.ParameterValue:
                     return CompletionType.ParameterValue;
 
+                case CompletionResultType.Property:
+                    return CompletionType.Property;
+
                 case CompletionResultType.Variable:
                     return CompletionType.Variable;
 

test/PowerShellEditorServices.Test.Host/LanguageServerTests.cs

@@ -111,7 +111,7 @@ await this.SendRequest(
                         c => c.Label == "$ConsoleFileName");
 
             Assert.NotNull(consoleFileNameItem);
-            Assert.Equal("string", consoleFileNameItem.Detail);
+            Assert.Equal("[string]", consoleFileNameItem.Detail);
         }
 
         [Fact(Skip = "Skipped until variable documentation gathering is added back.")]

test/PowerShellEditorServices.Test/Language/PowerShellVersionTests.cs

@@ -58,13 +58,23 @@ private void Compile(string project, string version)
             }
 
             FileInfo fi = new FileInfo(project);
+            string solutionDir = fi.Directory.Parent.Parent.FullName;
             var outPath = Path.GetTempPath();
 
             var p = new Process();
             p.StartInfo.FileName = msbuild;
-            p.StartInfo.Arguments = string.Format(@" {0} /p:Configuration=Debug /t:Build /fileLogger /flp1:logfile=errors.txt;errorsonly  /p:SolutionDir={1} /p:SolutionName=PowerShellEditorServices /p:DefineConstants=PowerShellv{2} /p:OutDir={3}", project, fi.Directory.Parent.Parent.FullName, version, outPath);
+            p.StartInfo.Arguments = string.Format(@" {0} /p:Configuration=Debug /t:Build /fileLogger " + 
+                                                  @"/flp1:logfile=errors.txt;errorsonly  /p:SolutionDir={1} " + 
+                                                  @"/p:SolutionName=PowerShellEditorServices " + 
+                                                  @"/p:DefineConstants=PowerShellv{2} /p:OutDir={3}", 
+                                                  project, solutionDir, version, outPath);
             p.StartInfo.UseShellExecute = false;
             p.StartInfo.CreateNoWindow = true;
+
+            // On my system, the parent process (VS I guess), defines an environment variable - PLATFORM=X64 - 
+            // which breaks the build of the versioned C# project files. Removing it fixes the issue.
+            p.StartInfo.EnvironmentVariables.Remove("Platform");
+
             p.Start();
             p.WaitForExit(60000);
             if (!p.HasExited)