Reporter

public protocol Reporter : CustomStringConvertible

An interface for reporting violations as strings.

Show on GitHub

  • The unique identifier for this reporter.

    Declaration

    Swift

    static var identifier: String { get }
    Show on GitHub

  • Whether or not this reporter can output incrementally as violations are found or if all violations must be collected before generating the report.

    Declaration

    Swift

    static var isRealtime: Bool { get }
    Show on GitHub

  • A more detailed description of the reporter’s output.

    Declaration

    Swift

    static var description: String { get }
    Show on GitHub

  • For CustomStringConvertible conformance.

    Declaration

    Swift

    var description: String { get }
    Show on GitHub

  • Return a string with the report for the specified violations.

    Declaration

    Swift

    static func generateReport(_ violations: [StyleViolation]) -> String

    Parameters

    violations

    The violations to report.

    Return Value

    The report.

    Show on GitHub