Rule

public protocol Rule : Sendable

An executable value that can identify issues (violations) in Swift source code.

Show on GitHub

  • The type of the configuration used to configure this rule.

    Declaration

    Swift

    associatedtype ConfigurationType : RuleConfiguration
    Show on GitHub

  • A verbose description of many of this rule’s properties.

    Declaration

    Swift

    static var description: RuleDescription { get }
    Show on GitHub

  • This rule’s configuration.

    Declaration

    Swift

    var configuration: ConfigurationType { get set }
    Show on GitHub
  • shouldLintEmptyFiles Default implementation

    Whether this rule should be used on empty files. Defaults to false.

    Default Implementation

    Declaration

    Swift

    var shouldLintEmptyFiles: Bool { get }
    Show on GitHub

  • A default initializer for rules. All rules need to be trivially initializable.

    Declaration

    Swift

    init()
    Show on GitHub
  • init(configuration:) Default implementation

    Creates a rule by applying its configuration.

    Throws

    Throws if the configuration didn’t match the expected format.

    Default Implementation

    Declaration

    Swift

    init(configuration: Any) throws

    Parameters

    configuration

    The untyped configuration value to apply.
    Show on GitHub

  • Create a description of how this rule has been configured to run.

    Default Implementation

    Declaration

    Swift

    func createConfigurationDescription(exclusiveOptions: Set<String>) -> RuleConfigurationDescription

    Parameters

    exclusiveOptions

    A set of options that should be excluded from the description.

    Return Value

    A description of the rule’s configuration.

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

    Executes the rule on a file and returns any violations to the rule’s expectations.

    Default Implementation

    Declaration

    Swift

    func validate(file: SwiftLintFile, compilerArguments: [String]) -> [StyleViolation]

    Parameters

    file

    The file for which to execute the rule.
    compilerArguments

    The compiler arguments needed to compile this file.

    Return Value

    All style violations to the rule’s expectations.

    Show on GitHub

  • Executes the rule on a file and returns any violations to the rule’s expectations.

    Declaration

    Swift

    func validate(file: SwiftLintFile) -> [StyleViolation]

    Parameters

    file

    The file for which to execute the rule.

    Return Value

    All style violations to the rule’s expectations.

    Show on GitHub
  • isEqualTo(_:) Default implementation

    Whether or not the specified rule is equivalent to the current rule.

    Default Implementation

    Declaration

    Swift

    func isEqualTo(_ rule: some Rule) -> Bool

    Parameters

    rule

    The rule value to compare against.

    Return Value

    Whether or not the specified rule is equivalent to the current rule.

    Show on GitHub

  • Collects information for the specified file in a storage object, to be analyzed by a CollectedLinter.

    Note

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

    Default Implementation

    Declaration

    Swift

    func collectInfo(for file: SwiftLintFile, into storage: RuleStorage, compilerArguments: [String])

    Parameters

    file

    The file for which to collect info.
    storage

    The storage object where collected info should be saved.
    compilerArguments

    The compiler arguments needed to compile this file.
    Show on GitHub

  • Executes the rule on a file after collecting file info for all files and returns any violations to the rule’s expectations.

    Note

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

    Default Implementation

    Declaration

    Swift

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

    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 style violations to the rule’s expectations.

    Show on GitHub
  • canBeDisabled(violation:by:) Default implementation

    Checks if a style violation can be disabled by a command specifying a rule ID. Only the rule can claim that for sure since it knows all the possible identifiers.

    Default Implementation

    Declaration

    Swift

    func canBeDisabled(violation: StyleViolation, by ruleID: RuleIdentifier) -> Bool

    Parameters

    violation

    A style violation.
    ruleID

    The name of a rule as used in a disable command.

    Return Value

    A boolean value indicating whether the violation can be disabled by the given ID.

    Show on GitHub
  • isEnabled(in:for:) Default implementation

    Checks if a the rule is enabled in a given region. A specific rule ID can be provided in case a rule supports more than one identifier.

    Default Implementation

    Declaration

    Swift

    func isEnabled(in region: Region, for ruleID: String) -> Bool

    Parameters

    region

    The region to check.
    ruleID

    Rule identifier deviating from the default rule’s name.

    Return Value

    A boolean value indicating whether the rule is enabled in the given region.

    Show on GitHub
  • notifyRuleDisabledOnce() Default implementation

    Prints a warning to the console once about the rule being disabled due to SourceKit being unavailable. The default implementation does nothing. Rules that depend on SourceKit should override this appropriately.

    Default Implementation

    Declaration

    Swift

    func notifyRuleDisabledOnce()
    Show on GitHub
  • cacheDescription Extension method

    The cache description which will be used to determine if a previous cached value is still valid given the new cache value.

    Declaration

    Swift

    var cacheDescription: String { get }
    Show on GitHub
  • identifier Extension method

    The rule’s unique identifier which is the same as Rule.description.identifier.

    Declaration

    Swift

    static var identifier: String { get }
    Show on GitHub
  • requiresSourceKit Extension method

    Whether this rule requires SourceKit to operate. Returns false if the rule conforms to SourceKitFreeRule or if it conforms to ConditionallySourceKitFree and is currently configured to not require SourceKit.

    Declaration

    Swift

    var requiresSourceKit: Bool { get }
    Show on GitHub