Validate that children don’t end with 'Expr', 'Expression', 'Type' etc

Author: ahoppen

CodeGeneration/Sources/SyntaxSupport/DeclNodes.swift

@@ -2047,7 +2047,8 @@ public let DECL_NODES: [Node] = [
         kind: .token(choices: [.token(tokenKind: "ArrowToken")])
       ),
       Child(
-        name: "ReturnType",
+        name: "Type",
+        deprecatedName: "ReturnType",
         kind: .node(kind: .type),
         nameForDiagnostics: "return type"
       ),

CodeGeneration/Sources/SyntaxSupport/ExprNodes.swift

@@ -635,7 +635,8 @@ public let EXPR_NODES: [Node] = [
     ],
     children: [
       Child(
-        name: "KeyExpression",
+        name: "Key",
+        deprecatedName: "KeyExpression",
         kind: .node(kind: .expr),
         nameForDiagnostics: "key"
       ),
@@ -644,7 +645,8 @@ public let EXPR_NODES: [Node] = [
         kind: .token(choices: [.token(tokenKind: "ColonToken")])
       ),
       Child(
-        name: "ValueExpression",
+        name: "Value",
+        deprecatedName: "ValueExpression",
         kind: .node(kind: .expr),
         nameForDiagnostics: "value"
       ),
@@ -1338,7 +1340,8 @@ public let EXPR_NODES: [Node] = [
         kind: .token(choices: [.keyword(text: "repeat")])
       ),
       Child(
-        name: "PatternExpr",
+        name: "Pack",
+        deprecatedName: "PatternExpr",
         kind: .node(kind: .expr)
       ),
     ]
@@ -1395,7 +1398,8 @@ public let EXPR_NODES: [Node] = [
         isOptional: true
       ),
       Child(
-        name: "PostfixExpression",
+        name: "BaseExpression",
+        deprecatedName: "PostfixExpression",
         kind: .node(kind: .expr)
       ),
     ]
@@ -1418,7 +1422,8 @@ public let EXPR_NODES: [Node] = [
         kind: .token(choices: [.token(tokenKind: "RegexSlashToken")])
       ),
       Child(
-        name: "RegexPattern",
+        name: "Regex",
+        deprecatedName: "RegexPattern",
         kind: .token(choices: [.token(tokenKind: "RegexLiteralPatternToken")])
       ),
       Child(
@@ -1696,7 +1701,8 @@ public let EXPR_NODES: [Node] = [
     nameForDiagnostics: "ternay expression",
     children: [
       Child(
-        name: "ConditionExpression",
+        name: "Condition",
+        deprecatedName: "ConditionExpression",
         kind: .node(kind: .expr),
         nameForDiagnostics: "condition"
       ),

CodeGeneration/Sources/SyntaxSupport/PatternNodes.swift

@@ -151,7 +151,8 @@ public let PATTERN_NODES: [Node] = [
         kind: .token(choices: [.keyword(text: "let"), .keyword(text: "var"), .keyword(text: "inout")])
       ),
       Child(
-        name: "ValuePattern",
+        name: "Pattern",
+        deprecatedName: "ValuePattern",
         kind: .node(kind: .pattern)
       ),
     ]

CodeGeneration/Sources/SyntaxSupport/StmtNodes.swift

@@ -316,7 +316,8 @@ public let STMT_NODES: [Node] = [
         kind: .token(choices: [.keyword(text: "in")])
       ),
       Child(
-        name: "SequenceExpr",
+        name: "Sequence",
+        deprecatedName: "SequenceExpr",
         kind: .node(kind: .expr)
       ),
       Child(

CodeGeneration/Sources/SyntaxSupport/TypeNodes.swift

@@ -23,7 +23,8 @@ public let TYPE_NODES: [Node] = [
         kind: .token(choices: [.token(tokenKind: "LeftSquareToken")])
       ),
       Child(
-        name: "ElementType",
+        name: "Element",
+        deprecatedName: "ElementType",
         kind: .node(kind: .type)
       ),
       Child(
@@ -150,7 +151,8 @@ public let TYPE_NODES: [Node] = [
         kind: .token(choices: [.token(tokenKind: "LeftSquareToken")])
       ),
       Child(
-        name: "KeyType",
+        name: "Key",
+        deprecatedName: "KeyType",
         kind: .node(kind: .type),
         nameForDiagnostics: "key type"
       ),
@@ -159,7 +161,8 @@ public let TYPE_NODES: [Node] = [
         kind: .token(choices: [.token(tokenKind: "ColonToken")])
       ),
       Child(
-        name: "ValueType",
+        name: "Value",
+        deprecatedName: "ValueType",
         kind: .node(kind: .type),
         nameForDiagnostics: "value type"
       ),
@@ -251,7 +254,8 @@ public let TYPE_NODES: [Node] = [
     ],
     children: [
       Child(
-        name: "ArgumentType",
+        name: "Argument",
+        deprecatedName: "ArgumentType",
         kind: .node(kind: .type)
       ),
       Child(
@@ -377,7 +381,8 @@ public let TYPE_NODES: [Node] = [
         kind: .token(choices: [.token(tokenKind: "PrefixOperatorToken")])
       ),
       Child(
-        name: "PatternType",
+        name: "Type",
+        deprecatedName: "PatternType",
         kind: .node(kind: .type)
       ),
     ]
@@ -394,7 +399,8 @@ public let TYPE_NODES: [Node] = [
         kind: .token(choices: [.keyword(text: "repeat")])
       ),
       Child(
-        name: "PatternType",
+        name: "Pack",
+        deprecatedName: "PatternType",
         kind: .node(kind: .type)
       ),
     ]
@@ -411,7 +417,8 @@ public let TYPE_NODES: [Node] = [
         kind: .token(choices: [.keyword(text: "each")])
       ),
       Child(
-        name: "PackType",
+        name: "Pack",
+        deprecatedName: "PackType",
         kind: .node(kind: .type)
       ),
     ]

CodeGeneration/Tests/ValidateSyntaxNodes/ValidateSyntaxNodes.swift

@@ -289,7 +289,7 @@ class ValidateSyntaxNodes: XCTestCase {
         // If the node is named the same as the token, we don't need to repeat the entire token name
         ValidationFailure(
           node: .regexLiteralExpr,
-          message: "child 'RegexPattern' has a token as its only token choice and should thus be named 'RegexLiteralPattern'"
+          message: "child 'Regex' has a token as its only token choice and should thus be named 'RegexLiteralPattern'"
             // No point repeating the `Literal` because the node name alredy contains it
         ),
         ValidationFailure(
@@ -643,4 +643,51 @@ class ValidateSyntaxNodes: XCTestCase {
       expectedFailures: []
     )
   }
+
+  func testChildrenDontEndWithExprEtc() {
+    var failures: [ValidationFailure] = []
+
+    let forbiddenSuffixes = ["Decl", "Declaration", "Expr", "Expression", "Pattern", "Stmt", "Statement", "Syntax", "Type"]
+
+    for node in SYNTAX_NODES.compactMap(\.layoutNode) {
+      for child in node.nonUnexpectedChildren {
+        for forbiddenSuffix in forbiddenSuffixes {
+          if child.name.hasSuffix(forbiddenSuffix) && child.name != forbiddenSuffix {
+            failures.append(
+              ValidationFailure(
+                node: node.kind,
+                message: "child '\(child.name)' should not end with '\(forbiddenSuffix)'"
+              )
+            )
+          }
+        }
+      }
+    }
+
+    assertFailuresMatchXFails(
+      failures,
+      expectedFailures: [
+        // MARK: Adjective + Type
+        // There’s no real better way to name these except to use an adjective followed by 'Type'
+        ValidationFailure(node: .attributedType, message: "child 'BaseType' should not end with 'Type'"),
+        ValidationFailure(node: .conformanceRequirement, message: "child 'LeftType' should not end with 'Type'"),
+        ValidationFailure(node: .conformanceRequirement, message: "child 'RightType' should not end with 'Type'"),
+        ValidationFailure(node: .constrainedSugarType, message: "child 'BaseType' should not end with 'Type'"),
+        ValidationFailure(node: .extensionDecl, message: "child 'ExtendedType' should not end with 'Type'"),
+        ValidationFailure(node: .genericParameter, message: "child 'InheritedType' should not end with 'Type'"),
+        ValidationFailure(node: .implicitlyUnwrappedOptionalType, message: "child 'WrappedType' should not end with 'Type'"),
+        ValidationFailure(node: .memberTypeIdentifier, message: "child 'BaseType' should not end with 'Type'"),
+        ValidationFailure(node: .metatypeType, message: "child 'BaseType' should not end with 'Type'"),
+        ValidationFailure(node: .namedOpaqueReturnType, message: "child 'BaseType' should not end with 'Type'"),
+        ValidationFailure(node: .optionalType, message: "child 'WrappedType' should not end with 'Type'"),
+        ValidationFailure(node: .qualifiedDeclName, message: "child 'BaseType' should not end with 'Type'"),
+        ValidationFailure(node: .sameTypeRequirement, message: "child 'LeftType' should not end with 'Type'"),
+        ValidationFailure(node: .sameTypeRequirement, message: "child 'RightType' should not end with 'Type'"),
+        // MARK: Adjective + Expr
+        ValidationFailure(node: .functionCallExpr, message: "child 'CalledExpression' should not end with 'Expression'"),
+        ValidationFailure(node: .prefixOperatorExpr, message: "child 'BaseExpression' should not end with 'Expression'"),
+        ValidationFailure(node: .subscriptExpr, message: "child 'CalledExpression' should not end with 'Expression'"),
+      ]
+    )
+  }
 }

Sources/SwiftParserDiagnostics/generated/ChildNameForDiagnostics.swift

@@ -94,13 +94,13 @@ private func childNameForDiagnostics(_ keyPath: AnyKeyPath) -> String? {
     return "attributes"
   case \DeinitializerDeclSyntax.modifiers:
     return "modifiers"
-  case \DictionaryElementSyntax.keyExpression:
+  case \DictionaryElementSyntax.key:
     return "key"
-  case \DictionaryElementSyntax.valueExpression:
+  case \DictionaryElementSyntax.value:
     return "value"
-  case \DictionaryTypeSyntax.keyType:
+  case \DictionaryTypeSyntax.key:
     return "key type"
-  case \DictionaryTypeSyntax.valueType:
+  case \DictionaryTypeSyntax.value:
     return "value type"
   case \DifferentiabilityParamsClauseSyntax.parameters:
     return "parameters"
@@ -300,7 +300,7 @@ private func childNameForDiagnostics(_ keyPath: AnyKeyPath) -> String? {
     return "body"
   case \RepeatWhileStmtSyntax.condition:
     return "condition"
-  case \ReturnClauseSyntax.returnType:
+  case \ReturnClauseSyntax.type:
     return "return type"
   case \SameTypeRequirementSyntax.leftType:
     return "left-hand type"
@@ -338,7 +338,7 @@ private func childNameForDiagnostics(_ keyPath: AnyKeyPath) -> String? {
     return "label"
   case \TargetFunctionEntrySyntax.declname:
     return "declaration name"
-  case \TernaryExprSyntax.conditionExpression:
+  case \TernaryExprSyntax.condition:
     return "condition"
   case \TernaryExprSyntax.firstChoice:
     return "first choice"