Structures

The following structures are available globally.

  • User-facing documentation for a SwiftLint RuleList.

    See more

    Declaration

    Swift

    public struct RuleListDocumentation
    Show on GitHub

  • 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

  • A collection of keys and values as parsed out of SourceKit, with many conveniences for accessing SwiftLint-specific values.

    See more

    Declaration

    Swift

    public struct SourceKittenDictionary
    Show on GitHub

  • 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

  • A value describing a SwiftLint violation that was corrected.

    See more

    Declaration

    Swift

    public struct Correction : Equatable
    Show on GitHub

  • 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

  • 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

  • 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

  • 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

  • A contiguous region of Swift source code.

    See more

    Declaration

    Swift

    public struct Region : Equatable
    Show on GitHub

  • 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

  • A list of available SwiftLint rules.

    See more

    Declaration

    Swift

    public struct RuleList
    extension RuleList: Equatable
    Show on GitHub

  • A configuration parameter for rules.

    See more

    Declaration

    Swift

    public struct RuleParameter<T> : Equatable where T : Equatable
    Show on GitHub

  • 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

  • Represents a Swift file’s syntax information.

    See more

    Declaration

    Swift

    public struct SwiftLintSyntaxMap
    Show on GitHub

  • A SwiftLint-aware Swift syntax token.

    See more

    Declaration

    Swift

    public struct SwiftLintSyntaxToken
    Show on GitHub

  • A value describing the version of the Swift compiler.

    See more

    Declaration

    Swift

    public struct SwiftVersion : RawRepresentable, Codable, Comparable
    Show on GitHub

  • A type describing the SwiftLint version.

    See more

    Declaration

    Swift

    public struct Version
    Show on GitHub

YamlParser