Add diagnostic message for identifier editor placeholder

Author: kimdv

Sources/SwiftParser/Lexer/Cursor.swift

@@ -2044,6 +2044,7 @@ extension Lexer.Cursor {
 extension Lexer.Cursor {
   mutating func tryLexEditorPlaceholder(sourceBufferStart: Lexer.Cursor) -> Lexer.Result {
     precondition(self.is(at: "<") && self.is(offset: 1, at: "#"))
+    let start = self
     var ptr = self
     let leftAngleConsumed = ptr.advance(matching: "<")
     let poundConsumed = ptr.advance(matching: "#")
@@ -2058,7 +2059,10 @@ extension Lexer.Cursor {
         let closingAngleConsumed = ptr.advance(matching: ">")
         precondition(closingAngleConsumed)
         self = ptr
-        return Lexer.Result(.identifier)
+        return Lexer.Result(
+          .identifier,
+          error: LexingDiagnostic(.editorPlaceholder, position: start)
+        )
       default:
         break
       }

Sources/SwiftParserDiagnostics/LexerDiagnosticMessages.swift

@@ -38,6 +38,7 @@ public extension TokenError {
 
 /// Please order the cases in this enum alphabetically by case name.
 public enum StaticTokenError: String, DiagnosticMessage {
+  case editorPlaceholder = "editor placeholder in source file"
   case expectedBinaryExponentInHexFloatLiteral = "hexadecimal floating point literal must end with an exponent"
   case expectedClosingBraceInUnicodeEscape = #"expected '}' in \u{...} escape sequence"#
   case expectedDigitInFloatLiteral = "expected a digit in floating point exponent"
@@ -132,6 +133,7 @@ public extension SwiftSyntax.TokenDiagnostic {
     }
 
     switch self.kind {
+    case .editorPlaceholder: return StaticTokenError.editorPlaceholder
     case .expectedBinaryExponentInHexFloatLiteral: return StaticTokenError.expectedBinaryExponentInHexFloatLiteral
     case .expectedClosingBraceInUnicodeEscape: return StaticTokenError.expectedClosingBraceInUnicodeEscape
     case .expectedDigitInFloatLiteral: return StaticTokenError.expectedDigitInFloatLiteral

Sources/SwiftSyntax/TokenDiagnostic.swift

@@ -22,6 +22,7 @@ public struct TokenDiagnostic: Hashable {
   public enum Kind {
     // Please order these alphabetically
 
+    case editorPlaceholder
     case expectedBinaryExponentInHexFloatLiteral
     case expectedClosingBraceInUnicodeEscape
     case expectedDigitInFloatLiteral
@@ -94,6 +95,7 @@ public struct TokenDiagnostic: Hashable {
 
   public var severity: Severity {
     switch kind {
+    case .editorPlaceholder: return .error
     case .expectedBinaryExponentInHexFloatLiteral: return .error
     case .expectedClosingBraceInUnicodeEscape: return .error
     case .expectedDigitInFloatLiteral: return .error

Tests/SwiftParserTest/Assertions.swift

@@ -87,7 +87,7 @@ private func assertTokens(
   var lexemeStartOffset = 0
   for (actualLexeme, expectedLexeme) in zip(actual, expected) {
     defer {
-      lexemeStartOffset = actualLexeme.byteLength
+      lexemeStartOffset += actualLexeme.byteLength
     }
     if actualLexeme.rawTokenKind != expectedLexeme.rawTokenKind {
       XCTFail(

Tests/SwiftParserTest/DeclarationTests.swift

@@ -1379,12 +1379,15 @@ final class DeclarationTests: XCTestCase {
     assertParse(
       """
       class Foo {
-        <#code#>
+        1️⃣<#code#>
       }
       """,
       substructure: Syntax(
         MemberDeclListItemSyntax(decl: EditorPlaceholderDeclSyntax(identifier: .identifier("<#code#>")))
-      )
+      ),
+      diagnostics: [
+        DiagnosticSpec(message: "editor placeholder in source file")
+      ]
     )
   }
 

Tests/SwiftParserTest/ExpressionTests.swift

@@ -838,9 +838,28 @@ final class ExpressionTests: XCTestCase {
   }
 
   func testCodeCompletionExpressions() {
-    assertParse("if !<#b1#> && !<#b2#> {}")
-    assertParse("if <#test#> {}")
-    assertParse("if <#b1#>, <#b2#> {}")
+    assertParse(
+      "if !1️⃣<#b1#> && !2️⃣<#b2#> {}",
+      diagnostics: [
+        DiagnosticSpec(locationMarker: "1️⃣", message: "editor placeholder in source file"),
+        DiagnosticSpec(locationMarker: "2️⃣", message: "editor placeholder in source file"),
+      ]
+    )
+
+    assertParse(
+      "if 1️⃣<#test#> {}",
+      diagnostics: [
+        DiagnosticSpec(locationMarker: "1️⃣", message: "editor placeholder in source file")
+      ]
+    )
+
+    assertParse(
+      "if 1️⃣<#b1#>, 2️⃣<#b2#> {}",
+      diagnostics: [
+        DiagnosticSpec(locationMarker: "1️⃣", message: "editor placeholder in source file"),
+        DiagnosticSpec(locationMarker: "2️⃣", message: "editor placeholder in source file"),
+      ]
+    )
   }
 
   func testKeywordApplyExpression() {

Tests/SwiftParserTest/LexerTests.swift

@@ -32,7 +32,7 @@ fileprivate func lex(_ sourceBytes: [UInt8], body: ([Lexer.Lexeme]) throws -> Vo
 /// values for trivia and text. While this is good for most cases, string
 /// literals can't contain invalid UTF-8. Thus, we need a different assert
 /// function working on byte arrays to test source code containing invalid UTF-8.
-fileprivate func assertRawBytesLexeme(
+fileprivate func AssertRawBytesLexeme(
   _ lexeme: Lexer.Lexeme,
   kind: RawTokenKind,
   leadingTrivia: [UInt8] = [],
@@ -663,20 +663,20 @@ public class LexerTests: XCTestCase {
 
   func testEditorPlaceholders() {
     assertLexemes(
-      "!<#b1#> && !<#b2#>",
+      "!1️⃣<#b1#> && !2️⃣<#b2#>",
       lexemes: [
         LexemeSpec(.prefixOperator, text: "!"),
-        LexemeSpec(.identifier, text: "<#b1#>", trailing: " "),
+        LexemeSpec(.identifier, text: "<#b1#>", trailing: " ", errorLocationMarker: "1️⃣", diagnostic: "editor placeholder in source file"),
         LexemeSpec(.binaryOperator, text: "&&", trailing: " "),
         LexemeSpec(.prefixOperator, text: "!"),
-        LexemeSpec(.identifier, text: "<#b2#>"),
+        LexemeSpec(.identifier, text: "<#b2#>", errorLocationMarker: "2️⃣", diagnostic: "editor placeholder in source file"),
       ]
     )
 
     assertLexemes(
-      "<##>",
+      "1️⃣<##>",
       lexemes: [
-        LexemeSpec(.identifier, text: "<##>", trailing: "")
+        LexemeSpec(.identifier, text: "<##>", trailing: "", diagnostic: "editor placeholder in source file")
       ]
     )
   }
@@ -812,7 +812,7 @@ public class LexerTests: XCTestCase {
         return XCTFail("Expected 1 lexeme, got \(lexemes.count)")
       }
 
-      assertRawBytesLexeme(
+      AssertRawBytesLexeme(
         lexemes[0],
         kind: .eof,
         leadingTrivia: sourceBytes,
@@ -828,7 +828,7 @@ public class LexerTests: XCTestCase {
         return XCTFail("Expected 2 lexemes, got \(lexemes.count)")
       }
 
-      assertRawBytesLexeme(
+      AssertRawBytesLexeme(
         lexemes[0],
         kind: .identifier,
         text: sourceBytes
@@ -843,7 +843,7 @@ public class LexerTests: XCTestCase {
         return XCTFail("Expected 4 lexemes, got \(lexemes.count)")
       }
 
-      assertRawBytesLexeme(
+      AssertRawBytesLexeme(
         lexemes[1],
         kind: .binaryOperator,
         text: [UInt8(ascii: "+")],
@@ -859,7 +859,7 @@ public class LexerTests: XCTestCase {
       guard lexemes.count == 1 else {
         return XCTFail("Expected 1 lexeme, got \(lexemes.count)")
       }
-      assertRawBytesLexeme(
+      AssertRawBytesLexeme(
         lexemes[0],
         kind: .eof,
         leadingTrivia: sourceBytes,
@@ -876,7 +876,7 @@ public class LexerTests: XCTestCase {
       guard lexemes.count == 1 else {
         return XCTFail("Expected 1 lexeme, got \(lexemes.count)")
       }
-      assertRawBytesLexeme(
+      AssertRawBytesLexeme(
         lexemes[0],
         kind: .eof,
         leadingTrivia: sourceBytes,
@@ -893,7 +893,7 @@ public class LexerTests: XCTestCase {
       guard lexemes.count == 2 else {
         return XCTFail("Expected 2 lexemes, got \(lexemes.count)")
       }
-      assertRawBytesLexeme(
+      AssertRawBytesLexeme(
         lexemes[0],
         kind: .identifier,
         leadingTrivia: [0xfd],
@@ -1080,7 +1080,7 @@ public class LexerTests: XCTestCase {
         return XCTFail("Expected 4 lexemes")
       }
 
-      assertRawBytesLexeme(
+      AssertRawBytesLexeme(
         lexemes[1],
         kind: .stringSegment,
         text: [0xef],

Tests/SwiftParserTest/translated/IdentifiersTests.swift

@@ -83,10 +83,10 @@ final class IdentifiersTests: XCTestCase {
     assertParse(
       """
       // Placeholders are recognized as identifiers but with error.
-      func <#some name#>() {}
+      func 1️⃣<#some name#>() {}
       """,
       diagnostics: [
-        // TODO: (good first issue) Old parser expected error on line 2: editor placeholder in source file
+        DiagnosticSpec(message: "editor placeholder in source file")
       ]
     )
   }