Add settings for scopes

Core/Sources/HostApp/FeatureSettings/ChatSettingsView.swift

@@ -1,6 +1,11 @@
 import Preferences
+import SharedUIComponents
 import SwiftUI
 
+#if canImport(ProHostApp)
+import ProHostApp
+#endif
+
 struct ChatSettingsView: View {
     class Settings: ObservableObject {
         static let availableLocalizedLocales = Locale.availableLocalizedLocales
@@ -11,8 +16,6 @@ struct ChatSettingsView: View {
         @AppStorage(\.chatCodeFontSize) var chatCodeFontSize
         @AppStorage(\.maxFocusedCodeLineCount)
         var maxFocusedCodeLineCount
-        @AppStorage(\.useCodeScopeByDefaultInChatContext)
-        var useCodeScopeByDefaultInChatContext
         @AppStorage(\.defaultChatFeatureChatModelId) var defaultChatFeatureChatModelId
         @AppStorage(\.defaultChatSystemPrompt) var defaultChatSystemPrompt
         @AppStorage(\.chatSearchPluginMaxIterations) var chatSearchPluginMaxIterations
@@ -32,12 +35,13 @@ struct ChatSettingsView: View {
     var body: some View {
         VStack {
             chatSettingsForm
-            Divider()
+            SettingsDivider("UI")
             uiForm
-            Divider()
+            SettingsDivider("Context")
             contextForm
-            Divider()
+            SettingsDivider("Plugin")
             pluginForm
+            ScopeForm()
         }
     }
 
@@ -160,7 +164,7 @@ struct ChatSettingsView: View {
 
                 Text("pt")
             }
-            
+
             Toggle(isOn: $settings.wrapCodeInCodeBlock) {
                 Text("Wrap code in code block")
             }
@@ -170,10 +174,6 @@ struct ChatSettingsView: View {
     @ViewBuilder
     var contextForm: some View {
         Form {
-            Toggle(isOn: $settings.useCodeScopeByDefaultInChatContext) {
-                Text("Use @code scope by default in chat context.")
-            }
-
             HStack {
                 TextField(text: .init(get: {
                     "\(Int(settings.maxFocusedCodeLineCount))"
@@ -235,13 +235,206 @@ struct ChatSettingsView: View {
             )
         }
     }
+
+    struct ScopeForm: View {
+        class Settings: ObservableObject {
+            @AppStorage(\.enableFileScopeByDefaultInChatContext)
+            var enableFileScopeByDefaultInChatContext: Bool
+            @AppStorage(\.enableCodeScopeByDefaultInChatContext)
+            var enableCodeScopeByDefaultInChatContext: Bool
+            @AppStorage(\.enableSenseScopeByDefaultInChatContext)
+            var enableSenseScopeByDefaultInChatContext: Bool
+            @AppStorage(\.enableProjectScopeByDefaultInChatContext)
+            var enableProjectScopeByDefaultInChatContext: Bool
+            @AppStorage(\.enableWebScopeByDefaultInChatContext)
+            var enableWebScopeByDefaultInChatContext: Bool
+            @AppStorage(\.preferredChatModelIdForSenseScope)
+            var preferredChatModelIdForSenseScope: String
+            @AppStorage(\.preferredChatModelIdForProjectScope)
+            var preferredChatModelIdForProjectScope: String
+            @AppStorage(\.preferredChatModelIdForWebScope)
+            var preferredChatModelIdForWebScope: String
+            @AppStorage(\.chatModels) var chatModels
+
+            init() {}
+        }
+
+        @StateObject var settings = Settings()
+
+        var body: some View {
+            VStack {
+                Scope(
+                    title: Text("File Scope"),
+                    description: "Enable the bot to read the metadata of the editing file."
+                ) {
+                    Form {
+                        Toggle(isOn: $settings.enableFileScopeByDefaultInChatContext) {
+                            Text("Enable @file scope by default in chat context.")
+                        }
+                    }
+                }
+
+                Scope(
+                    title: Text("Code Scope"),
+                    description: "Enable the bot to read the code and metadata in the editing file."
+                ) {
+                    Form {
+                        Toggle(isOn: $settings.enableCodeScopeByDefaultInChatContext) {
+                            Text("Enable @code scope by default in chat context.")
+                        }
+                    }
+                }
+
+                #if canImport(ProHostApp)
+
+                Scope(
+                    title: WithFeatureEnabled(\.projectScopeInChat) { Text("Sense Scope") },
+                    description: "Experimental. Enable the bot to read the relevant code of the editing file in the project, third party packages and the SDK."
+                ) {
+                    WithFeatureEnabled(\.projectScopeInChat, alignment: .hidden) {
+                        Form {
+                            Toggle(isOn: $settings.enableSenseScopeByDefaultInChatContext) {
+                                Text("Enable @sense scope by default in chat context.")
+                            }
+
+                            Picker(
+                                "Preferred Chat Model",
+                                selection: $settings.preferredChatModelIdForSenseScope
+                            ) {
+                                Text("None").tag("")
+
+                                if !settings.chatModels
+                                    .contains(where: {
+                                        $0.id == settings.preferredChatModelIdForSenseScope
+                                    }),
+                                    !settings.preferredChatModelIdForSenseScope.isEmpty
+                                {
+                                    Text(
+                                        (settings.chatModels.first?.name).map { "\($0) (Default)" }
+                                            ?? "No Model Found"
+                                    )
+                                    .tag(settings.preferredChatModelIdForSenseScope)
+                                }
+
+                                ForEach(settings.chatModels, id: \.id) { chatModel in
+                                    Text(chatModel.name).tag(chatModel.id)
+                                }
+                            }
+                        }
+                    }
+                    .padding(.top, 20)
+                }
+
+                Scope(
+                    title: WithFeatureEnabled(\.projectScopeInChat) { Text("Project Scope") },
+                    description: "Experimental. Enable the bot to search  code symbols in the project, third party packages and the SDK."
+                ) {
+                    WithFeatureEnabled(\.projectScopeInChat, alignment: .hidden) {
+                        Form {
+                            Toggle(isOn: $settings.enableProjectScopeByDefaultInChatContext) {
+                                Text("Enable @project scope by default in chat context.")
+                            }
+
+                            Picker(
+                                "Preferred Chat Model",
+                                selection: $settings.preferredChatModelIdForProjectScope
+                            ) {
+                                Text("None").tag("")
+
+                                if !settings.chatModels
+                                    .contains(where: {
+                                        $0.id == settings.preferredChatModelIdForProjectScope
+                                    }),
+                                    !settings.preferredChatModelIdForProjectScope.isEmpty
+                                {
+                                    Text(
+                                        (settings.chatModels.first?.name).map { "\($0) (Default)" }
+                                            ?? "No Model Found"
+                                    )
+                                    .tag(settings.preferredChatModelIdForProjectScope)
+                                }
+
+                                ForEach(settings.chatModels, id: \.id) { chatModel in
+                                    Text(chatModel.name).tag(chatModel.id)
+                                }
+                            }
+                        }
+                    }
+                }
+
+                #endif
+
+                Scope(
+                    title: Text("Web Scope"),
+                    description: "Allow the bot to search on Bing or read a web page."
+                ) {
+                    Form {
+                        Toggle(isOn: $settings.enableWebScopeByDefaultInChatContext) {
+                            Text("Enable @web scope by default in chat context.")
+                        }
+
+                        Picker(
+                            "Preferred Chat Model",
+                            selection: $settings.preferredChatModelIdForWebScope
+                        ) {
+                            Text("None").tag("")
+
+                            if !settings.chatModels
+                                .contains(where: {
+                                    $0.id == settings.preferredChatModelIdForWebScope
+                                }),
+                                !settings.preferredChatModelIdForWebScope.isEmpty
+                            {
+                                Text(
+                                    (settings.chatModels.first?.name).map { "\($0) (Default)" }
+                                        ?? "No Model Found"
+                                )
+                                .tag(settings.preferredChatModelIdForWebScope)
+                            }
+
+                            ForEach(settings.chatModels, id: \.id) { chatModel in
+                                Text(chatModel.name).tag(chatModel.id)
+                            }
+                        }
+                    }
+                }
+            }
+        }
+
+        struct Scope<Title: View, Content: View>: View {
+            let title: Title
+            let description: String
+            let content: () -> Content
+
+            var body: some View {
+                SettingsDivider(title)
+                VStack {
+                    Text(description)
+                        .multilineTextAlignment(.center)
+                        .foregroundStyle(.secondary)
+                        .padding(8)
+                        .background {
+                            RoundedRectangle(cornerRadius: 8)
+                                .fill(Color.secondary.opacity(0.1))
+                        }
+                        .frame(maxWidth: 500)
+                    Form {
+                        content()
+                    }
+                }
+            }
+        }
+    }
 }
 
 // MARK: - Preview
 
-struct ChatSettingsView_Previews: PreviewProvider {
-    static var previews: some View {
+#Preview {
+    ScrollView {
         ChatSettingsView()
+            .padding()
     }
+    .frame(height: 800)
+    .environment(\.overrideFeatureFlag, \.never)
 }
 

Tool/Sources/Preferences/Keys.swift

@@ -88,7 +88,7 @@ public struct UserDefaultPreferenceKeys {
         defaultValue: false,
         key: "HideCircularWidget"
     )
-    
+
     public let showHideWidgetShortcutGlobally = PreferenceKey(
         defaultValue: false,
         key: "ShowHideWidgetShortcutGlobally"
@@ -269,11 +269,11 @@ public extension UserDefaultPreferenceKeys {
     var promptToCodeGenerateDescriptionInUserPreferredLanguage: PreferenceKey<Bool> {
         .init(defaultValue: true, key: "PromptToCodeGenerateDescriptionInUserPreferredLanguage")
     }
-    
+
     var promptToCodeChatModelId: PreferenceKey<String> {
         .init(defaultValue: "", key: "PromptToCodeChatModelId")
     }
-    
+
     var promptToCodeEmbeddingModelId: PreferenceKey<String> {
         .init(defaultValue: "", key: "PromptToCodeEmbeddingModelId")
     }
@@ -366,7 +366,7 @@ public extension UserDefaultPreferenceKeys {
         .init(defaultValue: 100, key: "MaxEmbeddableFileInChatContextLineCount")
     }
 
-    var useCodeScopeByDefaultInChatContext: PreferenceKey<Bool> {
+    var useCodeScopeByDefaultInChatContext: DeprecatedPreferenceKey<Bool> {
         .init(defaultValue: true, key: "UseSelectionScopeByDefaultInChatContext")
     }
 
@@ -389,10 +389,42 @@ public extension UserDefaultPreferenceKeys {
     var chatSearchPluginMaxIterations: PreferenceKey<Int> {
         .init(defaultValue: 3, key: "ChatSearchPluginMaxIterations")
     }
-    
+
     var wrapCodeInChatCodeBlock: PreferenceKey<Bool> {
         .init(defaultValue: true, key: "WrapCodeInChatCodeBlock")
     }
+
+    var enableFileScopeByDefaultInChatContext: PreferenceKey<Bool> {
+        .init(defaultValue: true, key: "EnableFileScopeByDefaultInChatContext")
+    }
+
+    var enableCodeScopeByDefaultInChatContext: PreferenceKey<Bool> {
+        .init(defaultValue: true, key: "UseSelectionScopeByDefaultInChatContext")
+    }
+
+    var enableSenseScopeByDefaultInChatContext: PreferenceKey<Bool> {
+        .init(defaultValue: false, key: "EnableSenseScopeByDefaultInChatContext")
+    }
+
+    var enableProjectScopeByDefaultInChatContext: PreferenceKey<Bool> {
+        .init(defaultValue: false, key: "EnableProjectScopeByDefaultInChatContext")
+    }
+
+    var enableWebScopeByDefaultInChatContext: PreferenceKey<Bool> {
+        .init(defaultValue: false, key: "EnableWebScopeByDefaultInChatContext")
+    }
+
+    var preferredChatModelIdForSenseScope: PreferenceKey<String> {
+        .init(defaultValue: "", key: "PreferredChatModelIdForSenseScope")
+    }
+
+    var preferredChatModelIdForProjectScope: PreferenceKey<String> {
+        .init(defaultValue: "", key: "PreferredChatModelIdForProjectScope")
+    }
+
+    var preferredChatModelIdForWebScope: PreferenceKey<String> {
+        .init(defaultValue: "", key: "PreferredChatModelIdForWebScope")
+    }
 }
 
 // MARK: - Bing Search
@@ -508,7 +540,7 @@ public extension UserDefaultPreferenceKeys {
             key: "FeatureFlag-DisableGitHubCopilotSettingsAutoRefreshOnAppear"
         )
     }
-    
+
     var disableEnhancedWorkspace: FeatureFlag {
         .init(
             defaultValue: false,

Tool/Sources/SharedUIComponents/SettingsDivider.swift

@@ -0,0 +1,42 @@
+import SwiftUI
+
+public struct SettingsDivider<Title: View>: View {
+    let title: Title?
+
+    public init(_ title: Title) {
+        self.title = title
+    }
+
+    public var body: some View {
+        if let title {
+            HStack {
+                VStack {
+                    Divider()
+                }
+                title
+                    .foregroundStyle(.secondary)
+                    .font(.subheadline)
+                    .zIndex(2)
+                VStack {
+                    Divider()
+                }
+            }
+            .padding(.vertical, 8)
+        } else {
+            Divider()
+                .padding(.vertical, 8)
+        }
+    }
+}
+
+extension SettingsDivider where Title == Text {
+    public init(_ title: String) {
+        self.title = Text(title)
+    }
+}
+
+extension SettingsDivider where Title == EmptyView {
+    public init() {
+        self.title = nil
+    }
+}