Skip to content

Update rules to use the operator-folded syntax tree. #441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 23 additions & 15 deletions Sources/SwiftFormatRules/UseSynthesizedInitializer.swift
Original file line number Diff line number Diff line change
Expand Up @@ -142,27 +142,35 @@ public final class UseSynthesizedInitializer: SyntaxLintRule {

var statements: [String] = []
for statement in initBody.statements {
guard let exp = statement.item.as(SequenceExprSyntax.self) else { return false }
guard
let expr = statement.item.as(InfixOperatorExprSyntax.self),
expr.operatorOperand.is(AssignmentExprSyntax.self)
else {
return false
}

var leftName = ""
var rightName = ""

for element in exp.elements {
switch Syntax(element).as(SyntaxEnum.self) {
case .memberAccessExpr(let element):
guard let base = element.base,
base.description.trimmingCharacters(in: .whitespacesAndNewlines) == "self"
else {
return false
}
leftName = element.name.text
case .assignmentExpr(let element):
guard element.assignToken.tokenKind == .equal else { return false }
case .identifierExpr(let element):
rightName = element.identifier.text
default:
if let memberAccessExpr = expr.leftOperand.as(MemberAccessExprSyntax.self) {
guard
let base = memberAccessExpr.base,
base.description.trimmingCharacters(in: .whitespacesAndNewlines) == "self"
else {
return false
}

leftName = memberAccessExpr.name.text
} else {
return false
}

if let identifierExpr = expr.rightOperand.as(IdentifierExprSyntax.self) {
rightName = identifierExpr.identifier.text
} else {
return false
}

guard leftName == rightName else { return false }
statements.append(leftName)
}
Expand Down
11 changes: 8 additions & 3 deletions Tests/SwiftFormatRulesTests/LintOrFormatRuleTestCase.swift
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import SwiftFormatConfiguration
import SwiftFormatCore
import SwiftFormatTestSupport
import SwiftSyntax
import SwiftOperators
import SwiftParser
import SwiftSyntax
import XCTest

class LintOrFormatRuleTestCase: DiagnosingTestCase {
Expand All @@ -19,7 +20,9 @@ class LintOrFormatRuleTestCase: DiagnosingTestCase {
file: StaticString = #file,
line: UInt = #line
) {
let sourceFileSyntax = restoringLegacyTriviaBehavior(Parser.parse(source: input))
let sourceFileSyntax = try! restoringLegacyTriviaBehavior(
OperatorTable.standardOperators.foldAll(Parser.parse(source: input))
.as(SourceFileSyntax.self)!)

// Force the rule to be enabled while we test it.
var configuration = Configuration()
Expand Down Expand Up @@ -56,7 +59,9 @@ class LintOrFormatRuleTestCase: DiagnosingTestCase {
file: StaticString = #file,
line: UInt = #line
) {
let sourceFileSyntax = restoringLegacyTriviaBehavior(Parser.parse(source: input))
let sourceFileSyntax = try! restoringLegacyTriviaBehavior(
OperatorTable.standardOperators.foldAll(Parser.parse(source: input))
.as(SourceFileSyntax.self)!)

// Force the rule to be enabled while we test it.
var configuration = configuration ?? Configuration()
Expand Down
14 changes: 6 additions & 8 deletions Tests/SwiftFormatRulesTests/NeverForceUnwrapTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,14 @@ final class NeverForceUnwrapTests: LintOrFormatRuleTestCase {
}
"""
performLint(NeverForceUnwrap.self, input: input)
XCTAssertDiagnosed(.doNotForceUnwrap(name: "(someValue())"))
XCTAssertDiagnosed(.doNotForceUnwrap(name: "String(a)"))
XCTAssertDiagnosed(.doNotForceCast(name: "Int"), line: 3, column: 11)
XCTAssertDiagnosed(.doNotForceUnwrap(name: "(someValue())"), line: 4, column: 11)
XCTAssertDiagnosed(.doNotForceUnwrap(name: "String(a)"), line: 5, column: 11)
XCTAssertNotDiagnosed(.doNotForceCast(name: "try"))
XCTAssertNotDiagnosed(.doNotForceUnwrap(name: "try"))
XCTAssertDiagnosed(.doNotForceUnwrap(name: "a"))
XCTAssertDiagnosed(.doNotForceUnwrap(name: "[1: a, 2: b, 3: c][4]"))
// FIXME: These diagnostics will be emitted once NeverForceUnwrap is taught
// how to interpret Unresolved* components in sequence expressions.
// XCTAssertDiagnosed(.doNotForceCast(name: "Int"))
// XCTAssertDiagnosed(.doNotForceCast(name: "FooBarType"))
XCTAssertDiagnosed(.doNotForceUnwrap(name: "[1: a, 2: b, 3: c][4]"), line: 7, column: 35)
XCTAssertDiagnosed(.doNotForceCast(name: "FooBarType"), line: 8, column: 11)
XCTAssertDiagnosed(.doNotForceUnwrap(name: "a"), line: 9, column: 10)
}

func testIgnoreTestCode() {
Expand Down