Structures
The following structures are available globally.
-
User-facing documentation for a SwiftLint RuleList.
See moreDeclaration
Swift
public struct RuleListDocumentation
-
The configuration struct for SwiftLint. User-defined in the
See more.swiftlint.yml
file, drives the behavior of SwiftLint.Declaration
Swift
public struct Configuration
extension Configuration: Hashable
extension Configuration: CustomStringConvertible
-
A collection of keys and values as parsed out of SourceKit, with many conveniences for accessing SwiftLint-specific values.
See moreDeclaration
Swift
public struct SourceKittenDictionary
-
A SwiftLint-interpretable command to modify SwiftLint’s behavior embedded as comments in source code.
See moreDeclaration
Swift
public struct Command : Equatable
-
Captures code and context information for an example of a triggering or non-triggering style
See moreDeclaration
Swift
public struct Example
extension Example: Hashable
extension Example: Comparable
-
Represents a file that can be linted for style violations and corrections after being collected.
See moreDeclaration
Swift
public struct Linter
-
Represents a file that can compute style violations and corrections for a list of rules.
A
See moreCollectedLinter
is only created after aLinter
has run its collection steps inLinter.collect(into:)
.Declaration
Swift
public struct CollectedLinter
-
The placement of a segment of Swift in a collection of source files.
See moreDeclaration
Swift
public struct Location : CustomStringConvertible, Comparable, Codable
-
A contiguous region of Swift source code.
See moreDeclaration
Swift
public struct Region : Equatable
-
A detailed description for a SwiftLint rule. Used for both documentation and testing purposes.
See moreDeclaration
Swift
public struct RuleDescription : Equatable
-
A list of available SwiftLint rules.
See moreDeclaration
Swift
public struct RuleList
extension RuleList: Equatable
-
A configuration parameter for rules.
See moreDeclaration
Swift
public struct RuleParameter<T> : Equatable where T : Equatable
-
A value describing an instance of Swift source code that is considered invalid by a SwiftLint rule.
See moreDeclaration
Swift
public struct StyleViolation : CustomStringConvertible, Equatable, Codable
-
Represents a Swift file’s syntax information.
See moreDeclaration
Swift
public struct SwiftLintSyntaxMap
-
A SwiftLint-aware Swift syntax token.
See moreDeclaration
Swift
public struct SwiftLintSyntaxToken
-
A value describing the version of the Swift compiler.
See moreDeclaration
Swift
public struct SwiftVersion : RawRepresentable, Codable, Comparable
-
A type describing the SwiftLint version.
See moreDeclaration
Swift
public struct Version
-
An interface for parsing YAML.
See moreDeclaration
Swift
public struct YamlParser
-
A violation produced by
See moreViolationsSyntaxVisitor
s.Declaration
Swift
public struct ReasonedRuleViolation : Comparable