Deprecate placeholder nodes

Author: kimdv

CodeGeneration/Sources/SyntaxSupport/DeclNodes.swift

@@ -551,6 +551,7 @@ public let DECL_NODES: [Node] = [
   Node(
     kind: .editorPlaceholderDecl,
     base: .decl,
+    isDeprecated: true,
     nameForDiagnostics: "editor placeholder",
     documentation: """
       An editor placeholder, e.g. `<#declaration#>` that is used in a position that expects a declaration.

CodeGeneration/Sources/SyntaxSupport/ExprNodes.swift

@@ -791,6 +791,7 @@ public let EXPR_NODES: [Node] = [
   Node(
     kind: .editorPlaceholderExpr,
     base: .expr,
+    isDeprecated: true,
     nameForDiagnostics: "editor placeholder",
     children: [
       Child(

Sources/SwiftParser/Declarations.swift

@@ -275,9 +275,9 @@ extension Parser {
       }
 
       if self.currentToken.isEditorPlaceholder {
-        let placeholder = self.consumeAnyToken()
+        let placeholder = self.parseAnyIdentifier()
         return RawDeclSyntax(
-          RawEditorPlaceholderDeclSyntax(
+          RawMissingDeclSyntax(
             attributes: attrs.attributes,
             modifiers: attrs.modifiers,
             placeholder: placeholder,

Sources/SwiftParser/Expressions.swift

@@ -1241,14 +1241,6 @@ extension Parser {
   mutating func parseIdentifierExpression() -> RawExprSyntax {
     let declName = self.parseDeclReferenceExpr(.compoundNames)
     guard self.withLookahead({ $0.canParseAsGenericArgumentList() }) else {
-      if declName.baseName.tokenText.isEditorPlaceholder && declName.argumentNames == nil {
-        return RawExprSyntax(
-          RawEditorPlaceholderExprSyntax(
-            placeholder: declName.baseName,
-            arena: self.arena
-          )
-        )
-      }
       return RawExprSyntax(declName)
     }
 

Sources/SwiftParserDiagnostics/MissingNodesError.swift

@@ -381,7 +381,18 @@ extension ParseDiagnosticsGenerator {
 
     // Walk all upcoming sibling to see if they are also missing to handle them in this diagnostic.
     // If this is the case, handle all of them in this diagnostic.
-    var missingNodes = [Syntax(node)]
+    var missingNodes: [Syntax] = [Syntax(node)]
+
+    // If the node is an `MissingDeclSyntax` and the placeholder is an editor placeholder
+    // we should not add a diagnostic that it's missing.
+    // Instead, we should emit a diagnostic about the fact that there is an editor placeholder in the source file.
+    if let missing = missingNodes.first?.as(MissingDeclSyntax.self),
+      missing.placeholder.isEditorPlaceholder,
+      !missing.placeholder.isMissing
+    {
+        return .visitChildren
+    }
+
     if let parentWithTokens = ancestorWithMoreTokens, let index {
       let siblings = parentWithTokens.children(viewMode: .all)
       let siblingsAfter = siblings[siblings.index(after: index)...]

Sources/SwiftParserDiagnostics/ParseDiagnosticsGenerator.swift

@@ -678,7 +678,7 @@ public class ParseDiagnosticsGenerator: SyntaxAnyVisitor {
     if shouldSkip(node) {
       return .skipChildren
     }
-    if node.statements.only?.item.is(EditorPlaceholderExprSyntax.self) == true {
+    if let item = node.statements.only?.item.as(DeclReferenceExprSyntax.self), item.baseName.isEditorPlaceholder {
       // Only emit a single diagnostic about the editor placeholder and none for the missing '{' and '}'.
       addDiagnostic(node, .editorPlaceholderInSourceFile, handledNodes: [node.id])
       return .skipChildren

Sources/SwiftRefactor/ExpandEditorPlaceholder.swift

@@ -135,7 +135,8 @@ public struct ExpandEditorPlaceholder: EditRefactoringProvider {
 /// Expansion on `closure1` and `normalArg` is the same as `ExpandEditorPlaceholder`.
 public struct ExpandEditorPlaceholders: EditRefactoringProvider {
   public static func textRefactor(syntax token: TokenSyntax, in context: Void) -> [SourceEdit] {
-    guard let placeholder = token.parent?.as(EditorPlaceholderExprSyntax.self),
+    guard let placeholder = token.parent?.as(DeclReferenceExprSyntax.self),
+      placeholder.baseName.isEditorPlaceholder,
       let arg = placeholder.parent?.as(LabeledExprSyntax.self),
       let argList = arg.parent?.as(LabeledExprListSyntax.self),
       let call = argList.parent?.as(FunctionCallExprSyntax.self)
@@ -190,8 +191,8 @@ extension FunctionTypeSyntax {
       placeholder = ExpandEditorPlaceholder.wrapInTypePlaceholder(ret, type: ret)
     }
 
-    let statementPlaceholder = EditorPlaceholderExprSyntax(
-      placeholder: .identifier(placeholder)
+    let statementPlaceholder = DeclReferenceExprSyntax(
+      baseName: .identifier(placeholder)
     )
     let closureStatement = CodeBlockItemSyntax(
       item: .expr(ExprSyntax(statementPlaceholder))
@@ -234,8 +235,9 @@ extension FunctionCallExprSyntax {
     var includedArg = false
     var argsToExpand = 0
     for arg in arguments.reversed() {
-      guard let expr = arg.expression.as(EditorPlaceholderExprSyntax.self),
-        let data = EditorPlaceholderData(token: expr.placeholder),
+      guard let expr = arg.expression.as(DeclReferenceExprSyntax.self),
+        expr.baseName.isEditorPlaceholder,
+        let data = EditorPlaceholderData(token: expr.baseName),
         case let .typed(_, type) = data,
         type.is(FunctionTypeSyntax.self)
       else {
@@ -253,7 +255,7 @@ extension FunctionCallExprSyntax {
 
     var expandedArgs = [LabeledExprSyntax]()
     for arg in arguments.suffix(argsToExpand) {
-      let edits = ExpandEditorPlaceholder.textRefactor(syntax: arg.expression.cast(EditorPlaceholderExprSyntax.self).placeholder)
+      let edits = ExpandEditorPlaceholder.textRefactor(syntax: arg.expression.cast(DeclReferenceExprSyntax.self).baseName)
       guard edits.count == 1, let edit = edits.first, !edit.replacement.isEmpty else {
         return nil
       }

Sources/SwiftSyntax/generated/SyntaxAnyVisitor.swift

@@ -774,18 +774,22 @@ open class SyntaxAnyVisitor: SyntaxVisitor {
     visitAnyPost(node._syntaxNode)
   }
 
+  @available(*, deprecated, message: "This node is longer being generated by the parser.")
   override open func visit(_ node: EditorPlaceholderDeclSyntax) -> SyntaxVisitorContinueKind {
     return visitAny(node._syntaxNode)
   }
 
+  @available(*, deprecated, message: "This node is longer being generated by the parser.")
   override open func visitPost(_ node: EditorPlaceholderDeclSyntax) {
     visitAnyPost(node._syntaxNode)
   }
 
+  @available(*, deprecated, message: "This node is longer being generated by the parser.")
   override open func visit(_ node: EditorPlaceholderExprSyntax) -> SyntaxVisitorContinueKind {
     return visitAny(node._syntaxNode)
   }
 
+  @available(*, deprecated, message: "This node is longer being generated by the parser.")
   override open func visitPost(_ node: EditorPlaceholderExprSyntax) {
     visitAnyPost(node._syntaxNode)
   }

Sources/SwiftSyntax/generated/SyntaxEnum.swift

@@ -107,7 +107,9 @@ public enum SyntaxEnum {
   case documentationAttributeArgumentList(DocumentationAttributeArgumentListSyntax)
   case documentationAttributeArgument(DocumentationAttributeArgumentSyntax)
   case dynamicReplacementAttributeArguments(DynamicReplacementAttributeArgumentsSyntax)
+  @available(*, deprecated, message: "This node is longer being generated by the parser.")
   case editorPlaceholderDecl(EditorPlaceholderDeclSyntax)
+  @available(*, deprecated, message: "This node is longer being generated by the parser.")
   case editorPlaceholderExpr(EditorPlaceholderExprSyntax)
   case effectsAttributeArgumentList(EffectsAttributeArgumentListSyntax)
   case enumCaseDecl(EnumCaseDeclSyntax)

Sources/SwiftSyntax/generated/SyntaxRewriter.swift

@@ -709,13 +709,15 @@ open class SyntaxRewriter {
   /// Visit a ``EditorPlaceholderDeclSyntax``.
   ///   - Parameter node: the node that is being visited
   ///   - Returns: the rewritten node
+  @available(*, deprecated, message: "This node is longer being generated by the parser.")
   open func visit(_ node: EditorPlaceholderDeclSyntax) -> DeclSyntax {
     return DeclSyntax(visitChildren(node))
   }
 
   /// Visit a ``EditorPlaceholderExprSyntax``.
   ///   - Parameter node: the node that is being visited
   ///   - Returns: the rewritten node
+  @available(*, deprecated, message: "This node is longer being generated by the parser.")
   open func visit(_ node: EditorPlaceholderExprSyntax) -> ExprSyntax {
     return ExprSyntax(visitChildren(node))
   }