1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import SwiftSyntax
/// A rule that both formats and lints a given file.
@_spi(Rules)
public class SyntaxFormatRule: SyntaxRewriter, Rule {
/// Whether this rule is opt-in, meaning it's disabled by default. Rules are opt-out unless they
/// override this property.
public class var isOptIn: Bool {
return false
}
/// The context in which the rule is executed.
public let context: Context
/// Creates a new SyntaxFormatRule in the given context.
public required init(context: Context) {
self.context = context
}
public override func visitAny(_ node: Syntax) -> Syntax? {
// If the rule is not enabled, then return the node unmodified; otherwise, returning nil tells
// SwiftSyntax to continue with the standard dispatch.
guard context.shouldFormat(type(of: self), node: node) else { return node }
return nil
}
}
|
