ViolationsSyntaxRewriter

open class ViolationsSyntaxRewriter<Configuration> : SyntaxRewriter where Configuration : RuleConfiguration

A SwiftSyntax SyntaxRewriter that produces absolute positions where corrections were applied.

Show on GitHub

  • A rule’s configuration.

    Declaration

    Swift

    public let configuration: Configuration
    Show on GitHub

  • The file from which the traversed syntax tree stems from.

    Declaration

    Swift

    public let file: SwiftLintFile
    Show on GitHub

  • A converter of positions in the traversed source file.

    Declaration

    Swift

    public lazy var locationConverter: SourceLocationConverter { get set }
    Show on GitHub

  • The regions in the traversed file that are disabled by a command.

    Declaration

    Swift

    public lazy var disabledRegions: [SourceRange] { get set }
    Show on GitHub

  • The number of corrections made by the rewriter.

    Declaration

    Swift

    public var numberOfCorrections: Int
    Show on GitHub

  • Initializer for a ViolationsSyntaxRewriter.

    Declaration

    Swift

    @inlinable
public init(configuration: Configuration, file: SwiftLintFile)

    Parameters

    configuration

    Configuration of a rule.
    file

    File from which the syntax tree stems from.
    Show on GitHub

  • Determines whether the rule is disabled at the start position of the given syntax node.

    Declaration

    Swift

    public func isDisabled(atStartPositionOf node: some SyntaxProtocol) -> Bool

    Parameters

    node

    The syntax node to check.

    Return Value

    true if the rule is disabled for the node.

    Show on GitHub

  • Declaration

    Swift

    override open func visitAny(_ node: Syntax) -> Syntax?
    Show on GitHub