Add comments to cases

Author: kimdv

CodeGeneration/Sources/generate-swiftsyntax/templates/basicformat/BasicFormatFile.swift

@@ -124,7 +124,7 @@ let basicFormatFile = SourceFile {
     FunctionDecl("open func requiresLeadingSpace(_ token: TokenSyntax) -> Bool") {
       SwitchStmt("""
         switch (token.previousToken(viewMode: .sourceAccurate)?.tokenKind, token.tokenKind) {
-        case (.postfixQuestionMark, .rightAngle):
+        case (.postfixQuestionMark, .rightAngle): // Ensures there is not space in `?>`
           return false
         case (.leftParen, .spacedBinaryOperator("*")):
           return false
@@ -150,17 +150,17 @@ let basicFormatFile = SourceFile {
     FunctionDecl("open func requiresTrailingSpace(_ token: TokenSyntax) -> Bool") {
       SwitchStmt("""
         switch (token.tokenKind, token.nextToken(viewMode: .sourceAccurate)?.tokenKind) {
-        case (.asKeyword, .exclamationMark),
-             (.asKeyword, .postfixQuestionMark),
-             (.exclamationMark, .leftParen),
-             (.exclamationMark, .period),
-             (.initKeyword, .leftParen),
-             (.initKeyword, .postfixQuestionMark),
-             (.postfixQuestionMark, .leftParen),
-             (.postfixQuestionMark, .rightAngle),
-             (.postfixQuestionMark, .rightParen),
-             (.tryKeyword, .exclamationMark),
-             (.tryKeyword, .postfixQuestionMark):
+        case (.asKeyword, .exclamationMark), // Ensures there is not space in `as!`
+             (.asKeyword, .postfixQuestionMark), // Ensures there is not space in `as?`
+             (.exclamationMark, .leftParen), // Ensures there is not space in `!(`
+             (.exclamationMark, .period), // Ensures there is not space in `!.`
+             (.initKeyword, .leftParen), // Ensures there is not space in `init(`
+             (.initKeyword, .postfixQuestionMark), // Ensures there is not space in `init?`
+             (.postfixQuestionMark, .leftParen), // Ensures there is not space in `?(`
+             (.postfixQuestionMark, .rightAngle), // Ensures there is not space in `?<`
+             (.postfixQuestionMark, .rightParen), // Ensures there is not space in `?(`
+             (.tryKeyword, .exclamationMark), // Ensures there is not space in `try!`
+             (.tryKeyword, .postfixQuestionMark): // Ensures there is not space in `try?`
           return false
         case (.spacedBinaryOperator("*"), .comma):
           return false

Sources/SwiftBasicFormat/generated/BasicFormat.swift

@@ -125,7 +125,7 @@ open class BasicFormat: SyntaxRewriter {
 
   open func requiresLeadingSpace(_ token: TokenSyntax) -> Bool {
     switch (token.previousToken(viewMode: .sourceAccurate)?.tokenKind, token.tokenKind) {
-    case (.postfixQuestionMark, .rightAngle): 
+    case (.postfixQuestionMark, .rightAngle): // Ensures there is not space in `?>`
       return false
     case (.leftParen, .spacedBinaryOperator("*")): 
       return false
@@ -154,17 +154,17 @@ open class BasicFormat: SyntaxRewriter {
 
   open func requiresTrailingSpace(_ token: TokenSyntax) -> Bool {
     switch (token.tokenKind, token.nextToken(viewMode: .sourceAccurate)?.tokenKind) {
-    case (.asKeyword, .exclamationMark), 
-     (.asKeyword, .postfixQuestionMark), 
-     (.exclamationMark, .leftParen), 
-     (.exclamationMark, .period), 
-     (.initKeyword, .leftParen), 
-     (.initKeyword, .postfixQuestionMark), 
-     (.postfixQuestionMark, .leftParen), 
-     (.postfixQuestionMark, .rightAngle), 
-     (.postfixQuestionMark, .rightParen), 
-     (.tryKeyword, .exclamationMark), 
-     (.tryKeyword, .postfixQuestionMark): 
+    case (.asKeyword, .exclamationMark), // Ensures there is not space in `as!`
+     (.asKeyword, .postfixQuestionMark), // Ensures there is not space in `as?`
+     (.exclamationMark, .leftParen), // Ensures there is not space in `!(`
+     (.exclamationMark, .period), // Ensures there is not space in `!.`
+     (.initKeyword, .leftParen), // Ensures there is not space in `init(`
+     (.initKeyword, .postfixQuestionMark), // Ensures there is not space in `init?`
+     (.postfixQuestionMark, .leftParen), // Ensures there is not space in `?(`
+     (.postfixQuestionMark, .rightAngle), // Ensures there is not space in `?<`
+     (.postfixQuestionMark, .rightParen), // Ensures there is not space in `?(`
+     (.tryKeyword, .exclamationMark), // Ensures there is not space in `try!`
+     (.tryKeyword, .postfixQuestionMark): // Ensures there is not space in `try?`
       return false
     case (.spacedBinaryOperator("*"), .comma): 
       return false