Merge pull request #2469 from vinu-vanjari/TriviaPiece.isComment

Added TriviaPiece.isComment

Author: ahoppen

CodeGeneration/Sources/generate-swift-syntax/templates/swiftsyntax/TriviaPiecesFile.swift

@@ -310,5 +310,19 @@ fileprivate func generateIsHelpers(for pieceName: TokenSyntax) throws -> Extensi
       }
       """
     )
+
+    DeclSyntax(
+      """
+      /// Returns `true` if this piece is a comment.
+      public var isComment: Bool {
+        switch self {
+        case .lineComment, .blockComment, .docLineComment, .docBlockComment:
+          return true
+        default:
+          return false
+        }
+      }
+      """
+    )
   }
 }

Release Notes/511.md

@@ -45,6 +45,10 @@
   - Description: Produce the lexical context for a given syntax node (if it has one), or the entire stack of lexical contexts enclosing a syntax node, for use in macro expansion.
   - Pull request: https://github.com/apple/swift-syntax/pull/1554
 
+- `TriviaPiece.isComment`
+  - Description: `TriviaPiece` now has a computed property `isComment` that returns `true` if the trivia piece is a comment.
+  - Pull Request: https://github.com/apple/swift-syntax/pull/2469
+
 ## API Behavior Changes
 
 ## Deprecations

Sources/SwiftSyntax/generated/TriviaPieces.swift

@@ -475,6 +475,16 @@ extension TriviaPiece {
       return false
     }
   }
+  
+  /// Returns `true` if this piece is a comment.
+  public var isComment: Bool {
+    switch self {
+    case .lineComment, .blockComment, .docLineComment, .docBlockComment:
+      return true
+    default:
+      return false
+    }
+  }
 }
 
 extension RawTriviaPiece {
@@ -510,4 +520,14 @@ extension RawTriviaPiece {
       return false
     }
   }
+  
+  /// Returns `true` if this piece is a comment.
+  public var isComment: Bool {
+    switch self {
+    case .lineComment, .blockComment, .docLineComment, .docBlockComment:
+      return true
+    default:
+      return false
+    }
+  }
 }