Add Scope enum to represent scopes

Author: intitni

Core/Sources/ChatContextCollectors/SystemInfoChatContextCollector/SystemInfoChatContextCollector.swift

@@ -13,7 +13,7 @@ public final class SystemInfoChatContextCollector: ChatContextCollector {
 
     public func generateContext(
         history: [ChatMessage],
-        scopes: Set<String>,
+        scopes: Set<ChatContext.Scope>,
         content: String,
         configuration: ChatGPTConfiguration
     ) -> ChatContext {

Core/Sources/ChatContextCollectors/WebChatContextCollector/WebChatContextCollector.swift

@@ -9,11 +9,11 @@ public final class WebChatContextCollector: ChatContextCollector {
 
     public func generateContext(
         history: [ChatMessage],
-        scopes: Set<String>,
+        scopes: Set<ChatContext.Scope>,
         content: String,
         configuration: ChatGPTConfiguration
     ) -> ChatContext {
-        guard scopes.contains("web") || scopes.contains("w") else { return .empty }
+        guard scopes.contains(.web) else { return .empty }
         let links = Self.detectLinks(from: history) + Self.detectLinks(from: content)
         let functions: [(any ChatGPTFunction)?] = [
             SearchFunction(maxTokens: configuration.maxTokens),

Core/Sources/ChatService/ChatService.swift

@@ -6,13 +6,7 @@ import OpenAIService
 import Preferences
 
 public final class ChatService: ObservableObject {
-    public enum Scope: String, Equatable, CaseIterable {
-        case file
-        case code
-        case sense
-        case project
-        case web
-    }
+    public typealias Scope = ChatContext.Scope
 
     public let memory: ContextAwareAutoManagedChatGPTMemory
     public let configuration: OverridingChatGPTConfiguration
@@ -96,7 +90,7 @@ public final class ChatService: ObservableObject {
     }
 
     public func send(content: String) async throws {
-        memory.contextController.defaultScopes = Set(defaultScopes.map(\.rawValue))
+        memory.contextController.defaultScopes = defaultScopes
         guard !isReceivingMessage else { throw CancellationError() }
         let handledInPlugin = try await pluginController.handleContent(content)
         if handledInPlugin { return }

Core/Sources/ChatService/ContextAwareAutoManagedChatGPTMemory.swift

@@ -24,7 +24,7 @@ public final class ContextAwareAutoManagedChatGPTMemory: ChatGPTMemory {
     }
 
     init(
-        configuration: ChatGPTConfiguration,
+        configuration: OverridingChatGPTConfiguration,
         functionProvider: ChatFunctionProvider
     ) {
         memory = AutoManagedChatGPTMemory(

Core/Sources/ChatService/DynamicContextController.swift

@@ -8,13 +8,13 @@ final class DynamicContextController {
     let contextCollectors: [ChatContextCollector]
     let memory: AutoManagedChatGPTMemory
     let functionProvider: ChatFunctionProvider
-    let configuration: ChatGPTConfiguration
-    var defaultScopes = [] as Set<String>
+    let configuration: OverridingChatGPTConfiguration
+    var defaultScopes = [] as Set<ChatContext.Scope>
 
     convenience init(
         memory: AutoManagedChatGPTMemory,
         functionProvider: ChatFunctionProvider,
-        configuration: ChatGPTConfiguration,
+        configuration: OverridingChatGPTConfiguration,
         contextCollectors: ChatContextCollector...
     ) {
         self.init(
@@ -28,7 +28,7 @@ final class DynamicContextController {
     init(
         memory: AutoManagedChatGPTMemory,
         functionProvider: ChatFunctionProvider,
-        configuration: ChatGPTConfiguration,
+        configuration: OverridingChatGPTConfiguration,
         contextCollectors: [ChatContextCollector]
     ) {
         self.memory = memory
@@ -86,7 +86,7 @@ final class DynamicContextController {
 }
 
 extension DynamicContextController {
-    static func parseScopes(_ prompt: inout String) -> Set<String> {
+    static func parseScopes(_ prompt: inout String) -> Set<ChatContext.Scope> {
         let parser = MessageScopeParser()
         return parser(&prompt)
     }

Pro

@@ -3,6 +3,14 @@ import OpenAIService
 import Parsing
 
 public struct ChatContext {
+    public enum Scope: String, Equatable, CaseIterable {
+        case file
+        case code
+        case sense
+        case project
+        case web
+    }
+
     public struct RetrievedContent {
         public var content: String
         public var priority: Int
@@ -31,10 +39,22 @@ public struct ChatContext {
     }
 }
 
+public extension ChatContext.Scope {
+    init?(text: String) {
+        for scope in Self.allCases {
+            if scope.rawValue.hasPrefix(text.lowercased()) {
+                self = scope
+                return
+            }
+        }
+        return nil
+    }
+}
+
 public protocol ChatContextCollector {
     func generateContext(
         history: [ChatMessage],
-        scopes: Set<String>,
+        scopes: Set<ChatContext.Scope>,
         content: String,
         configuration: ChatGPTConfiguration
     ) async -> ChatContext
@@ -43,11 +63,11 @@ public protocol ChatContextCollector {
 public struct MessageScopeParser {
     public init() {}
 
-    public func callAsFunction(_ content: inout String) -> Set<String> {
+    public func callAsFunction(_ content: inout String) -> Set<ChatContext.Scope> {
         return parseScopes(&content)
     }
 
-    func parseScopes(_ prompt: inout String) -> Set<String> {
+    func parseScopes(_ prompt: inout String) -> Set<ChatContext.Scope> {
         guard !prompt.isEmpty else { return [] }
         do {
             let parser = Parse {
@@ -68,7 +88,7 @@ public struct MessageScopeParser {
             }
             let (scopes, rest) = try parser.parse(prompt)
             prompt = String(rest)
-            return Set(scopes.map(String.init))
+            return Set(scopes.map(String.init).compactMap(ChatContext.Scope.init(text:)))
         } catch {
             return []
         }

Tool/Sources/ChatContextCollector/ChatContextCollector.swift

@@ -14,16 +14,16 @@ public final class ActiveDocumentChatContextCollector: ChatContextCollector {
 
     public func generateContext(
         history: [ChatMessage],
-        scopes: Set<String>,
+        scopes: Set<ChatContext.Scope>,
         content: String,
         configuration: ChatGPTConfiguration
     ) -> ChatContext {
         guard let info = getEditorInformation() else { return .empty }
         let context = getActiveDocumentContext(info)
         activeDocumentContext = context
 
-        guard scopes.contains("code") || scopes.contains("c") else {
-            if scopes.contains("file") || scopes.contains("f") {
+        guard scopes.contains(.code) else {
+            if scopes.contains(.file) {
                 var removedCode = context
                 removedCode.focusedContext = nil
                 return .init(

Tool/Sources/ChatContextCollectors/ActiveDocumentChatContextCollector/ActiveDocumentChatContextCollector.swift

@@ -10,15 +10,15 @@ public struct LegacyActiveDocumentChatContextCollector: ChatContextCollector {
 
     public func generateContext(
         history: [ChatMessage],
-        scopes: Set<String>,
+        scopes: Set<ChatContext.Scope>,
         content: String,
         configuration: ChatGPTConfiguration
     ) -> ChatContext {
         guard let content = getEditorInformation() else { return .empty }
         let relativePath = content.relativePath
         let selectionRange = content.editorContent?.selections.first ?? .outOfScope
         let editorContent = {
-            if scopes.contains("file") || scopes.contains("f") {
+            if scopes.contains(.file) {
                 return """
                 File Content:```\(content.language.rawValue)
                 \(content.editorContent?.content ?? "")
@@ -49,7 +49,7 @@ public struct LegacyActiveDocumentChatContextCollector: ChatContextCollector {
                 }
             }
 
-            if UserDefaults.shared.value(for: \.useCodeScopeByDefaultInChatContext) {
+            if UserDefaults.shared.value(for: \.enableCodeScopeByDefaultInChatContext) {
                 return """
                 Selected Code \
                 (start from line \(selectionRange.start.line)):```\(content.language.rawValue)
@@ -58,7 +58,7 @@ public struct LegacyActiveDocumentChatContextCollector: ChatContextCollector {
                 """
             }
 
-            if scopes.contains("selection") || scopes.contains("s") {
+            if scopes.contains(.code) {
                 return """
                 Selected Code \
                 (start from line \(selectionRange.start.line)):```\(content.language.rawValue)