Merge branch 'release/0.7.0'

intitni · intitni · commit 04147834409c · 2025-04-05T16:08:19.000+08:00
diff --git a/Core/Sources/CodeCompletionService/API/OpenAIService.swift b/Core/Sources/CodeCompletionService/API/OpenAIService.swift
@@ -267,6 +267,10 @@ extension OpenAIService {
             contextWindow - maxToken - 20
         ))
         let prompts = strategy.createTruncatedPrompt(promptStrategy: request)
+        // if request.systemPrompt empty not append
+        if  request.systemPrompt.isEmpty {
+            return prompts.map(\.content).joined(separator: "\n\n")
+        }
         return ([request.systemPrompt] + prompts.map(\.content)).joined(separator: "\n\n")
     }
 
diff --git a/Core/Sources/Storage/Preferences.swift b/Core/Sources/Storage/Preferences.swift
@@ -129,6 +129,13 @@ public extension UserDefaultPreferenceKeys {
         )
     }
     
+    var fimAttachFileInfo: PreferenceKey<Bool> {
+        .init(
+            defaultValue: true,
+            key: "CustomSuggestionService-fimAttachFileInfo"
+        )
+    }
+    
     var maxGenerationToken: PreferenceKey<Int> {
         .init(
             defaultValue: 200,
diff --git a/Core/Sources/SuggestionService/RequestStrategies/FillInTheMiddleRequestStrategy.swift b/Core/Sources/SuggestionService/RequestStrategies/FillInTheMiddleRequestStrategy.swift
@@ -40,9 +40,13 @@ struct FillInTheMiddleRequestStrategy: RequestStrategy {
         var suffix: [String]
         var filePath: String { sourceRequest.relativePath ?? sourceRequest.fileURL.path }
         var relevantCodeSnippets: [RelevantCodeSnippet] { sourceRequest.relevantCodeSnippets }
-        var stopWords: [String] { ["\n\n", Tag.stop].filter { !$0.isEmpty } }
+        // Stop words should support multiple comma-separated
+        var stopWords: [String] {
+            return ["\n\n"] + Tag.stop.split(separator: ",").map { String($0) }.filter { !$0.isEmpty }
+        }
         var language: CodeLanguage? { sourceRequest.language }
         var promptIsRaw: Bool { UserDefaults.shared.value(for: \.fimPromptIsRaw) }
+        var attachFileInfo: Bool { UserDefaults.shared.value(for: \.fimAttachFileInfo) }
 
         var suggestionPrefix: SuggestionPrefix {
             guard let prefix = prefix.last else { return .empty }
@@ -57,15 +61,17 @@ struct FillInTheMiddleRequestStrategy: RequestStrategy {
             let suffix = truncatedSuffix.joined()
             var template = UserDefaults.shared.value(for: \.fimTemplate)
             if template.isEmpty { template = UserDefaults.shared.defaultValue(for: \.fimTemplate) }
-            
+            // Determine whether to append file information according to attachFileInfo
+            let fileInfo = attachFileInfo ? """
+                // File Path: \(filePath)
+                // Indentation: \
+                \(sourceRequest.indentSize) \
+                \(sourceRequest.usesTabsForIndentation ? "tab" : "space")
+                """ : ""
             let prefixContent = """
-            // File Path: \(filePath)
-            // Indentation: \
-            \(sourceRequest.indentSize) \
-            \(sourceRequest.usesTabsForIndentation ? "tab" : "space")
-            \(includedSnippets.map(\.content).joined(separator: "\n\n"))
-            \(truncatedPrefix.joined())
-            """
+                \(fileInfo)\(fileInfo.isEmpty ? "" : "\n")\(includedSnippets.map(\.content).joined(separator: "\n\n"))
+                \(truncatedPrefix.joined())
+                """
             
             let suffixContent = suffix.isEmpty ? "\n// End of file" : suffix
             
diff --git a/CustomSuggestionService.xcodeproj/project.pbxproj b/CustomSuggestionService.xcodeproj/project.pbxproj
@@ -719,7 +719,7 @@
 			repositoryURL = "https://github.com/sparkle-project/Sparkle";
 			requirement = {
 				kind = upToNextMajorVersion;
-				minimumVersion = 2.5.2;
+				minimumVersion = 2.6.4;
 			};
 		};
 		C8D0116D2B5A5BFF00219412 /* XCRemoteSwiftPackageReference "CopilotForXcodeKit" */ = {
diff --git a/CustomSuggestionService.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved b/CustomSuggestionService.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
diff --git a/CustomSuggestionService/ContentView.swift b/CustomSuggestionService/ContentView.swift
@@ -183,6 +183,7 @@ struct RequestStrategyPicker: View {
         @AppStorage(\.fimTemplate) var fimTemplate
         @AppStorage(\.fimPromptIsRaw) var fimPromptIsRaw
         @AppStorage(\.fimStopToken) var fimStopToken
+        @AppStorage(\.fimAttachFileInfo) var fimAttachFileInfo
     }
 
     @StateObject var settings = Settings()
@@ -238,6 +239,7 @@ struct RequestStrategyPicker: View {
                 prompt: Text(UserDefaults.shared.defaultValue(for: \.fimTemplate))
             ) { Text("FIM Template") }
             Toggle(isOn: $settings.fimPromptIsRaw) { Text("Raw Prompt") }
+            Toggle(isOn: $settings.fimAttachFileInfo) { Text("Attach File Info") }
             TextField(text: $settings.fimStopToken) { Text("FIM Stop Token") }
         }
     }
diff --git a/README.md b/README.md
@@ -34,6 +34,8 @@ If you are new to running a model locally, you can try [Ollama](https://ollama.c
 
 - Use Tabby since they have extensive experience in code completion.
 - Use models with completions API with Fill-in-the-Middle support (for example, codellama:7b-code), and use the "Fill-in-the-Middle" strategy.
+
+    You can find some [examples here](#example-use-of-local-models).
 - Use models with FIM API.
 
 When using custom models to generate suggestions, it is recommended to setup a lower suggestion limit for faster generation.
@@ -61,6 +63,15 @@ The template format differs in different tools.
 - Naive: This strategy rearranges the code in a naive way to trick the model into believing it's appending code at the end of a file.
 - Continue: This strategy employs the "Please Continue" technique to persuade the model that it has started a suggestion and must continue to complete it. (Only effective with the chat completion API).
 
+## Example Use of Local Models
+
+### Qwen Type in the Middle
+
+1. Load `qwen2.5-coder:32b` with Ollama.
+2. Setup the model with the completions API.
+3. Set the request strategy to "Fill-in-the-Middle".
+4. Set prompt format to `<|fim_prefix|>{prefix}<|fim_suffix|>{suffix}<|fim_middle|>` and turn on Raw Prompt.
+
 ## Contribution
 
 Prompt engineering is a challenging task, and your assistance is invaluable.
@@ -69,4 +80,4 @@ The most complex things are located within the `Core` package.
 
 - To add a new service, please refer to the `CodeCompletionService` folder.
 - To add new request strategies, check out the `SuggestionService` folder.
-
+- To add a new instructions of using a local model, update the `Example Use of Local Models` in the README.md.
diff --git a/Version.xcconfig b/Version.xcconfig
@@ -1,3 +1,3 @@
-APP_VERSION = 0.6.0
-APP_BUILD = 60
+APP_VERSION = 0.7.0
+APP_BUILD = 74
  
diff --git a/appcast.xml b/appcast.xml
@@ -2,6 +2,15 @@
 <rss xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle" version="2.0">
     <channel>
         <title>Custom Suggestion Service</title>
+        <item>
+            <title>0.7.0</title>
+            <pubDate>Sat, 05 Apr 2025 16:06:39 +0800</pubDate>
+            <sparkle:version>74</sparkle:version>
+            <sparkle:shortVersionString>0.7.0</sparkle:shortVersionString>
+            <sparkle:minimumSystemVersion>13.0</sparkle:minimumSystemVersion>
+            <sparkle:releaseNotesLink>https://github.com/intitni/CustomSuggestionServiceForCopilotForXcode/releases/tag/0.7.0</sparkle:releaseNotesLink>
+            <enclosure url="https://github.com/intitni/CustomSuggestionServiceForCopilotForXcode/releases/download/0.7.0/Custom.Suggestion.Service.app.zip" length="6790057" type="application/octet-stream" sparkle:edSignature="pMMViYEVPErbAbHixghC2lG6Q6XbuWkDccFOOpF9XOyd8vnj7zwXLc34Su6Pq55UtC1Y4Ryc8KcKy7QDfsqRDg=="/>
+        </item>
         <item>
             <title>0.6.0</title>
             <pubDate>Sun, 29 Dec 2024 23:59:31 +0800</pubDate>
@@ -20,14 +29,5 @@
             <sparkle:releaseNotesLink>https://github.com/intitni/CustomSuggestionServiceForCopilotForXcode/releases/tag/0.5.0</sparkle:releaseNotesLink>
             <enclosure url="https://github.com/intitni/CustomSuggestionServiceForCopilotForXcode/releases/download/0.5.0/Custom.Suggestion.Service.app.zip" length="6780334" type="application/octet-stream" sparkle:edSignature="xPs4zYq3gVWjR/VAGhT0RyAZsvmq605Cg+JpRM9CF8ap8ETqhJvj7q1VOcc8UdtllRX94+po9AF/92KoSMZ7Dw=="/>
         </item>
-        <item>
-            <title>0.4.0</title>
-            <pubDate>Mon, 24 Jun 2024 00:33:39 +0800</pubDate>
-            <sparkle:version>40</sparkle:version>
-            <sparkle:shortVersionString>0.4.0</sparkle:shortVersionString>
-            <sparkle:minimumSystemVersion>13.0</sparkle:minimumSystemVersion>
-            <sparkle:releaseNotesLink>https://github.com/intitni/CustomSuggestionServiceForCopilotForXcode/releases/tag/0.4.0</sparkle:releaseNotesLink>
-            <enclosure url="https://github.com/intitni/CustomSuggestionServiceForCopilotForXcode/releases/download/0.4.0/Custom.Suggestion.Service.app.zip" length="6989834" type="application/octet-stream" sparkle:edSignature="XHzYNwl8xKgmSYNh3hd2Z1BymuCvFWxSAAYBqclsuChH3iPJswPa8hbYzj07sqaaNc0LTODtv6cifZCOVMgPAg=="/>
-        </item>
     </channel>
 </rss>

Original file line number	Diff line number	Diff line change
`@@ -129,6 +129,13 @@ public extension UserDefaultPreferenceKeys {`
`129`	`129`	`)`
`130`	`130`	`}`
`131`	`131`
	`132`	`+ var fimAttachFileInfo: PreferenceKey<Bool> {`
	`133`	`+ .init(`
	`134`	`+ defaultValue: true,`
	`135`	`+ key: "CustomSuggestionService-fimAttachFileInfo"`
	`136`	`+ )`
	`137`	`+ }`
	`138`	`+`
`132`	`139`	`var maxGenerationToken: PreferenceKey<Int> {`
`133`	`140`	`.init(`
`134`	`141`	`defaultValue: 200,`
Original file line number	Diff line number	Diff line change
`@@ -183,6 +183,7 @@ struct RequestStrategyPicker: View {`
`183`	`183`	`@AppStorage(\.fimTemplate) var fimTemplate`
`184`	`184`	`@AppStorage(\.fimPromptIsRaw) var fimPromptIsRaw`
`185`	`185`	`@AppStorage(\.fimStopToken) var fimStopToken`
	`186`	`+ @AppStorage(\.fimAttachFileInfo) var fimAttachFileInfo`
`186`	`187`	`}`
`187`	`188`
`188`	`189`	`@StateObject var settings = Settings()`
`@@ -238,6 +239,7 @@ struct RequestStrategyPicker: View {`
`238`	`239`	`prompt: Text(UserDefaults.shared.defaultValue(for: \.fimTemplate))`
`239`	`240`	`) { Text("FIM Template") }`
`240`	`241`	`Toggle(isOn: $settings.fimPromptIsRaw) { Text("Raw Prompt") }`
	`242`	`+ Toggle(isOn: $settings.fimAttachFileInfo) { Text("Attach File Info") }`
`241`	`243`	`TextField(text: $settings.fimStopToken) { Text("FIM Stop Token") }`
`242`	`244`	`}`
`243`	`245`	`}`