Move the Diagnostic-related types back to the SwiftSyntax module

ahoppen · ahoppen · commit 08fa08e375b4 · 2021-10-06T11:02:04.000+02:00
Moving `Diagnostic` etc. to the `SwiftSyntaxParser` module required `swift-format` to import `SwiftSyntaxParser` in a bunch of places where it shouldn’t be needed. Move the types back to the `SwiftSyntax` module for now until we completely refactor the parser to just return `Diagnostics` and not require a `DiagnsoticEngine` (tracked by SR-15280).
diff --git a/Sources/SwiftSyntax/Diagnostic.swift b/Sources/SwiftSyntax/Diagnostic.swift
@@ -12,8 +12,6 @@
 // This file provides the Diagnostic, Note, and FixIt types.
 //===----------------------------------------------------------------------===//
 
-import SwiftSyntax
-
 /// A FixIt represents a change to source code in order to "correct" a
 /// diagnostic.
 public enum FixIt: Codable, CustomDebugStringConvertible {
@@ -108,7 +106,7 @@ public struct Note: Codable {
   public let fixIts: [FixIt]
 
   /// Constructs a new Note from the constituent parts.
-  internal init(message: Diagnostic.Message, location: SourceLocation?,
+  public init(message: Diagnostic.Message, location: SourceLocation?,
                 highlights: [SourceRange], fixIts: [FixIt]) {
     precondition(message.severity == .note,
                  "notes can only have the `note` severity")
diff --git a/Sources/SwiftSyntax/DiagnosticConsumer.swift b/Sources/SwiftSyntax/DiagnosticConsumer.swift
diff --git a/Sources/SwiftSyntax/DiagnosticEngine.swift b/Sources/SwiftSyntax/DiagnosticEngine.swift
@@ -14,7 +14,6 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
-import SwiftSyntax
 
 /// The DiagnosticEngine allows Swift tools to emit diagnostics.
 public class DiagnosticEngine {
@@ -56,7 +55,7 @@ public class DiagnosticEngine {
       }
   }
 
-  internal var needsLineColumn: Bool {
+  public var needsLineColumn: Bool {
     // Check if any consumer is interested in line and column.
     return consumers.first { $0.needsLineColumn } != nil
   }
@@ -71,7 +70,7 @@ public class DiagnosticEngine {
     }
   }
 
-  internal func diagnose(_ diagnostic: Diagnostic) {
+  public func diagnose(_ diagnostic: Diagnostic) {
     diagnostics.append(diagnostic)
     for consumer in consumers {
       consumer.handle(diagnostic)
diff --git a/Sources/SwiftSyntax/JSONDiagnosticConsumer.swift b/Sources/SwiftSyntax/JSONDiagnosticConsumer.swift
@@ -14,7 +14,6 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
-import SwiftSyntax
 
 public final class JSONDiagnosticConsumer: DiagnosticConsumer {
   /// Enumerates the possible places this consumer might output diagnostics.
diff --git a/Sources/SwiftSyntax/PrintingDiagnosticConsumer.swift b/Sources/SwiftSyntax/PrintingDiagnosticConsumer.swift
diff --git a/utils/group.json b/utils/group.json
@@ -40,6 +40,11 @@
   ],
   "Parse": [
     "IncrementalParseTransition.swift",
+    "Diagnostic.swift",
+    "DiagnosticEngine.swift",
+    "DiagnosticConsumer.swift",
+    "JSONDiagnosticConsumer.swift",
+    "PrintingDiagnosticConsumer.swift"
   ],
   "Internal": [
     "_SyntaxParserInterop.swift",

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,6 @@`
`14`	`14`	`//===----------------------------------------------------------------------===//`
`15`	`15`
`16`	`16`	`import Foundation`
`17`		`-import SwiftSyntax`
`18`	`17`
`19`	`18`	`/// The DiagnosticEngine allows Swift tools to emit diagnostics.`
`20`	`19`	`public class DiagnosticEngine {`
`@@ -56,7 +55,7 @@ public class DiagnosticEngine {`
`56`	`55`	`}`
`57`	`56`	`}`
`58`	`57`
`59`		`- internal var needsLineColumn: Bool {`
	`58`	`+ public var needsLineColumn: Bool {`
`60`	`59`	`// Check if any consumer is interested in line and column.`
`61`	`60`	`return consumers.first { $0.needsLineColumn } != nil`
`62`	`61`	`}`
`@@ -71,7 +70,7 @@ public class DiagnosticEngine {`
`71`	`70`	`}`
`72`	`71`	`}`
`73`	`72`
`74`		`- internal func diagnose(_ diagnostic: Diagnostic) {`
	`73`	`+ public func diagnose(_ diagnostic: Diagnostic) {`
`75`	`74`	`diagnostics.append(diagnostic)`
`76`	`75`	`for consumer in consumers {`
`77`	`76`	`consumer.handle(diagnostic)`