Protocols
The following protocols are available globally.
-
Interface providing access to a cache description.
See moreDeclaration
Swift
public protocol CacheDescriptionProvider
-
Type-erased protocol used to check whether a rule is collectable.
Declaration
Swift
public protocol AnyCollectingRule : Rule
-
A rule that requires knowledge of all other files being linted.
See moreDeclaration
Swift
public protocol CollectingRule : AnyCollectingRule
-
An interface for reporting violations as strings.
See moreDeclaration
Swift
public protocol Reporter : CustomStringConvertible
-
An executable value that can identify issues (violations) in Swift source code.
See moreDeclaration
Swift
public protocol Rule
-
A rule that is not enabled by default. Rules conforming to this need to be explicitly enabled by users.
Declaration
Swift
public protocol OptInRule : Rule
-
A correctable rule that can apply its corrections by replacing the content of ranges in the offending file with updated content.
See moreDeclaration
Swift
public protocol SubstitutionCorrectableRule : CorrectableRule
-
A
See moreSubstitutionCorrectableRule
that is also anASTRule
.Declaration
Swift
public protocol SubstitutionCorrectableASTRule : ASTRule, SubstitutionCorrectableRule
-
A rule that does not need SourceKit to operate and can still operate even after SourceKit has crashed.
Declaration
Swift
public protocol SourceKitFreeRule : Rule
-
A configuration value for a rule to allow users to modify its behavior.
See moreDeclaration
Swift
public protocol RuleConfiguration<Parent>
-
A configuration for a rule that allows to configure at least the severity.
See moreDeclaration
Swift
public protocol SeverityBasedRuleConfiguration : RuleConfiguration
-
A SwiftLint CorrectableRule that performs its corrections using a SwiftSyntax
See moreSyntaxRewriter
.Declaration
Swift
public protocol SwiftSyntaxCorrectableRule : CorrectableRule, SwiftSyntaxRule
-
A SwiftSyntax
See moreSyntaxRewriter
that produces absolute positions where corrections were applied.Declaration
Swift
public protocol ViolationsSyntaxRewriter : SyntaxRewriter
-
A SwiftLint Rule backed by SwiftSyntax that does not use SourceKit requests.
See moreDeclaration
Swift
public protocol SwiftSyntaxRule : SourceKitFreeRule