CorrectableRule

public protocol CorrectableRule : Rule

A rule that can correct violations.

Show on GitHub
  • correct(file:compilerArguments:) Default implementation

    Attempts to correct the violations to this rule in the specified file.

    Default Implementation

    Declaration

    Swift

    func correct(file: SwiftLintFile, compilerArguments: [String]) -> Int

    Parameters

    file

    The file for which to correct violations.
    compilerArguments

    The compiler arguments needed to compile this file.

    Return Value

    Number of corrections that were applied.

    Show on GitHub

  • Attempts to correct the violations to this rule in the specified file.

    Declaration

    Swift

    func correct(file: SwiftLintFile) -> Int

    Parameters

    file

    The file for which to correct violations.

    Return Value

    Number of corrections that were applied.

    Show on GitHub

  • Attempts to correct the violations to this rule in the specified file after collecting file info for all files and returns all corrections that were applied.

    Note

    This function is called by the linter and is always implemented in extensions.

    Default Implementation

    Declaration

    Swift

    func correct(file: SwiftLintFile, using storage: RuleStorage, compilerArguments: [String]) -> Int

    Parameters

    file

    The file for which to execute the rule.
    storage

    The storage object containing all collected info.
    compilerArguments

    The compiler arguments needed to compile this file.

    Return Value

    All corrections that were applied.

    Show on GitHub