diff --git a/Classes.html b/Classes.html index 16bafe296..648cb36e6 100644 --- a/Classes.html +++ b/Classes.html @@ -67,21 +67,24 @@ - - +
  • +
    + + + + BodyLengthRuleVisitor + +
    +
    +
    +
    +
    +
    +

    Visitor that collection violations of code block lengths.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public final class BodyLengthRuleVisitor<Parent> : ViolationsSyntaxVisitor<SeverityLevelsConfiguration<Parent>> where Parent : Rule
    + +
    +
    + +
    +
    +
  • +
  • +
    + + + + CodeBlockVisitor + +
    +
    +
    +
    +
    +
    +

    A visitor that collects style violations for all available code blocks.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    open class CodeBlockVisitor<Configuration> : ViolationsSyntaxVisitor<Configuration> where Configuration : RuleConfiguration
    + +
    +
    + +
    +
    +
  • @@ -615,8 +575,8 @@ AST nodes (e.g. a code block in a code block).

    Declaration

    Swift

    -
    open class DeclaredIdentifiersTrackingVisitor<Configuration: RuleConfiguration>:
    -        ViolationsSyntaxVisitor<Configuration>
    +
    open class DeclaredIdentifiersTrackingVisitor<Configuration: RuleConfiguration>:
    +        ViolationsSyntaxVisitor<Configuration>
    @@ -647,7 +607,7 @@ AST nodes (e.g. a code block in a code block).

    Declaration

    Swift

    -
    open class ViolationsSyntaxVisitor<Configuration> : SyntaxVisitor where Configuration : RuleConfiguration
    +
    open class ViolationsSyntaxVisitor<Configuration> : SyntaxVisitor where Configuration : RuleConfiguration
    diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/CollectedLinter.html b/Classes/BodyLengthRuleVisitor.html similarity index 64% rename from docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/CollectedLinter.html rename to Classes/BodyLengthRuleVisitor.html index cbaee620f..16c8b5639 100644 --- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/CollectedLinter.html +++ b/Classes/BodyLengthRuleVisitor.html @@ -1,7 +1,7 @@ - CollectedLinter Structure Reference + BodyLengthRuleVisitor Class Reference @@ -14,9 +14,9 @@ - + - +

    @@ -50,9 +50,9 @@

    @@ -69,21 +69,24 @@ - -
  • - - - file + + + Kind
    @@ -402,19 +360,20 @@
    -

    The file to lint with this linter.

    +

    The code block types to check.

    + See more

    Declaration

    Swift

    -
    public let file: SwiftLintFile
    +
    public enum Kind
    @@ -422,9 +381,9 @@
  • @@ -432,14 +391,14 @@
    -

    Computes or retrieves style violations.

    +

    Initializer.

    Declaration

    Swift

    -
    public func styleViolations(using storage: RuleStorage) -> [StyleViolation]
    +
    public init(kind: Kind, file: SwiftLintFile, configuration: SeverityLevelsConfiguration<Parent>)
    @@ -450,24 +409,44 @@ - storage + kind
    -

    The storage object containing all collected info.

    +

    The code block type to check. See Kind.

    +
    + + + + + + file + + + +
    +

    The file to collect violation for.

    +
    + + + + + + configuration + + + +
    +

    The configuration that defines the acceptable limits.

    -
    -

    Return Value

    -

    All style violations found by this linter.

    -
  • @@ -475,9 +454,9 @@
  • @@ -485,43 +464,18 @@
    -

    Computes or retrieves style violations and the time spent executing each rule.

    - +

    Declaration

    Swift

    -
    public func styleViolationsAndRuleTimes(using storage: RuleStorage)
    -    -> ([StyleViolation], [(id: String, time: Double)])
    +
    override public func visitPost(_ node: EnumDeclSyntax)
    -
    -

    Parameters

    - - - - - - - -
    - - storage - - -
    -

    The storage object containing all collected info.

    -
    -
    -
    -
    -

    Return Value

    -

    All style violations found by this linter, and the time spent executing each rule.

    -
    @@ -529,9 +483,9 @@
  • @@ -539,42 +493,18 @@
    -

    Applies corrections for all rules to this file, returning performed corrections.

    - +

    Declaration

    Swift

    -
    public func correct(using storage: RuleStorage) -> [Correction]
    +
    override public func visitPost(_ node: ClassDeclSyntax)
    -
    -

    Parameters

    - - - - - - - -
    - - storage - - -
    -

    The storage object containing all collected info.

    -
    -
    -
    -
    -

    Return Value

    -

    All corrections that were applied.

    -
    @@ -582,9 +512,9 @@
  • @@ -592,50 +522,134 @@
    -

    Formats the file associated with this linter.

    - +

    Declaration

    Swift

    -
    public func format(useTabs: Bool, indentWidth: Int)
    +
    override public func visitPost(_ node: StructDeclSyntax)
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - useTabs - - -
    -

    Should the file be formatted using tabs?

    -
    -
    - - indentWidth - - -
    -

    How many spaces should be used per indentation level.

    -
    -
    + +
    +
    +
  • +
  • +
    + + + + visitPost(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    override public func visitPost(_ node: ActorDeclSyntax)
    + +
    +
    +
    +
  • +
  • +
    + + + + visitPost(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    override public func visitPost(_ node: ClosureExprSyntax)
    + +
    +
    + +
    +
    +
  • +
  • +
    + + + + visitPost(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    override public func visitPost(_ node: FunctionDeclSyntax)
    + +
    +
    + +
    +
    +
  • +
  • +
    + + + + visitPost(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    override public func visitPost(_ node: InitializerDeclSyntax)
    + +
    +
    +
    diff --git a/Classes/BodyLengthRuleVisitor/Kind.html b/Classes/BodyLengthRuleVisitor/Kind.html new file mode 100644 index 000000000..993e5506d --- /dev/null +++ b/Classes/BodyLengthRuleVisitor/Kind.html @@ -0,0 +1,454 @@ + + + + Kind Enumeration Reference + + + + + + + + + + + + + + + + +
    +

    + + SwiftLintCore 0.57.1 Docs + + (100% documented) +

    + +
    +
    + +
    +
    + +

    + + GitHub + View on GitHub + +

    + +

    + + Dash + Install in Dash + +

    +
    + + + +
    + +
    + +
    +
    +

    Kind

    +
    +
    + +
    public enum Kind
    + +
    +
    +

    The code block types to check.

    + + +
    +
    + +
    +
    +
    +
      +
    • +
      + + + + closure + +
      +
      +
      +
      +
      +
      +

      Closure code blocks.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case closure
      + +
      +
      + +
      +
      +
    • +
    • +
      + + + + function + +
      +
      +
      +
      +
      +
      +

      Function body blocks.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case function
      + +
      +
      + +
      +
      +
    • +
    • +
      + + + + type + +
      +
      +
      +
      +
      +
      +

      Type (class, enum, …) member blocks.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case type
      + +
      +
      + +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + + diff --git a/Structs/Configuration.html b/Classes/CodeBlockVisitor.html similarity index 58% rename from Structs/Configuration.html rename to Classes/CodeBlockVisitor.html index dd3ed3da3..a6b66c40f 100644 --- a/Structs/Configuration.html +++ b/Classes/CodeBlockVisitor.html @@ -1,7 +1,7 @@ - Configuration Structure Reference + CodeBlockVisitor Class Reference @@ -14,9 +14,9 @@ - + - +

    @@ -50,9 +50,9 @@

    @@ -69,21 +69,24 @@ - -
    -
  • - - -
    -
    - - -
    - -

    Hashable -

    -
    -
    -
      -
    • -
      - - - - hash(into:) - -
      -
      -
      -
      -
      -
      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public func hash(into hasher: inout Hasher)
      - -
      -
      - -
      -
      -
    • -
    • -
      - - - - ==(_:_:) - -
      -
      -
      -
      -
      -
      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static func == (lhs: Configuration, rhs: Configuration) -> Bool
      - -
      -
      - -
      -
      -
    • -
    -
    -
    -
    - - -
    - -

    CustomStringConvertible -

    -
    -
    -
    diff --git a/Classes/LinterCache.html b/Classes/LinterCache.html deleted file mode 100644 index a8178ee24..000000000 --- a/Classes/LinterCache.html +++ /dev/null @@ -1,499 +0,0 @@ - - - - LinterCache Class Reference - - - - - - - - - - - - - - - - -
    -

    - - SwiftLintCore 0.57.1 Docs - - (100% documented) -

    - -
    -
    - -
    -
    - -

    - - GitHub - View on GitHub - -

    - -

    - - Dash - Install in Dash - -

    -
    - - - -
    - -
    - -
    -
    -

    LinterCache

    -
    -
    - -
    public final class LinterCache
    - -
    -
    -

    A persisted cache for storing and retrieving linter results.

    - - -
    -
    - -
    -
    -
    -
      -
    • - -
      -
      -
      -
      -
      -

      Creates a LinterCache by specifying a SwiftLint configuration and a file manager.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public init(configuration: Configuration, fileManager: some LintableFileManager = FileManager.default)
      - -
      -
      -
      -

      Parameters

      - - - - - - - - - - - -
      - - configuration - - -
      -

      The SwiftLint configuration for which this cache will be used.

      -
      -
      - - fileManager - - -
      -

      The file manager to use to read lintable file information.

      -
      -
      -
      - -
      -
      -
    • -
    • -
      - - - - save() - -
      -
      -
      -
      -
      -
      -

      Persists the cache to disk.

      -
      -

      Throws

      - Throws if the linter cache doesn’t have a location value, if the cache couldn’t be serialized, or if - the contents couldn’t be written to disk. - -
      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public func save() throws
      - -
      -
      - -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/Classes/RuleRegistry.html b/Classes/RuleRegistry.html index 2551f402a..3f37677bb 100644 --- a/Classes/RuleRegistry.html +++ b/Classes/RuleRegistry.html @@ -69,21 +69,24 @@ - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  • -
    - - - - Reporter - -
    -
    -
    -
    -
    -
    -

    An interface for reporting violations as strings.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public protocol Reporter : CustomStringConvertible
    - -
    -
    - -
    -
    -
  • diff --git a/Protocols/ASTRule.html b/Protocols/ASTRule.html index 9684e9c16..dc2312568 100644 --- a/Protocols/ASTRule.html +++ b/Protocols/ASTRule.html @@ -69,21 +69,24 @@
  • - - - - - - - - - - -
  • -
    - - - - 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
    - -
    -
    - -
    -
    -
  • @@ -631,70 +527,6 @@ non-triggering style

  • -
  • -
    - - - - Linter - -
    -
    -
    -
    -
    -
    -

    Represents a file that can be linted for style violations and corrections after being collected.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct Linter
    - -
    -
    - -
    -
    -
  • -
  • -
    - - - - 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
    - -
    -
    - -
    -
    -
  • @@ -1111,7 +943,7 @@ foo: warning: 1
    @@ -1209,81 +1041,6 @@ foo: warning: 1
  • -
  • -
    - - - - Version - -
    -
    -
    -
    -
    -
    -

    A type describing the SwiftLint version.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct Version : VersionComparable
    - -
    -
    - -
    -
    -
  • - - -
    -
    - - -
    - -

    YamlParser -

    -
    -
    -
    @@ -592,7 +552,7 @@ @@ -681,7 +641,7 @@ @@ -730,7 +690,7 @@ @@ -779,7 +739,7 @@ @@ -808,7 +768,7 @@ diff --git a/Structs/SwiftLintSyntaxMap.html b/Structs/SwiftLintSyntaxMap.html index 6afc9869f..514994d5d 100644 --- a/Structs/SwiftLintSyntaxMap.html +++ b/Structs/SwiftLintSyntaxMap.html @@ -69,21 +69,24 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
  • +
    + + + + BodyLengthRuleVisitor + +
    +
    +
    +
    +
    +
    +

    Visitor that collection violations of code block lengths.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public final class BodyLengthRuleVisitor<Parent> : ViolationsSyntaxVisitor<SeverityLevelsConfiguration<Parent>> where Parent : Rule
    + +
    +
    + +
    +
    +
  • +
  • +
    + + + + CodeBlockVisitor + +
    +
    +
    +
    +
    +
    +

    A visitor that collects style violations for all available code blocks.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    open class CodeBlockVisitor<Configuration> : ViolationsSyntaxVisitor<Configuration> where Configuration : RuleConfiguration
    + +
    +
    + +
    +
    +
  • @@ -615,8 +575,8 @@ AST nodes (e.g. a code block in a code block).

    Declaration

    Swift

    -
    open class DeclaredIdentifiersTrackingVisitor<Configuration: RuleConfiguration>:
    -        ViolationsSyntaxVisitor<Configuration>
    +
    open class DeclaredIdentifiersTrackingVisitor<Configuration: RuleConfiguration>:
    +        ViolationsSyntaxVisitor<Configuration>
    @@ -647,7 +607,7 @@ AST nodes (e.g. a code block in a code block).

    Declaration

    Swift

    -
    open class ViolationsSyntaxVisitor<Configuration> : SyntaxVisitor where Configuration : RuleConfiguration
    +
    open class ViolationsSyntaxVisitor<Configuration> : SyntaxVisitor where Configuration : RuleConfiguration
    diff --git a/Structs/CollectedLinter.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/BodyLengthRuleVisitor.html similarity index 64% rename from Structs/CollectedLinter.html rename to docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/BodyLengthRuleVisitor.html index cbaee620f..16c8b5639 100644 --- a/Structs/CollectedLinter.html +++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/BodyLengthRuleVisitor.html @@ -1,7 +1,7 @@ - CollectedLinter Structure Reference + BodyLengthRuleVisitor Class Reference @@ -14,9 +14,9 @@ - + - +

    @@ -50,9 +50,9 @@

    @@ -69,21 +69,24 @@ - -
  • - - - file + + + Kind
    @@ -402,19 +360,20 @@
    -

    The file to lint with this linter.

    +

    The code block types to check.

    + See more

    Declaration

    Swift

    -
    public let file: SwiftLintFile
    +
    public enum Kind
    @@ -422,9 +381,9 @@
  • @@ -432,14 +391,14 @@
    -

    Computes or retrieves style violations.

    +

    Initializer.

    Declaration

    Swift

    -
    public func styleViolations(using storage: RuleStorage) -> [StyleViolation]
    +
    public init(kind: Kind, file: SwiftLintFile, configuration: SeverityLevelsConfiguration<Parent>)
    @@ -450,24 +409,44 @@ - storage + kind
    -

    The storage object containing all collected info.

    +

    The code block type to check. See Kind.

    +
    + + + + + + file + + + +
    +

    The file to collect violation for.

    +
    + + + + + + configuration + + + +
    +

    The configuration that defines the acceptable limits.

    -
    -

    Return Value

    -

    All style violations found by this linter.

    -
  • @@ -475,9 +454,9 @@
  • @@ -485,43 +464,18 @@
    -

    Computes or retrieves style violations and the time spent executing each rule.

    - +

    Declaration

    Swift

    -
    public func styleViolationsAndRuleTimes(using storage: RuleStorage)
    -    -> ([StyleViolation], [(id: String, time: Double)])
    +
    override public func visitPost(_ node: EnumDeclSyntax)
    -
    -

    Parameters

    - - - - - - - -
    - - storage - - -
    -

    The storage object containing all collected info.

    -
    -
    -
    -
    -

    Return Value

    -

    All style violations found by this linter, and the time spent executing each rule.

    -
    @@ -529,9 +483,9 @@
  • @@ -539,42 +493,18 @@
    -

    Applies corrections for all rules to this file, returning performed corrections.

    - +

    Declaration

    Swift

    -
    public func correct(using storage: RuleStorage) -> [Correction]
    +
    override public func visitPost(_ node: ClassDeclSyntax)
    -
    -

    Parameters

    - - - - - - - -
    - - storage - - -
    -

    The storage object containing all collected info.

    -
    -
    -
    -
    -

    Return Value

    -

    All corrections that were applied.

    -
    @@ -582,9 +512,9 @@
  • @@ -592,50 +522,134 @@
    -

    Formats the file associated with this linter.

    - +

    Declaration

    Swift

    -
    public func format(useTabs: Bool, indentWidth: Int)
    +
    override public func visitPost(_ node: StructDeclSyntax)
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - useTabs - - -
    -

    Should the file be formatted using tabs?

    -
    -
    - - indentWidth - - -
    -

    How many spaces should be used per indentation level.

    -
    -
    + +
    +
    +
  • +
  • +
    + + + + visitPost(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    override public func visitPost(_ node: ActorDeclSyntax)
    + +
    +
    +
    +
  • +
  • +
    + + + + visitPost(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    override public func visitPost(_ node: ClosureExprSyntax)
    + +
    +
    + +
    +
    +
  • +
  • +
    + + + + visitPost(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    override public func visitPost(_ node: FunctionDeclSyntax)
    + +
    +
    + +
    +
    +
  • +
  • +
    + + + + visitPost(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    override public func visitPost(_ node: InitializerDeclSyntax)
    + +
    +
    +
    diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/BodyLengthRuleVisitor/Kind.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/BodyLengthRuleVisitor/Kind.html new file mode 100644 index 000000000..993e5506d --- /dev/null +++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/BodyLengthRuleVisitor/Kind.html @@ -0,0 +1,454 @@ + + + + Kind Enumeration Reference + + + + + + + + + + + + + + + + +
    +

    + + SwiftLintCore 0.57.1 Docs + + (100% documented) +

    + +
    +
    + +
    +
    + +

    + + GitHub + View on GitHub + +

    + +

    + + Dash + Install in Dash + +

    +
    + + + +
    + +
    + +
    +
    +

    Kind

    +
    +
    + +
    public enum Kind
    + +
    +
    +

    The code block types to check.

    + + +
    +
    + +
    +
    +
    +
      +
    • +
      + + + + closure + +
      +
      +
      +
      +
      +
      +

      Closure code blocks.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case closure
      + +
      +
      + +
      +
      +
    • +
    • +
      + + + + function + +
      +
      +
      +
      +
      +
      +

      Function body blocks.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case function
      + +
      +
      + +
      +
      +
    • +
    • +
      + + + + type + +
      +
      +
      +
      +
      +
      +

      Type (class, enum, …) member blocks.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case type
      + +
      +
      + +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + + diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Configuration.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/CodeBlockVisitor.html similarity index 58% rename from docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Configuration.html rename to docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/CodeBlockVisitor.html index dd3ed3da3..a6b66c40f 100644 --- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Configuration.html +++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/CodeBlockVisitor.html @@ -1,7 +1,7 @@ - Configuration Structure Reference + CodeBlockVisitor Class Reference @@ -14,9 +14,9 @@ - + - +

    @@ -50,9 +50,9 @@

    @@ -69,21 +69,24 @@ - -
    -
  • - - -
    -
    - - -
    - -

    Hashable -

    -
    -
    -
      -
    • -
      - - - - hash(into:) - -
      -
      -
      -
      -
      -
      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public func hash(into hasher: inout Hasher)
      - -
      -
      - -
      -
      -
    • -
    • -
      - - - - ==(_:_:) - -
      -
      -
      -
      -
      -
      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static func == (lhs: Configuration, rhs: Configuration) -> Bool
      - -
      -
      - -
      -
      -
    • -
    -
    -
    -
    - - -
    - -

    CustomStringConvertible -

    -
    -
    -
    diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/LinterCache.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/LinterCache.html deleted file mode 100644 index a8178ee24..000000000 --- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/LinterCache.html +++ /dev/null @@ -1,499 +0,0 @@ - - - - LinterCache Class Reference - - - - - - - - - - - - - - - - -
    -

    - - SwiftLintCore 0.57.1 Docs - - (100% documented) -

    - -
    -
    - -
    -
    - -

    - - GitHub - View on GitHub - -

    - -

    - - Dash - Install in Dash - -

    -
    - - - -
    - -
    - -
    -
    -

    LinterCache

    -
    -
    - -
    public final class LinterCache
    - -
    -
    -

    A persisted cache for storing and retrieving linter results.

    - - -
    -
    - -
    -
    -
    -
      -
    • - -
      -
      -
      -
      -
      -

      Creates a LinterCache by specifying a SwiftLint configuration and a file manager.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public init(configuration: Configuration, fileManager: some LintableFileManager = FileManager.default)
      - -
      -
      -
      -

      Parameters

      - - - - - - - - - - - -
      - - configuration - - -
      -

      The SwiftLint configuration for which this cache will be used.

      -
      -
      - - fileManager - - -
      -

      The file manager to use to read lintable file information.

      -
      -
      -
      - -
      -
      -
    • -
    • -
      - - - - save() - -
      -
      -
      -
      -
      -
      -

      Persists the cache to disk.

      -
      -

      Throws

      - Throws if the linter cache doesn’t have a location value, if the cache couldn’t be serialized, or if - the contents couldn’t be written to disk. - -
      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public func save() throws
      - -
      -
      - -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/RuleRegistry.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/RuleRegistry.html index 2551f402a..3f37677bb 100644 --- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/RuleRegistry.html +++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/RuleRegistry.html @@ -69,21 +69,24 @@ - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  • -
    - - - - Reporter - -
    -
    -
    -
    -
    -
    -

    An interface for reporting violations as strings.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public protocol Reporter : CustomStringConvertible
    - -
    -
    - -
    -
    -
  • diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Protocols/ASTRule.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Protocols/ASTRule.html index 9684e9c16..dc2312568 100644 --- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Protocols/ASTRule.html +++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Protocols/ASTRule.html @@ -69,21 +69,24 @@
  • - - - - - - - - - - -
  • -
    - - - - 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
    - -
    -
    - -
    -
    -
  • @@ -631,70 +527,6 @@ non-triggering style

  • -
  • -
    - - - - Linter - -
    -
    -
    -
    -
    -
    -

    Represents a file that can be linted for style violations and corrections after being collected.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct Linter
    - -
    -
    - -
    -
    -
  • -
  • -
    - - - - 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
    - -
    -
    - -
    -
    -
  • @@ -1111,7 +943,7 @@ foo: warning: 1
    @@ -1209,81 +1041,6 @@ foo: warning: 1
  • -
  • -
    - - - - Version - -
    -
    -
    -
    -
    -
    -

    A type describing the SwiftLint version.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct Version : VersionComparable
    - -
    -
    - -
    -
    -
  • - - -
    -
    - - -
    - -

    YamlParser -

    -
    -
    -
    @@ -592,7 +552,7 @@ @@ -681,7 +641,7 @@ @@ -730,7 +690,7 @@ @@ -779,7 +739,7 @@ @@ -808,7 +768,7 @@ diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/SwiftLintSyntaxMap.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/SwiftLintSyntaxMap.html index 6afc9869f..514994d5d 100644 --- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/SwiftLintSyntaxMap.html +++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/SwiftLintSyntaxMap.html @@ -69,21 +69,24 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -