Skip to content

Commit 148533e

Browse files
AppAppWorksAppAppWorks
committed
add fix-its for bare regex literal with leading and/or trailing space
added "convert to extended regex literal" and "insert '\'" to `SwiftSyntax.TokenDiagnostic.fixIts` modified related test cases
1 parent 8b53f92 commit 148533e

9 files changed

+538
-55
lines changed

‎Sources/SwiftParser/Lexer/RegexLiteralLexer.swift

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,6 @@ fileprivate struct RegexLiteralLexer {
256256
// }
257257
//
258258
if mustBeRegex {
259-
// TODO: We ought to have a fix-it that inserts a backslash to escape.
260259
builder.recordPatternError(.spaceAtStartOfRegexLiteral, at: cursor)
261260
} else {
262261
return .notARegex

‎Sources/SwiftParserDiagnostics/LexerDiagnosticMessages.swift

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,52 @@ extension SwiftSyntax.TokenDiagnostic {
325325
changes.append(.replaceLeadingTrivia(token: nextToken, newTrivia: []))
326326
}
327327
return [FixIt(message: .removeExtraneousWhitespace, changes: changes)]
328+
case .spaceAtStartOfRegexLiteral:
329+
var ancestor = Syntax(token)
330+
while ancestor.kind != .regexLiteralExpr, let parent = ancestor.parent {
331+
ancestor = parent
332+
}
333+
guard let regexLiteral = ancestor.as(RegexLiteralExprSyntax.self) else {
334+
return []
335+
}
336+
337+
let regexText = regexLiteral.regex.text
338+
let lastIndex = regexText.index(before: regexText.endIndex)
339+
let escapedRegexText: String
340+
if regexText.startIndex != lastIndex && regexText[lastIndex].isWhitespace {
341+
escapedRegexText = #"\\#(regexText[..<lastIndex])\\#(regexText[lastIndex])"#
342+
} else {
343+
escapedRegexText = #"\\#(regexText)"#
344+
}
345+
346+
return [
347+
FixIt(
348+
message: .convertToExtendedRegexLiteral,
349+
changes: [
350+
.replace(
351+
oldNode: ancestor,
352+
newNode: Syntax(
353+
regexLiteral
354+
.with(\.openingPounds, .poundToken())
355+
.with(\.closingPounds, .poundToken(trailingTrivia: regexLiteral.trailingTrivia))
356+
.with(\.closingSlash.trailingTrivia, [])
357+
)
358+
)
359+
]
360+
),
361+
FixIt(
362+
message: .insertBackslash,
363+
changes: [
364+
.replace(
365+
oldNode: ancestor,
366+
newNode: Syntax(
367+
regexLiteral
368+
.with(\.regex, .regexLiteralPattern(escapedRegexText))
369+
)
370+
)
371+
]
372+
),
373+
]
328374
default:
329375
return []
330376
}

‎Sources/SwiftParserDiagnostics/ParserDiagnosticMessages.swift

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -655,6 +655,9 @@ extension FixItMessage where Self == StaticParserFixIt {
655655
public static var insertAttributeArguments: Self {
656656
.init("insert attribute argument")
657657
}
658+
public static var insertBackslash: Self {
659+
.init("insert '\\'")
660+
}
658661
public static var insertNewline: Self {
659662
.init("insert newline")
660663
}
@@ -691,6 +694,9 @@ extension FixItMessage where Self == StaticParserFixIt {
691694
public static var wrapInBackticks: Self {
692695
.init("if this name is unavoidable, use backticks to escape it")
693696
}
697+
public static var convertToExtendedRegexLiteral: Self {
698+
.init("convert to extended regex literal with '#'")
699+
}
694700
}
695701

696702
public struct InsertFixIt: ParserFixIt {

‎Tests/SwiftParserTest/DeclarationTests.swift

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1268,25 +1268,34 @@ final class DeclarationTests: ParserTestCase {
12681268
),
12691269
DiagnosticSpec(
12701270
locationMarker: "4️⃣",
1271-
message: "bare slash regex literal may not start with space"
1271+
message: "bare slash regex literal may not start with space",
1272+
fixIts: [
1273+
"convert to extended regex literal with '#'",
1274+
#"insert '\'"#,
1275+
]
12721276
),
12731277
DiagnosticSpec(
12741278
locationMarker: "5️⃣",
12751279
message: "expected '/' to end regex literal",
12761280
notes: [NoteSpec(locationMarker: "3️⃣", message: "to match this opening '/'")],
1277-
fixIts: ["insert '/\'"]
1281+
fixIts: ["insert '/'"]
12781282
),
12791283
DiagnosticSpec(
12801284
locationMarker: "6️⃣",
12811285
message: "extraneous brace at top level"
12821286
),
12831287
],
1284-
fixedSource: """
1288+
applyFixIts: [
1289+
"insert '}'",
1290+
#"insert '\'"#,
1291+
"insert '/'",
1292+
],
1293+
fixedSource: #"""
12851294
struct S {
12861295
}
1287-
/ ###line 25 "line-directive.swift"/
1296+
/\ ###line 25 "line-directive.swift"/
12881297
}
1289-
"""
1298+
"""#
12901299
)
12911300
}
12921301

‎Tests/SwiftParserTest/RegexLiteralTests.swift

Lines changed: 186 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -429,8 +429,37 @@ final class RegexLiteralTests: ParserTestCase {
429429
/1️⃣ a/
430430
""",
431431
diagnostics: [
432-
DiagnosticSpec(message: "bare slash regex literal may not start with space")
433-
]
432+
DiagnosticSpec(
433+
message: "bare slash regex literal may not start with space",
434+
fixIts: [
435+
"convert to extended regex literal with '#'",
436+
#"insert '\'"#,
437+
]
438+
)
439+
],
440+
applyFixIts: ["convert to extended regex literal with '#'"],
441+
fixedSource: """
442+
#/ a/#
443+
"""
444+
)
445+
446+
assertParse(
447+
"""
448+
/1️⃣ a/
449+
""",
450+
diagnostics: [
451+
DiagnosticSpec(
452+
message: "bare slash regex literal may not start with space",
453+
fixIts: [
454+
"convert to extended regex literal with '#'",
455+
#"insert '\'"#,
456+
]
457+
)
458+
],
459+
applyFixIts: [#"insert '\'"#],
460+
fixedSource: #"""
461+
/\ a/
462+
"""#
434463
)
435464
}
436465

@@ -440,8 +469,37 @@ final class RegexLiteralTests: ParserTestCase {
440469
let x = /1️⃣ a/
441470
""",
442471
diagnostics: [
443-
DiagnosticSpec(message: "bare slash regex literal may not start with space")
444-
]
472+
DiagnosticSpec(
473+
message: "bare slash regex literal may not start with space",
474+
fixIts: [
475+
"convert to extended regex literal with '#'",
476+
#"insert '\'"#,
477+
]
478+
)
479+
],
480+
applyFixIts: ["convert to extended regex literal with '#'"],
481+
fixedSource: """
482+
let x = #/ a/#
483+
"""
484+
)
485+
486+
assertParse(
487+
"""
488+
let x = /1️⃣ a/
489+
""",
490+
diagnostics: [
491+
DiagnosticSpec(
492+
message: "bare slash regex literal may not start with space",
493+
fixIts: [
494+
"convert to extended regex literal with '#'",
495+
#"insert '\'"#,
496+
]
497+
)
498+
],
499+
applyFixIts: [#"insert '\'"#],
500+
fixedSource: #"""
501+
let x = /\ a/
502+
"""#
445503
)
446504
}
447505

@@ -495,8 +553,37 @@ final class RegexLiteralTests: ParserTestCase {
495553
/1️⃣ /
496554
""",
497555
diagnostics: [
498-
DiagnosticSpec(message: "bare slash regex literal may not start with space")
499-
]
556+
DiagnosticSpec(
557+
message: "bare slash regex literal may not start with space",
558+
fixIts: [
559+
"convert to extended regex literal with '#'",
560+
#"insert '\'"#,
561+
]
562+
)
563+
],
564+
applyFixIts: ["convert to extended regex literal with '#'"],
565+
fixedSource: """
566+
#/ /#
567+
"""
568+
)
569+
570+
assertParse(
571+
"""
572+
/1️⃣ /
573+
""",
574+
diagnostics: [
575+
DiagnosticSpec(
576+
message: "bare slash regex literal may not start with space",
577+
fixIts: [
578+
"convert to extended regex literal with '#'",
579+
#"insert '\'"#,
580+
]
581+
)
582+
],
583+
applyFixIts: [#"insert '\'"#],
584+
fixedSource: #"""
585+
/\ \ /
586+
"""#
500587
)
501588
}
502589

@@ -506,8 +593,37 @@ final class RegexLiteralTests: ParserTestCase {
506593
x += /1️⃣ /
507594
""",
508595
diagnostics: [
509-
DiagnosticSpec(message: "bare slash regex literal may not start with space")
510-
]
596+
DiagnosticSpec(
597+
message: "bare slash regex literal may not start with space",
598+
fixIts: [
599+
"convert to extended regex literal with '#'",
600+
#"insert '\'"#,
601+
]
602+
)
603+
],
604+
applyFixIts: ["convert to extended regex literal with '#'"],
605+
fixedSource: """
606+
x += #/ /#
607+
"""
608+
)
609+
610+
assertParse(
611+
"""
612+
x += /1️⃣ /
613+
""",
614+
diagnostics: [
615+
DiagnosticSpec(
616+
message: "bare slash regex literal may not start with space",
617+
fixIts: [
618+
"convert to extended regex literal with '#'",
619+
#"insert '\'"#,
620+
]
621+
)
622+
],
623+
applyFixIts: [#"insert '\'"#],
624+
fixedSource: #"""
625+
x += /\ \ /
626+
"""#
511627
)
512628
}
513629

@@ -525,8 +641,37 @@ final class RegexLiteralTests: ParserTestCase {
525641
/1️⃣ /
526642
""",
527643
diagnostics: [
528-
DiagnosticSpec(message: "bare slash regex literal may not start with space")
529-
]
644+
DiagnosticSpec(
645+
message: "bare slash regex literal may not start with space",
646+
fixIts: [
647+
"convert to extended regex literal with '#'",
648+
#"insert '\'"#,
649+
]
650+
)
651+
],
652+
applyFixIts: ["convert to extended regex literal with '#'"],
653+
fixedSource: """
654+
#/ /#
655+
"""
656+
)
657+
658+
assertParse(
659+
"""
660+
/1️⃣ /
661+
""",
662+
diagnostics: [
663+
DiagnosticSpec(
664+
message: "bare slash regex literal may not start with space",
665+
fixIts: [
666+
"convert to extended regex literal with '#'",
667+
#"insert '\'"#,
668+
]
669+
)
670+
],
671+
applyFixIts: [#"insert '\'"#],
672+
fixedSource: #"""
673+
/\ /
674+
"""#
530675
)
531676
}
532677

@@ -536,8 +681,37 @@ final class RegexLiteralTests: ParserTestCase {
536681
let x = /1️⃣ /
537682
""",
538683
diagnostics: [
539-
DiagnosticSpec(message: "bare slash regex literal may not start with space")
540-
]
684+
DiagnosticSpec(
685+
message: "bare slash regex literal may not start with space",
686+
fixIts: [
687+
"convert to extended regex literal with '#'",
688+
#"insert '\'"#,
689+
]
690+
)
691+
],
692+
applyFixIts: ["convert to extended regex literal with '#'"],
693+
fixedSource: """
694+
let x = #/ /#
695+
"""
696+
)
697+
698+
assertParse(
699+
"""
700+
let x = /1️⃣ /
701+
""",
702+
diagnostics: [
703+
DiagnosticSpec(
704+
message: "bare slash regex literal may not start with space",
705+
fixIts: [
706+
"convert to extended regex literal with '#'",
707+
#"insert '\'"#,
708+
]
709+
)
710+
],
711+
applyFixIts: [#"insert '\'"#],
712+
fixedSource: #"""
713+
let x = /\ /
714+
"""#
541715
)
542716
}
543717

0 commit comments

Comments
 (0)