Protocols

A type that can be converted into a human-readable representation.

Type of an object that can be used as a configuration element.

An option type that can appear inlined into its using configuration.

The ConfigurationElement must opt into this behavior. In this case, the option does not have a key. This is almost exclusively useful for common RuleConfigurations that are used in many other rules as child configurations.

A comparable major.minor.patch version number.

A rule that leverages the Swift source’s pre-typechecked Abstract Syntax Tree to recurse into the source’s structure, validating the rule recursively in nested source bodies.

Interface providing access to a cache description.

Type-erased protocol used to check whether a rule is collectable.

A rule that requires knowledge of all other files being linted.

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

A rule that is not enabled by default. Rules conforming to this need to be explicitly enabled by users.

A rule that can correct violations.

A correctable rule that can apply its corrections by replacing the content of ranges in the offending file with updated content.

A rule that does not need SourceKit to operate and can still operate even after SourceKit has crashed.

A rule that may or may not require SourceKit depending on its configuration.

A rule that can operate on the post-typechecked AST using compiler arguments. Performs rules that are more like static analysis than syntactic checks.

A configuration value for a rule to allow users to modify its behavior.

A configuration for a rule that allows to configure at least the severity.

A SwiftLint CorrectableRule that performs its corrections using a SwiftSyntax SyntaxRewriter.

A SwiftLint Rule backed by SwiftSyntax that does not use SourceKit requests.

A configuration that’s based on warning and error thresholds for violations.