Prioritise autocompletion of common services and instance properties (#291)

* Prioritise autocompletion of common services

* Update common services

* Update for instances

* Update changelog

* Fix prioritised suggestions

Author: JohnnyMorganz

CHANGELOG.md

@@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Changed
 
 - Sync to upstream Luau 0.563
+- Prioritised common services and Instance properties/methods in autocomplete so that they show up first
 
 ### Fixed
 

src/LuauExt.cpp

@@ -470,6 +470,13 @@ Luau::LoadDefinitionFileResult registerDefinitions(Luau::TypeChecker& typeChecke
                                 if (Luau::isPrim(*it, Luau::PrimitiveType::String))
                                     Luau::attachMagicFunction(part, magicFunctionInstanceNew);
 
+    // Mark `game:GetService()` with a tag so we can prioritise services when autocompleting
+    if (auto serviceProviderType = typeChecker.globalScope->lookupType("ServiceProvider"))
+        if (auto* ctv = Luau::getMutable<Luau::ClassType>(serviceProviderType->type))
+            // :GetService is an intersection of function types, so we assign a tag on the first intersection
+            if (auto* itv = Luau::getMutable<Luau::IntersectionType>(ctv->props["GetService"].type); itv && itv->parts.size() > 0)
+                Luau::attachTag(itv->parts[0], "PrioritiseCommonServices");
+
     // Move Enums over as imported type bindings
     std::unordered_map<Luau::Name, Luau::TypeFun> enumTypes{};
     for (auto it = typeChecker.globalScope->exportedTypeBindings.begin(); it != typeChecker.globalScope->exportedTypeBindings.end();)

src/operations/Completion.cpp

@@ -11,16 +11,51 @@
 /// Note that sort text is lexicographically
 namespace SortText
 {
-static constexpr const char* TableProperties = "0";
-static constexpr const char* CorrectTypeKind = "1";
-static constexpr const char* CorrectFunctionResult = "2";
-static constexpr const char* Default = "3";
-static constexpr const char* WrongIndexType = "4";
-static constexpr const char* MetatableIndex = "5";
-static constexpr const char* AutoImports = "6";
-static constexpr const char* Keywords = "7";
+static constexpr const char* PrioritisedSuggestion = "0";
+static constexpr const char* TableProperties = "1";
+static constexpr const char* CorrectTypeKind = "2";
+static constexpr const char* CorrectFunctionResult = "3";
+static constexpr const char* Default = "4";
+static constexpr const char* WrongIndexType = "5";
+static constexpr const char* MetatableIndex = "6";
+static constexpr const char* AutoImports = "7";
+static constexpr const char* Keywords = "8";
 } // namespace SortText
 
+static constexpr const char* COMMON_SERVICES[] = {
+    "Players",
+    "ReplicatedStorage",
+    "ServerStorage",
+    "MessagingService",
+    "TeleportService",
+    "HttpService",
+    "CollectionService",
+    "DataStoreService",
+    "ContextActionService",
+    "UserInputService",
+    "Teams",
+    "Chat",
+    "TextService",
+    "TextChatService",
+    "GamepadService",
+    "VoiceChatService",
+};
+
+static constexpr const char* COMMON_INSTANCE_PROPERTIES[] = {
+    "Parent",
+    "Name",
+    // Methods
+    "FindFirstChild",
+    "IsA",
+    "Destroy",
+    "GetAttribute",
+    "GetChildren",
+    "GetDescendants",
+    "WaitForChild",
+    "Clone",
+    "SetAttribute",
+};
+
 void WorkspaceFolder::endAutocompletion(const lsp::CompletionParams& params)
 {
     auto moduleName = fileResolver.getModuleName(params.textDocument.uri);
@@ -310,6 +345,8 @@ std::vector<lsp::CompletionItem> WorkspaceFolder::completion(const lsp::Completi
     if (!textDocument)
         throw JsonRpcException(lsp::ErrorCode::RequestFailed, "No managed text document for " + params.textDocument.uri.toString());
 
+    bool isGetService = false;
+
     auto position = textDocument->convertPosition(params.position);
     auto result = Luau::autocomplete(frontend, moduleName, position,
         [&](const std::string& tag, std::optional<const Luau::ClassType*> ctx,
@@ -413,6 +450,12 @@ std::vector<lsp::CompletionItem> WorkspaceFolder::completion(const lsp::Completi
                     return std::nullopt;
                 }
             }
+            else if (tag == "PrioritiseCommonServices")
+            {
+                // We are autocompleting a `game:GetService("$1")` call, so we set a flag to
+                // highlight this so that we can prioritise common services first in the list
+                isGetService = true;
+            }
 
             return std::nullopt;
         });
@@ -438,19 +481,35 @@ std::vector<lsp::CompletionItem> WorkspaceFolder::completion(const lsp::Completi
         if (documentationString)
             item.documentation = {lsp::MarkupKind::Markdown, documentationString.value()};
 
+        if (entry.wrongIndexType)
+            item.sortText = SortText::WrongIndexType;
         if (entry.typeCorrect == Luau::TypeCorrectKind::Correct)
             item.sortText = SortText::CorrectTypeKind;
         else if (entry.typeCorrect == Luau::TypeCorrectKind::CorrectFunctionResult)
             item.sortText = SortText::CorrectFunctionResult;
         else if (entry.kind == Luau::AutocompleteEntryKind::Property && types::isMetamethod(name))
             item.sortText = SortText::MetatableIndex;
-        else if (entry.wrongIndexType)
-            item.sortText = SortText::WrongIndexType;
         else if (entry.kind == Luau::AutocompleteEntryKind::Property)
             item.sortText = SortText::TableProperties;
         else if (entry.kind == Luau::AutocompleteEntryKind::Keyword)
             item.sortText = SortText::Keywords;
 
+        // If its a `game:GetSerivce("$1")` call, then prioritise common services
+        if (isGetService)
+        {
+            if (auto it = std::find(std::begin(COMMON_SERVICES), std::end(COMMON_SERVICES), name); it != std::end(COMMON_SERVICES))
+                item.sortText = SortText::PrioritisedSuggestion;
+        }
+        // If calling a property on an Instance, then prioritise these properties
+        if (auto instanceType = frontend.typeCheckerForAutocomplete.globalScope->lookupType("Instance");
+            instanceType && Luau::get<Luau::ClassType>(instanceType->type) && entry.containingClass &&
+            Luau::isSubclass(entry.containingClass.value(), Luau::get<Luau::ClassType>(instanceType->type)) && !entry.wrongIndexType)
+        {
+            if (auto it = std::find(std::begin(COMMON_INSTANCE_PROPERTIES), std::end(COMMON_INSTANCE_PROPERTIES), name);
+                it != std::end(COMMON_INSTANCE_PROPERTIES))
+                item.sortText = SortText::PrioritisedSuggestion;
+        }
+
         switch (entry.kind)
         {
         case Luau::AutocompleteEntryKind::Property: