Sort package versions in descending order.

Add switch to revert to old behaviour. Relates to #6.
tintoy · Aug 26, 2017 · a2558e9 · a2558e9
1 parent bf36e64
commit a2558e9
Show file tree

Hide file tree

Showing 8 changed files with 37 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Change Log
 
+## v0.1.11
+
+* Sort package versions in descending order.  
+  If you prefer the old behaviour, you can set `msbuildProjectTools.nuget.newestVersionsFirst` to `false`.
+
 ## v0.1.10
 
 * Improve tooltip content when hovering on MSBuild XML.

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
     "name": "msbuild-project-tools",
     "displayName": "MSBuild project tools",
     "description": "Tools for working with MSBuild project files (such as auto-complete for package Ids / versions).",
-    "version": "0.1.10",
+    "version": "0.1.11",
     "publisher": "tintoy",
     "license": "MIT",
     "repository": {
@@ -48,6 +48,7 @@
                             "trace": false
                         },
                         "nuget": {
+                            "newestVersionsFirst": true,
                             "disablePrefetch": false
                         }
                     },
@@ -97,9 +98,15 @@
                             "description": "Configuration for the MSBuild language service.",
                             "type": "object",
                             "default": {
+                                "newestVersionsFirst": true,
                                 "disablePreFetch": false
                             },
                             "properties": {
+                                "newestVersionsFirst": {
+                                    "type": "boolean",
+                                    "default": true,
+                                    "description": "Sort package versions in descending order (i.e. newest versions first)? Set this to false to revert to the old behaviour (VSCode decides how to sort the completion list)."
+                                },
                                 "disablePreFetch": {
                                     "type": "boolean",
                                     "default": false,

diff --git a/src/LanguageServer.Engine/Configuration.cs b/src/LanguageServer.Engine/Configuration.cs
@@ -29,5 +29,10 @@ public Configuration()
         ///     Disable automatic warm-up of the NuGet API client?
         /// </summary>
         public bool DisableNuGetPreFetch { get; set; } = false;
+
+        /// <summary>
+        ///     Sort package versions in descending order (i.e. newest versions first)?
+        /// </summary>
+        public bool ShowNewestNuGetVersionsFirst { get; set; } = true;
     }
 }
diff --git a/src/LanguageServer.Engine/Handlers/CompletionHandler.cs b/src/LanguageServer.Engine/Handlers/CompletionHandler.cs
@@ -180,16 +180,21 @@ async Task<CompletionList> OnCompletion(TextDocumentPositionParams parameters, C
                             return null;
 
                         string packageId = includeAttribute.Value;
-                        SortedSet<NuGetVersion> packageVersions = await projectDocument.SuggestPackageVersions(packageId, cancellationToken);
+                        IEnumerable<NuGetVersion> packageVersions = await projectDocument.SuggestPackageVersions(packageId, cancellationToken);
+                        if (Workspace.Configuration.ShowNewestNuGetVersionsFirst)
+                            packageVersions = packageVersions.Reverse();
+
+                        Lsp.Models.Range replacementRange = attributeValueRange.ToLsp();
 
                         completionItems.AddRange(
-                            packageVersions.Select(packageVersion => new CompletionItem
+                            packageVersions.Select((packageVersion, index) => new CompletionItem
                             {
                                 Label = packageVersion.ToNormalizedString(),
+                                SortText = Workspace.Configuration.ShowNewestNuGetVersionsFirst ? $"NuGet{index:00}" : null, // Override default sort order if configured to do so.
                                 Kind = CompletionItemKind.Field,
                                 TextEdit = new TextEdit
                                 {
-                                    Range = attributeValueRange.ToLsp(),
+                                    Range = replacementRange,
                                     NewText = packageVersion.ToNormalizedString()
                                 }
                             })

diff --git a/src/LanguageServer.Engine/Handlers/ConfigurationHandler.cs b/src/LanguageServer.Engine/Handlers/ConfigurationHandler.cs
@@ -88,6 +88,9 @@ Task OnDidChangeConfiguration(DidChangeConfigurationObjectParams parameters)
             {
                 if (nugetConfiguration.TryGetValue("disablePreFetch", out JToken disablePrefetch) && disablePrefetch.Type == JTokenType.Boolean)
                     Configuration.DisableNuGetPreFetch = disablePrefetch.Value<bool>();
+
+                if (nugetConfiguration.TryGetValue("newestVersionsFirst", out JToken newestVersionsFirst) && newestVersionsFirst.Type == JTokenType.Boolean)
+                    Configuration.ShowNewestNuGetVersionsFirst = newestVersionsFirst.Value<bool>();
             }
 
             if (ConfigurationChanged != null)

diff --git a/src/LanguageServer.Engine/Utilities/NuGetHelper.cs b/src/LanguageServer.Engine/Utilities/NuGetHelper.cs
@@ -189,7 +189,8 @@ public static Task<List<AutoCompleteResource>> GetAutoCompleteResources(params P
             );
 
             return new SortedSet<NuGetVersion>(
-                results.SelectMany(suggestions => suggestions)
+                results.SelectMany(suggestions => suggestions),
+                NuGet.Versioning.VersionComparer.VersionReleaseMetadata
             );
         }
     }

diff --git a/src/extension/extension.ts b/src/extension/extension.ts
@@ -119,6 +119,11 @@ interface LanguageSettings {
  * NuGet settings.
  */
 interface NuGetSettings {
+    /**
+     * Sort package versions in descending order (i.e. newest versions first)?
+     */
+    newestVersionsFirst: boolean;
+
     /**
      * Disable automatic warm-up of the NuGet client when opening a project?
      */