Structures

The following structures are available globally.

RuleListDocumentation
User-facing documentation for a SwiftLint RuleList.
See more
Declaration
Swift

public struct RuleListDocumentation
Show on GitHub
Stack
A basic stack type implementing the LIFO principle - only the last inserted element can be accessed and removed.
See more
Declaration
Swift

public struct Stack<Element>

extension Stack: CustomDebugStringConvertible where Element == CustomDebugStringConvertible
Show on GitHub
ChildOptionSeverityConfiguration
A rule configuration that allows to disable (off) an option of a rule or specify its severity level in which case it’s active.
See more
Declaration
Swift

public struct ChildOptionSeverityConfiguration<Parent> : RuleConfiguration, Equatable, InlinableOptionType where Parent : Rule
Show on GitHub
Command
A SwiftLint-interpretable command to modify SwiftLint’s behavior embedded as comments in source code.
See more
Declaration
Swift

public struct Command : Equatable
Show on GitHub
Configuration
The configuration struct for SwiftLint. User-defined in the .swiftlint.yml file, drives the behavior of SwiftLint.
See more
Declaration
Swift

public struct Configuration

extension Configuration: Hashable

extension Configuration: CustomStringConvertible
Show on GitHub
Correction
A value describing a SwiftLint violation that was corrected.
See more
Declaration
Swift

public struct Correction : Equatable
Show on GitHub
Example
Captures code and context information for an example of a triggering or non-triggering style
See more
Declaration
Swift

public struct Example

extension Example: Hashable

extension Example: Comparable
Show on GitHub
Linter
Represents a file that can be linted for style violations and corrections after being collected.
See more
Declaration
Swift

public struct Linter
Show on GitHub
CollectedLinter
Represents a file that can compute style violations and corrections for a list of rules.

A CollectedLinter is only created after a Linter has run its collection steps in Linter.collect(into:).
See more
Declaration
Swift

public struct CollectedLinter
Show on GitHub
Location
The placement of a segment of Swift in a collection of source files.
See more
Declaration
Swift

public struct Location : CustomStringConvertible, Comparable, Codable
Show on GitHub
Region
A contiguous region of Swift source code.
See more
Declaration
Swift

public struct Region : Equatable
Show on GitHub


                    
                    
                    RuleConfigurationDescription

Description of a rule configuration.

Declaration

Swift

public struct RuleConfigurationDescription : Equatable

extension RuleConfigurationDescription: Documentable

Show on GitHub

RuleConfigurationOption
A single option of a RuleConfigurationDescription.
See more
Declaration
Swift

public struct RuleConfigurationOption : Equatable

extension RuleConfigurationOption: Documentable
Show on GitHub

Result builder

RuleConfigurationDescriptionBuilder
A result builder creating configuration descriptions.
Declaration
Swift

@resultBuilder public struct RuleConfigurationDescriptionBuilder
Show on GitHub

Property wrapper

ConfigurationElement
A single parameter of a rule configuration.

Apply it to a simple (e.g. boolean) property like
```
@ConfigurationElement(key: "name")
var property = true
```
If the wrapped element is an InlinableOptionType, there are two options for its representation in the documentation:
1. It can be inlined into the parent configuration. For that, do not provide a name as an argument. E.g. swift @ConfigurationElement(key: "name") var property = true @ConfigurationElement var levels = SeverityLevelsConfiguration(warning: 1, error: 2) will be documented as a linear list: name: true warning: 1 error: 2
2. It can be represented as a separate nested configuration. In this case, it must have a name. E.g. swift @ConfigurationElement(key: "name") var property = true @ConfigurationElement(key: "levels") var levels = SeverityLevelsConfiguration(warning: 1, error: 2) will have a nested configuration section: name: true levels: warning: 1 error: 2
See more
Declaration
Swift

@propertyWrapper public struct ConfigurationElement<T> : Equatable where T : Equatable, T : AcceptableByConfigurationElement
Show on GitHub
SeverityConfiguration
A rule configuration that allows specifying the desired severity level for violations.
See more
Declaration
Swift

public struct SeverityConfiguration<Parent> : SeverityBasedRuleConfiguration, Equatable where Parent : Rule
Show on GitHub
RuleDescription
A detailed description for a SwiftLint rule. Used for both documentation and testing purposes.
See more
Declaration
Swift

public struct RuleDescription : Equatable
Show on GitHub
RuleList
A list of available SwiftLint rules.
See more
Declaration
Swift

public struct RuleList

extension RuleList: Equatable
Show on GitHub
RuleParameter
A configuration parameter for rules.
See more
Declaration
Swift

public struct RuleParameter<T> : Equatable where T : Equatable
Show on GitHub
StyleViolation
A value describing an instance of Swift source code that is considered invalid by a SwiftLint rule.
See more
Declaration
Swift

public struct StyleViolation : CustomStringConvertible, Equatable, Codable
Show on GitHub
SwiftLintSyntaxMap
Represents a Swift file’s syntax information.
See more
Declaration
Swift

public struct SwiftLintSyntaxMap
Show on GitHub
SwiftLintSyntaxToken
A SwiftLint-aware Swift syntax token.
See more
Declaration
Swift

public struct SwiftLintSyntaxToken
Show on GitHub
SwiftVersion
A value describing the version of the Swift compiler.
See more
Declaration
Swift

public struct SwiftVersion : RawRepresentable, Codable, Comparable
Show on GitHub
Version
A type describing the SwiftLint version.
See more
Declaration
Swift

public struct Version
Show on GitHub

YamlParser

YamlParser
An interface for parsing YAML.
See more
Declaration
Swift

public struct YamlParser
Show on GitHub
ReasonedRuleViolation
A violation produced by ViolationsSyntaxVisitors.
See more
Declaration
Swift

public struct ReasonedRuleViolation : Comparable, Hashable
Show on GitHub


                    
                    
                    RegexConfiguration

A rule configuration used for defining custom rules in yaml.

Declaration

Swift

public struct RegexConfiguration<Parent> : SeverityBasedRuleConfiguration, Hashable, CacheDescriptionProvider where Parent : Rule

Show on GitHub

SeverityLevelsConfiguration
A rule configuration that allows specifying thresholds for warning and error severities.
See more
Declaration
Swift

public struct SeverityLevelsConfiguration<Parent> : RuleConfiguration, Equatable where Parent : Rule
Show on GitHub
ViolationCorrection
The correction of a violation that is basically the violation’s range in the source code and a replacement for this range that would fix the violation.
See more
Declaration
Swift

public struct ViolationCorrection
Show on GitHub