Change FIXME and TODO comments to always have an associated issue

Do one of the following for every `FIXME` or `TODO` comment
- Add an issue that tracks the task
- Remove the comment if we are not planning to address it

Author: ahoppen

Sources/BuildSystemIntegration/BuildServerBuildSystem.swift

@@ -334,8 +334,9 @@ extension BuildServerBuildSystem: BuildSystem {
       return .unhandled
     }
 
-    // FIXME: We should not make any assumptions about which files the build server can handle.
-    // Instead we should query the build server which files it can handle (#492).
+    // TODO: We should not make any assumptions about which files the build server can handle.
+    // Instead we should query the build server which files it can handle
+    // (https://github.com/swiftlang/sourcekit-lsp/issues/492).
 
     if projectRoot.isAncestorOfOrEqual(to: path) {
       return .handled
@@ -399,8 +400,7 @@ private func makeJSONRPCBuildServer(
   )
 
   connection.start(receiveHandler: client) {
-    // FIXME: keep the pipes alive until we close the connection. This
-    // should be fixed systemically.
+    // Keep the pipes alive until we close the connection.
     withExtendedLifetime((clientToServer, serverToClient)) {}
   }
   let process = Foundation.Process()

Sources/BuildSystemIntegration/BuildSystemManager.swift

@@ -198,11 +198,11 @@ extension BuildSystemManager {
     guard let buildSystem, let target else {
       return nil
     }
-    // FIXME: (async) We should only wait `fallbackSettingsTimeout` for build
-    // settings and return fallback afterwards. I am not sure yet, how best to
-    // implement that with Swift concurrency.
+    // TODO: We should only wait `fallbackSettingsTimeout` for build settings
+    // and return fallback afterwards.
     // For now, this should be fine because all build systems return
     // very quickly from `settings(for:language:)`.
+    // https://github.com/apple/sourcekit-lsp/issues/1181
     return try await buildSystem.buildSettings(for: document, in: target, language: language)
   }
 
@@ -382,7 +382,6 @@ extension BuildSystemManager: BuildSystemDelegate {
 }
 
 extension BuildSystemManager {
-  // FIXME: Consider debouncing/limiting this, seems to trigger often during a build.
   /// Checks if there are any files in `mainFileAssociations` where the main file
   /// that we have stored has changed.
   ///

Sources/BuildSystemIntegration/SwiftPMBuildSystem.swift

@@ -530,8 +530,7 @@ extension SwiftPMBuildSystem: BuildSystemIntegration.BuildSystem {
   }
 
   package func defaultLanguage(for document: DocumentURI) -> Language? {
-    // TODO (indexing): Query The SwiftPM build system for the document's language.
-    // https://github.com/swiftlang/sourcekit-lsp/issues/1267
+    // TODO: Query The SwiftPM build system for the document's language. (https://github.com/swiftlang/sourcekit-lsp/issues/1267)
     return nil
   }
 
@@ -602,8 +601,7 @@ extension SwiftPMBuildSystem: BuildSystemIntegration.BuildSystem {
     targets: [ConfiguredTarget],
     logMessageToIndexLog: @escaping @Sendable (_ taskID: IndexTaskID, _ message: String) -> Void
   ) async throws {
-    // TODO (indexing): Support preparation of multiple targets at once.
-    // https://github.com/swiftlang/sourcekit-lsp/issues/1262
+    // TODO: Support preparation of multiple targets at once. (https://github.com/swiftlang/sourcekit-lsp/issues/1262)
     for target in targets {
       await orLog("Preparing") { try await prepare(singleTarget: target, logMessageToIndexLog: logMessageToIndexLog) }
     }
@@ -620,8 +618,7 @@ extension SwiftPMBuildSystem: BuildSystemIntegration.BuildSystem {
       return
     }
 
-    // TODO (indexing): Add a proper 'prepare' job in SwiftPM instead of building the target.
-    // https://github.com/swiftlang/sourcekit-lsp/issues/1254
+    // TODO: Add a proper 'prepare' job in SwiftPM instead of building the target. (https://github.com/swiftlang/sourcekit-lsp/issues/1254)
     guard let swift = toolchain.swift else {
       logger.error(
         "Not preparing because toolchain at \(self.toolchain.identifier) does not contain a Swift compiler"
@@ -757,7 +754,6 @@ extension SwiftPMBuildSystem: BuildSystemIntegration.BuildSystem {
     if events.contains(where: { self.fileEventShouldTriggerPackageReload(event: $0) }) {
       logger.log("Reloading package because of file change")
       await orLog("Reloading package") {
-        // TODO: It should not be necessary to reload the entire package just to get build settings for one file.
         try await self.reloadPackage(forceResolvedVersions: !isForIndexBuild)
       }
     }

Sources/CSKTestSupport/CSKTestSupport.c

@@ -12,7 +12,7 @@
 
 #ifdef __linux__
 // For testing, override __cxa_atexit to prevent registration of static
-// destructors due to SR-12668.
+// destructors due to https://github.com/swiftlang/swift/issues/55112.
 int __cxa_atexit(void (*f) (void *), void *arg, void *dso_handle) {
   return 0;
 }

Sources/Diagnose/StderrStreamConcurrencySafe.swift

@@ -16,7 +16,7 @@ import class TSCBasic.ThreadSafeOutputByteStream
 #if canImport(Darwin)
 import TSCLibc
 #else
-// FIXME: (async-workaround) @preconcurrency needed because stderr is not sendable on Linux rdar://125578486
+// TODO: @preconcurrency needed because stderr is not sendable on Linux https://github.com/swiftlang/swift/issues/75601
 @preconcurrency import TSCLibc
 #endif
 

Sources/LanguageServerProtocol/SupportTypes/ClientCapabilities.swift

@@ -70,7 +70,6 @@ public struct RefreshRegistrationCapability: Hashable, Codable, Sendable {
 }
 
 /// Capabilities of the client editor/IDE related to managing the workspace.
-// FIXME: Instead of making all of these optional, provide default values and make the deserialization handle missing values.
 public struct WorkspaceClientCapabilities: Hashable, Codable, Sendable {
 
   /// Capabilities specific to `WorkspaceEdit`.
@@ -223,7 +222,6 @@ public struct WorkspaceClientCapabilities: Hashable, Codable, Sendable {
 }
 
 /// Capabilities of the client editor/IDE related to the document.
-// FIXME: Instead of making all of these optional, provide default values and make the deserialization handle missing values.
 public struct TextDocumentClientCapabilities: Hashable, Codable, Sendable {
 
   /// Capabilities specific to the `textDocument/...` change notifications.

Sources/LanguageServerProtocol/SupportTypes/CodeActionKind.swift

@@ -37,11 +37,9 @@ public struct CodeActionKind: RawRepresentable, Codable, Hashable, Sendable {
   public static let refactorInline: CodeActionKind = CodeActionKind(rawValue: "refactor.inline")
 
   /// Refactoring rewrite action.
-  // FIXME: what is this?
   public static let refactorRewrite: CodeActionKind = CodeActionKind(rawValue: "refactor.rewrite")
 
   /// Source action that applies to the entire file.
-  // FIXME: what is this?
   public static let source: CodeActionKind = CodeActionKind(rawValue: "source")
 
   /// Organize imports action.

Sources/LanguageServerProtocolJSONRPC/MessageSplitting.swift

@@ -104,7 +104,6 @@ extension RandomAccessCollection where Element: Equatable {
       return nil
     }
 
-    // FIXME: use a better algorithm (e.g. Boyer-Moore-Horspool).
     var i = startIndex
     for _ in 0..<(count - pattern.count + 1) {
       if self[i...].starts(with: pattern) {

Sources/SKTestSupport/TestJSONRPCConnection.swift

@@ -59,13 +59,11 @@ package final class TestJSONRPCConnection: Sendable {
     server = TestServer(client: serverToClientConnection)
 
     clientToServerConnection.start(receiveHandler: client) {
-      // FIXME: keep the pipes alive until we close the connection. This
-      // should be fixed systemically.
+      // Keep the pipes alive until we close the connection.
       withExtendedLifetime(self) {}
     }
     serverToClientConnection.start(receiveHandler: server) {
-      // FIXME: keep the pipes alive until we close the connection. This
-      // should be fixed systemically.
+      // Keep the pipes alive until we close the connection.
       withExtendedLifetime(self) {}
     }
   }

Sources/SemanticIndex/SemanticIndexManager.swift

@@ -273,8 +273,8 @@ package final actor SemanticIndexManager {
         // potentially not knowing about unit files, which causes the corresponding source files to be re-indexed.
         index.pollForUnitChangesAndWait()
         await testHooks.buildGraphGenerationDidFinish?()
-        // FIXME: (async-workaround) Ideally this would be a type like any Collection<DocumentURI> & Sendable but that
-        // doesn't work due to rdar://132374933
+        // TODO: Ideally this would be a type like any Collection<DocumentURI> & Sendable but that doesn't work due to
+        // https://github.com/swiftlang/swift/issues/75602
         var filesToIndex: [DocumentURI] = await self.buildSystemManager.sourceFiles().lazy.map(\.uri)
         if !indexFilesWithUpToDateUnit {
           let index = index.checked(for: .modifiedFiles)
@@ -626,9 +626,9 @@ package final actor SemanticIndexManager {
 
     var indexTasks: [Task<Void, Never>] = []
 
-    // TODO (indexing): When we can index multiple targets concurrently in SwiftPM, increase the batch size to half the
+    // TODO: When we can index multiple targets concurrently in SwiftPM, increase the batch size to half the
     // processor count, so we can get parallelism during preparation.
-    // https://github.com/swiftlang/sourcekit-lsp/issues/1262
+    // (https://github.com/swiftlang/sourcekit-lsp/issues/1262)
     for targetsBatch in sortedTargets.partition(intoBatchesOfSize: 1) {
       let preparationTaskID = UUID()
       let indexTask = Task(priority: priority) {
@@ -638,9 +638,9 @@ package final actor SemanticIndexManager {
         // And after preparation is done, index the files in the targets.
         await withTaskGroup(of: Void.self) { taskGroup in
           for target in targetsBatch {
-            // TODO (indexing): Once swiftc supports indexing of multiple files in a single invocation, increase the
-            // batch size to allow it to share AST builds between multiple files within a target.
-            // https://github.com/swiftlang/sourcekit-lsp/issues/1268
+            // TODO: Once swiftc supports indexing of multiple files in a single invocation, increase the batch size to
+            // allow it to share AST builds between multiple files within a target.
+            // (https://github.com/swiftlang/sourcekit-lsp/issues/1268)
             for fileBatch in filesByTarget[target]!.partition(intoBatchesOfSize: 1) {
               taskGroup.addTask {
                 await self.updateIndexStore(