diff --git a/Classes.html b/Classes.html index a4340b41a0..15c3dd71a6 100644 --- a/Classes.html +++ b/Classes.html @@ -418,7 +418,7 @@
Swift
-public final class SwiftLintFile
+ public final class SwiftLintFile : Sendable
extension SwiftLintFile: Equatable, Hashable
public final class SwiftLintFile
+ public final class SwiftLintFile : Sendable
extension SwiftLintFile: Equatable, Hashable
Swift
-public private(set) var isTestFile: Bool { get }
+ public let isTestFile: Bool
Swift
-public private(set) var isVirtual: Bool { get }
+ public let isVirtual: Bool
-
-
- init(file:)
+
+
+ init(file:isTestFile:isVirtual:)
Swift
-public init(file: File)
+ public init(file: File, isTestFile: Bool = false, isVirtual: Bool = false)
+ isTestFile
+
+ Mark the file as being generated for testing purposes only.
+
+ isVirtual
+
+ Mark the file as virtual (in-memory).
+
-
-
- init(path:)
+
+
+ init(path:isTestFile:)
Swift
-public convenience init?(path: String)
+ public convenience init?(path: String, isTestFile: Bool = false)
+ isTestFile
+
+ Mark the file as being generated for testing purposes only.
+
-
-
- init(contents:)
+
+
+ init(contents:isTestFile:)
Swift
-public convenience init(contents: String)
+ public convenience init(contents: String, isTestFile: Bool = false)
+ isTestFile
+
+ Mark the file as being generated for testing purposes only.
+Swift
-public enum OptionType : Equatable
+ public enum OptionType : Equatable, Sendable
extension OptionType: Documentable
Swift
-public enum RuleIdentifier : Hashable, ExpressibleByStringLiteral, Comparable
+ public enum RuleIdentifier : Hashable, ExpressibleByStringLiteral, Comparable, Sendable
Swift
-public enum ViolationSeverity : String, Comparable, Codable, InlinableOptionType
+ public enum ViolationSeverity : String, Comparable, Codable, Sendable, InlinableOptionType
All possible SwiftLint issues which are printed as warnings by default.
@@ -1123,7 +1123,7 @@public enum OptionType : Equatable
+ public enum OptionType : Equatable, Sendable
extension OptionType: Documentable
public enum RuleIdentifier : Hashable, ExpressibleByStringLiteral, Comparable
+ public enum RuleIdentifier : Hashable, ExpressibleByStringLiteral, Comparable, Sendable
public enum ViolationSeverity : String, Comparable, Codable, InlinableOptionType
+ public enum ViolationSeverity : String, Comparable, Codable, Sendable, InlinableOptionType
Swift
-public struct ChildOptionSeverityConfiguration<Parent> : RuleConfiguration, AcceptableByConfigurationElement where Parent : Rule
+ public struct ChildOptionSeverityConfiguration<Parent: Rule>: RuleConfiguration,
+ AcceptableByConfigurationElement,
+ Sendable
Swift
-public struct Region : Equatable
+ public struct Region : Equatable, Sendable
Swift
-public struct RuleConfigurationDescription : Equatable
+ public struct RuleConfigurationDescription : Equatable, Sendable
extension RuleConfigurationDescription: Documentable
Swift
-public struct RuleConfigurationOption : Equatable
+ public struct RuleConfigurationOption : Equatable, Sendable
extension RuleConfigurationOption: Documentable
Swift
@propertyWrapper
-public struct ConfigurationElement<T> : Equatable where T : Equatable, T : AcceptableByConfigurationElement
+public struct ConfigurationElement<T> : Equatable, Sendable where T : Equatable, T : Sendable, T : AcceptableByConfigurationElement
Swift
-public struct SeverityConfiguration<Parent> : SeverityBasedRuleConfiguration, InlinableOptionType where Parent : Rule
+ public struct SeverityConfiguration<Parent> : SeverityBasedRuleConfiguration, InlinableOptionType, Sendable where Parent : Rule
Swift
-public struct SeverityLevelsConfiguration<Parent> : RuleConfiguration, InlinableOptionType where Parent : Rule
+ public struct SeverityLevelsConfiguration<Parent> : RuleConfiguration, InlinableOptionType, Sendable where Parent : Rule
public struct ChildOptionSeverityConfiguration<Parent> : RuleConfiguration, AcceptableByConfigurationElement where Parent : Rule
+ public struct ChildOptionSeverityConfiguration<Parent: Rule>: RuleConfiguration,
+ AcceptableByConfigurationElement,
+ Sendable
@propertyWrapper
-public struct ConfigurationElement<T> : Equatable where T : Equatable, T : AcceptableByConfigurationElement
+public struct ConfigurationElement<T> : Equatable, Sendable where T : Equatable, T : Sendable, T : AcceptableByConfigurationElement
Swift
-public enum DeprecationNotice
+ public enum DeprecationNotice : Sendable
-
+
- init(wrappedValue:key:deprecationNotice:postprocessor:)
+ init(wrappedValue:key:deprecationNotice:postprocessor:)
public init(wrappedValue value: T,
key: String,
deprecationNotice: DeprecationNotice? = nil,
- postprocessor: @escaping (inout T) -> Void = { _ in })
+ postprocessor: @escaping @Sendable (inout T) -> Void = { _ in })
-
+
- init(key:)
+ init(key:)
Swift
-public init<Wrapped>(key: String) where T == Wrapped?, Wrapped : Equatable, Wrapped : AcceptableByConfigurationElement
+ public init<Wrapped>(key: String) where T == Wrapped?, Wrapped : Equatable, Wrapped : Sendable, Wrapped : AcceptableByConfigurationElement
public enum DeprecationNotice
+ public enum DeprecationNotice : Sendable
public struct Region : Equatable
+ public struct Region : Equatable, Sendable
public struct RuleConfigurationDescription : Equatable
+ public struct RuleConfigurationDescription : Equatable, Sendable
extension RuleConfigurationDescription: Documentable
public struct RuleConfigurationOption : Equatable
+ public struct RuleConfigurationOption : Equatable, Sendable
extension RuleConfigurationOption: Documentable
public struct SeverityConfiguration<Parent> : SeverityBasedRuleConfiguration, InlinableOptionType where Parent : Rule
+ public struct SeverityConfiguration<Parent> : SeverityBasedRuleConfiguration, InlinableOptionType, Sendable where Parent : Rule
public struct SeverityLevelsConfiguration<Parent> : RuleConfiguration, InlinableOptionType where Parent : Rule
+ public struct SeverityLevelsConfiguration<Parent> : RuleConfiguration, InlinableOptionType, Sendable where Parent : Rule
Swift
-public final class SwiftLintFile
+ public final class SwiftLintFile : Sendable
extension SwiftLintFile: Equatable, Hashable
public final class SwiftLintFile
+ public final class SwiftLintFile : Sendable
extension SwiftLintFile: Equatable, Hashable
Swift
-public private(set) var isTestFile: Bool { get }
+ public let isTestFile: Bool
Swift
-public private(set) var isVirtual: Bool { get }
+ public let isVirtual: Bool
-
-
- init(file:)
+
+
+ init(file:isTestFile:isVirtual:)
Swift
-public init(file: File)
+ public init(file: File, isTestFile: Bool = false, isVirtual: Bool = false)
+ isTestFile
+
+ Mark the file as being generated for testing purposes only.
+
+ isVirtual
+
+ Mark the file as virtual (in-memory).
+
-
-
- init(path:)
+
+
+ init(path:isTestFile:)
Swift
-public convenience init?(path: String)
+ public convenience init?(path: String, isTestFile: Bool = false)
+ isTestFile
+
+ Mark the file as being generated for testing purposes only.
+
-
-
- init(contents:)
+
+
+ init(contents:isTestFile:)
Swift
-public convenience init(contents: String)
+ public convenience init(contents: String, isTestFile: Bool = false)
+ isTestFile
+
+ Mark the file as being generated for testing purposes only.
+Swift
-public enum OptionType : Equatable
+ public enum OptionType : Equatable, Sendable
extension OptionType: Documentable
Swift
-public enum RuleIdentifier : Hashable, ExpressibleByStringLiteral, Comparable
+ public enum RuleIdentifier : Hashable, ExpressibleByStringLiteral, Comparable, Sendable
Swift
-public enum ViolationSeverity : String, Comparable, Codable, InlinableOptionType
+ public enum ViolationSeverity : String, Comparable, Codable, Sendable, InlinableOptionType
All possible SwiftLint issues which are printed as warnings by default.
@@ -1123,7 +1123,7 @@public enum OptionType : Equatable
+ public enum OptionType : Equatable, Sendable
extension OptionType: Documentable
public enum RuleIdentifier : Hashable, ExpressibleByStringLiteral, Comparable
+ public enum RuleIdentifier : Hashable, ExpressibleByStringLiteral, Comparable, Sendable
public enum ViolationSeverity : String, Comparable, Codable, InlinableOptionType
+ public enum ViolationSeverity : String, Comparable, Codable, Sendable, InlinableOptionType
Swift
-public struct ChildOptionSeverityConfiguration<Parent> : RuleConfiguration, AcceptableByConfigurationElement where Parent : Rule
+ public struct ChildOptionSeverityConfiguration<Parent: Rule>: RuleConfiguration,
+ AcceptableByConfigurationElement,
+ Sendable
Swift
-public struct Region : Equatable
+ public struct Region : Equatable, Sendable
Swift
-public struct RuleConfigurationDescription : Equatable
+ public struct RuleConfigurationDescription : Equatable, Sendable
extension RuleConfigurationDescription: Documentable
Swift
-public struct RuleConfigurationOption : Equatable
+ public struct RuleConfigurationOption : Equatable, Sendable
extension RuleConfigurationOption: Documentable
Swift
@propertyWrapper
-public struct ConfigurationElement<T> : Equatable where T : Equatable, T : AcceptableByConfigurationElement
+public struct ConfigurationElement<T> : Equatable, Sendable where T : Equatable, T : Sendable, T : AcceptableByConfigurationElement
Swift
-public struct SeverityConfiguration<Parent> : SeverityBasedRuleConfiguration, InlinableOptionType where Parent : Rule
+ public struct SeverityConfiguration<Parent> : SeverityBasedRuleConfiguration, InlinableOptionType, Sendable where Parent : Rule
Swift
-public struct SeverityLevelsConfiguration<Parent> : RuleConfiguration, InlinableOptionType where Parent : Rule
+ public struct SeverityLevelsConfiguration<Parent> : RuleConfiguration, InlinableOptionType, Sendable where Parent : Rule
public struct ChildOptionSeverityConfiguration<Parent> : RuleConfiguration, AcceptableByConfigurationElement where Parent : Rule
+ public struct ChildOptionSeverityConfiguration<Parent: Rule>: RuleConfiguration,
+ AcceptableByConfigurationElement,
+ Sendable
@propertyWrapper
-public struct ConfigurationElement<T> : Equatable where T : Equatable, T : AcceptableByConfigurationElement
+public struct ConfigurationElement<T> : Equatable, Sendable where T : Equatable, T : Sendable, T : AcceptableByConfigurationElement
Swift
-public enum DeprecationNotice
+ public enum DeprecationNotice : Sendable
-
+
- init(wrappedValue:key:deprecationNotice:postprocessor:)
+ init(wrappedValue:key:deprecationNotice:postprocessor:)
public init(wrappedValue value: T,
key: String,
deprecationNotice: DeprecationNotice? = nil,
- postprocessor: @escaping (inout T) -> Void = { _ in })
+ postprocessor: @escaping @Sendable (inout T) -> Void = { _ in })
-
+
- init(key:)
+ init(key:)
Swift
-public init<Wrapped>(key: String) where T == Wrapped?, Wrapped : Equatable, Wrapped : AcceptableByConfigurationElement
+ public init<Wrapped>(key: String) where T == Wrapped?, Wrapped : Equatable, Wrapped : Sendable, Wrapped : AcceptableByConfigurationElement
public enum DeprecationNotice
+ public enum DeprecationNotice : Sendable
public struct Region : Equatable
+ public struct Region : Equatable, Sendable
public struct RuleConfigurationDescription : Equatable
+ public struct RuleConfigurationDescription : Equatable, Sendable
extension RuleConfigurationDescription: Documentable
public struct RuleConfigurationOption : Equatable
+ public struct RuleConfigurationOption : Equatable, Sendable
extension RuleConfigurationOption: Documentable
public struct SeverityConfiguration<Parent> : SeverityBasedRuleConfiguration, InlinableOptionType where Parent : Rule
+ public struct SeverityConfiguration<Parent> : SeverityBasedRuleConfiguration, InlinableOptionType, Sendable where Parent : Rule
public struct SeverityLevelsConfiguration<Parent> : RuleConfiguration, InlinableOptionType where Parent : Rule
+ public struct SeverityLevelsConfiguration<Parent> : RuleConfiguration, InlinableOptionType, Sendable where Parent : Rule
Macro to be attached to rule configurations. It generates the configuration parsing logic"},"Macros.html#/s:13SwiftLintCore32AcceptableByConfigurationElementyycfm":{"name":"AcceptableByConfigurationElement()","abstract":"
Macro that lets an enum with a String
raw type automatically conform to AcceptableByConfigurationElement
.
Macro that adds a conformance to the SwiftSyntaxRule
protocol and a default makeVisitor(file:)
implementation"},"Structs/SeverityLevelsConfiguration.html#/s:13SwiftLintCore27SeverityLevelsConfigurationV7warningSivp":{"name":"warning","abstract":"
The threshold for a violation to be a warning.
","parent_name":"SeverityLevelsConfiguration"},"Structs/SeverityLevelsConfiguration.html#/s:13SwiftLintCore27SeverityLevelsConfigurationV5errorSiSgvp":{"name":"error","abstract":"The threshold for a violation to be an error.
","parent_name":"SeverityLevelsConfiguration"},"Structs/SeverityLevelsConfiguration.html#/s:13SwiftLintCore27SeverityLevelsConfigurationV7warning5errorACyxGSi_SiSgtcfc":{"name":"init(warning:error:)","abstract":"Create a SeverityLevelsConfiguration
based on the specified warning
and error
thresholds.
The rule parameters that define the thresholds that should map to each severity.
","parent_name":"SeverityLevelsConfiguration"},"Structs/SeverityLevelsConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP5apply13configurationyyp_tKF":{"name":"apply(configuration:)","parent_name":"SeverityLevelsConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV10identifierSSvp":{"name":"identifier","abstract":"The identifier for this custom rule.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV4nameSSSgvp":{"name":"name","abstract":"The name for this custom rule.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV7messageSSvp":{"name":"message","abstract":"The message to be presented when producing violations.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV8includedSaySo19NSRegularExpressionCGvp":{"name":"included","abstract":"Regular expressions to include when matching the file path.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV8excludedSaySo19NSRegularExpressionCGvp":{"name":"excluded","abstract":"Regular expressions to exclude when matching the file path.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV18excludedMatchKindsShy21SourceKittenFramework10SyntaxKindOGvp":{"name":"excludedMatchKinds","abstract":"The syntax kinds to exclude from matches. If the regex matched syntax kinds from this list, it would","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore30SeverityBasedRuleConfigurationP08severityG0AA0dG0Vy6ParentQzGvp":{"name":"severityConfiguration","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV12captureGroupSivp":{"name":"captureGroup","abstract":"
The index of the regex capture group to match.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore24CacheDescriptionProviderP05cacheE0SSvp":{"name":"cacheDescription","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV11descriptionAA15RuleDescriptionVvp":{"name":"description","abstract":"The RuleDescription
for the custom rule defined here.
Create a RegexConfiguration
with the specified identifier, with other properties to be set later.
Create a ViolationCorrection
.
The correction of a violation that is basically the violation’s range in the source code and a","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV8position0A6Syntax16AbsolutePositionVvp":{"name":"position","abstract":"
The violation’s position.
","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV6reasonSSSgvp":{"name":"reason","abstract":"A specific reason for the violation.
","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV8severityAA0F8SeverityOSgvp":{"name":"severity","abstract":"The violation’s severity.
","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV10correctionAC0F10CorrectionVSgvp":{"name":"correction","abstract":"An optional correction of the violation to be used in rewriting (see SwiftSyntaxCorrectableRule
). Can be","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV8position6reason8severity10correctionAC0A6Syntax16AbsolutePositionV_SSSgAA0F8SeverityOSgAC0F10CorrectionVSgtcfc":{"name":"init(position:reason:severity:correction:)","abstract":"
Creates a ReasonedRuleViolation
.
Swift 5
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV10fiveDotOneACvpZ":{"name":"fiveDotOne","abstract":"Swift 5.1
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV10fiveDotTwoACvpZ":{"name":"fiveDotTwo","abstract":"Swift 5.2
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV12fiveDotThreeACvpZ":{"name":"fiveDotThree","abstract":"Swift 5.3
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV11fiveDotFourACvpZ":{"name":"fiveDotFour","abstract":"Swift 5.4
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV11fiveDotFiveACvpZ":{"name":"fiveDotFive","abstract":"Swift 5.5
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV10fiveDotSixACvpZ":{"name":"fiveDotSix","abstract":"Swift 5.6
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV12fiveDotSevenACvpZ":{"name":"fiveDotSeven","abstract":"Swift 5.7
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV12fiveDotEightACvpZ":{"name":"fiveDotEight","abstract":"Swift 5.8
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV11fiveDotNineACvpZ":{"name":"fiveDotNine","abstract":"Swift 5.9
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV3sixACvpZ":{"name":"six","abstract":"Swift 6
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV7currentACvpZ":{"name":"current","abstract":"The current detected Swift compiler version, based on the currently accessible SourceKit version.
","parent_name":"SwiftVersion"},"Structs/SwiftLintSyntaxToken.html#/s:13SwiftLintCore0aB11SyntaxTokenV5value21SourceKittenFramework0dE0Vvp":{"name":"value","abstract":"The raw SyntaxToken
obtained by SourceKitten.
The syntax kind associated with is token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:13SwiftLintCore0aB11SyntaxTokenV5valueAC21SourceKittenFramework0dE0V_tcfc":{"name":"init(value:)","abstract":"Creates a SwiftLintSyntaxToken
from the raw SyntaxToken
obtained by SourceKitten.
The byte range in a source file for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:13SwiftLintCore0aB11SyntaxTokenV6offset21SourceKittenFramework9ByteCountVvp":{"name":"offset","abstract":"The starting byte offset in a source file for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:13SwiftLintCore0aB11SyntaxTokenV6length21SourceKittenFramework9ByteCountVvp":{"name":"length","abstract":"The length in bytes for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxMap.html#/s:13SwiftLintCore0aB9SyntaxMapV5value21SourceKittenFramework0dE0Vvp":{"name":"value","abstract":"The raw SyntaxMap
obtained by SourceKitten.
The SwiftLint-specific syntax tokens for this syntax map.
","parent_name":"SwiftLintSyntaxMap"},"Structs/SwiftLintSyntaxMap.html#/s:13SwiftLintCore0aB9SyntaxMapV5valueAC21SourceKittenFramework0dE0V_tcfc":{"name":"init(value:)","abstract":"Creates a SwiftLintSyntaxMap
from the raw SyntaxMap
obtained by SourceKitten.
Returns array of syntax tokens intersecting with byte range.
","parent_name":"SwiftLintSyntaxMap"},"Structs/SwiftLintSyntaxMap.html#/s:13SwiftLintCore0aB9SyntaxMapV5kinds11inByteRangeSay21SourceKittenFramework0D4KindOGAF0hI0V_tF":{"name":"kinds(inByteRange:)","abstract":"Returns the syntax kinds in the specified byte range.
","parent_name":"SwiftLintSyntaxMap"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV14ruleIdentifierSSvp":{"name":"ruleIdentifier","abstract":"The identifier of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV15ruleDescriptionSSvp":{"name":"ruleDescription","abstract":"The description of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV8ruleNameSSvp":{"name":"ruleName","abstract":"The name of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV8severityAA0E8SeverityOvp":{"name":"severity","abstract":"The severity of this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV8locationAA8LocationVvp":{"name":"location","abstract":"The location of this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV6reasonSSvp":{"name":"reason","abstract":"The justification for this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV11descriptionSSvp":{"name":"description","abstract":"A printable description for this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV15ruleDescription8severity8location6reasonAcA04RuleG0V_AA0E8SeverityOAA8LocationVSSSgtcfc":{"name":"init(ruleDescription:severity:location:reason:)","abstract":"Creates a StyleViolation
by specifying its properties directly.
Returns the same violation, but with the severity
that is passed in
Returns the same violation, but with the location
that is passed in
The severity that should be assigned to the violation of this parameter’s value is met.
","parent_name":"RuleParameter"},"Structs/RuleParameter.html#/s:13SwiftLintCore13RuleParameterV5valuexvp":{"name":"value","abstract":"The value to configure the rule.
","parent_name":"RuleParameter"},"Structs/RuleParameter.html#/s:13SwiftLintCore13RuleParameterV8severity5valueACyxGAA17ViolationSeverityO_xtcfc":{"name":"init(severity:value:)","abstract":"Creates a RuleParameter
by specifying its properties directly.
The rules contained in this list.
","parent_name":"RuleList"},"Structs/RuleList.html#/s:13SwiftLintCore8RuleListV5rulesAcA0D0_pXpd_tcfc":{"name":"init(rules:)","abstract":"Creates a RuleList
by specifying all its rules.
Creates a RuleList
by specifying all its rules.
The rule’s unique identifier, to be used in configuration files and SwiftLint commands.","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV4nameSSvp":{"name":"name","abstract":"
The rule’s human-readable name. Should be short, descriptive and formatted in Title Case. May contain spaces.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV11descriptionSSvp":{"name":"description","abstract":"The rule’s verbose description. Should read as a sentence or short paragraph. Good things to include are an","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV4kindAA0D4KindOvp":{"name":"kind","abstract":"
The RuleKind
that best categorizes this rule.
Swift source examples that do not trigger a violation for this rule. Used for documentation purposes to inform","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV18triggeringExamplesSayAA7ExampleVGvp":{"name":"triggeringExamples","abstract":"
Swift source examples that do trigger one or more violations for this rule. Used for documentation purposes to","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV11correctionsSDyAA7ExampleVAFGvp":{"name":"corrections","abstract":"
Pairs of Swift source examples, where keys are examples that trigger violations for this rule, and the values","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV17deprecatedAliasesShySSGvp":{"name":"deprecatedAliases","abstract":"
Any previous iteration of the rule’s identifier that was previously shipped with SwiftLint.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV03minA7VersionAA0aG0Vvp":{"name":"minSwiftVersion","abstract":"The oldest version of the Swift compiler supported by this rule.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV18requiresFileOnDiskSbvp":{"name":"requiresFileOnDisk","abstract":"Whether or not this rule can only be executed on a file physically on-disk. Typically necessary for rules","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV07consoleE0SSvp":{"name":"consoleDescription","abstract":"
The console-printable string for this description.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV14allIdentifiersSaySSGvp":{"name":"allIdentifiers","abstract":"All identifiers that have been used to uniquely identify this rule in past and current SwiftLint versions.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV10identifier4name11description4kind03minA7Version21nonTriggeringExamples010triggeringN011corrections17deprecatedAliases18requiresFileOnDiskACSS_S2SAA0D4KindOAA0aK0VSayAA7ExampleVGATSDyA2SGShySSGSbtcfc":{"name":"init(identifier:name:description:kind:minSwiftVersion:nonTriggeringExamples:triggeringExamples:corrections:deprecatedAliases:requiresFileOnDisk:)","abstract":"Creates a RuleDescription
by specifying all its properties directly.
Configuration with a warning severity.
","parent_name":"SeverityConfiguration"},"Structs/SeverityConfiguration.html#/s:13SwiftLintCore21SeverityConfigurationV7warningACyxGvpZ":{"name":"warning","abstract":"Configuration with an error severity.
","parent_name":"SeverityConfiguration"},"Structs/SeverityConfiguration.html#/s:13SwiftLintCore30SeverityBasedRuleConfigurationP08severityG0AA0dG0Vy6ParentQzGvp":{"name":"severityConfiguration","parent_name":"SeverityConfiguration"},"Structs/SeverityConfiguration.html#/s:13SwiftLintCore21SeverityConfigurationVyACyxGAA09ViolationD0Ocfc":{"name":"init(_:)","abstract":"Create a SeverityConfiguration
with the specified severity.
Severity configurations are special in that they shall not be nested when an option name is provided.","parent_name":"SeverityConfiguration"},"Structs/ConfigurationElement/DeprecationNotice.html#/s:13SwiftLintCore20ConfigurationElementV17DeprecationNoticeO18suggestAlternativeyAEyx_GSS_SStcAGmSQRzAA012AcceptableBydE0RzlF":{"name":"suggestAlternative(ruleID:name:)","abstract":"
Warning suggesting an alternative option.
","parent_name":"DeprecationNotice"},"Structs/ConfigurationElement/DeprecationNotice.html":{"name":"DeprecationNotice","abstract":"A deprecation notice.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV12wrappedValuexvp":{"name":"wrappedValue","abstract":"Wrapped option value.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV14projectedValueACyxGvp":{"name":"projectedValue","abstract":"The wrapper itself providing access to all its data. This field can only be accessed by the","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV3keySSvp":{"name":"key","abstract":"
Name of this configuration entry.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV6inlineSbvp":{"name":"inline","abstract":"Whether this configuration element will be inlined into its description.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV12wrappedValue3key17deprecationNotice13postprocessorACyxGx_SSAC011DeprecationJ0Oyx_GSgyxzctcfc":{"name":"init(wrappedValue:key:deprecationNotice:postprocessor:)","abstract":"Default constructor.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV3keyACyqd__SgGSS_tcAERszSQRd__AA012AcceptableBydE0Rd__lufc":{"name":"init(key:)","abstract":"Constructor for optional values.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV12wrappedValue6inlineACyxGx_SbtcAA19InlinableOptionTypeRzrlufc":{"name":"init(wrappedValue:inline:)","abstract":"Constructor for an InlinableOptionType
without a key.
Constructor for an InlinableOptionType
with a name. The configuration will explicitly not be inlined.
An option serving as a marker for an empty configuration description.
","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationOption.html#/s:13SwiftLintCore12DocumentableP10hasContentSbvp":{"name":"hasContent","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationOption.html#/s:13SwiftLintCore12DocumentableP8markdownSSyF":{"name":"markdown()","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationOption.html#/s:13SwiftLintCore12DocumentableP8oneLinerSSyF":{"name":"oneLiner()","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationOption.html#/s:13SwiftLintCore12DocumentableP4yamlSSyF":{"name":"yaml()","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationDescription.html#/s:13SwiftLintCore12DocumentableP10hasContentSbvp":{"name":"hasContent","parent_name":"RuleConfigurationDescription"},"Structs/RuleConfigurationDescription.html#/s:13SwiftLintCore12DocumentableP8oneLinerSSyF":{"name":"oneLiner()","parent_name":"RuleConfigurationDescription"},"Structs/RuleConfigurationDescription.html#/s:13SwiftLintCore12DocumentableP8markdownSSyF":{"name":"markdown()","parent_name":"RuleConfigurationDescription"},"Structs/RuleConfigurationDescription.html#/s:13SwiftLintCore12DocumentableP4yamlSSyF":{"name":"yaml()","parent_name":"RuleConfigurationDescription"},"Structs/Region.html#/s:13SwiftLintCore6RegionV5startAA8LocationVvp":{"name":"start","abstract":"The location describing the start of the region. All locations that are less than this value","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV3endAA8LocationVvp":{"name":"end","abstract":"
The location describing the end of the region. All locations that are greater than this value","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV23disabledRuleIdentifiersShyAA0F10IdentifierOGvp":{"name":"disabledRuleIdentifiers","abstract":"
All SwiftLint rule identifiers that are disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV5start3end23disabledRuleIdentifiersAcA8LocationV_AHShyAA0H10IdentifierOGtcfc":{"name":"init(start:end:disabledRuleIdentifiers:)","abstract":"Creates a Region by setting explicit values for all its properties.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV8containsySbAA8LocationVF":{"name":"contains(_:)","abstract":"Whether the specific location is contained in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV13isRuleEnabledySbxAA0F0RzlF":{"name":"isRuleEnabled(_:)","abstract":"Whether the specified rule is enabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV14isRuleDisabledySbxAA0F0RzlF":{"name":"isRuleDisabled(_:)","abstract":"Whether the specified rule is disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV16areRulesDisabled7ruleIDsSbSaySSG_tF":{"name":"areRulesDisabled(ruleIDs:)","abstract":"Whether the given rules are disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV26deprecatedAliasesDisabling4ruleShySSGx_tAA4RuleRzlF":{"name":"deprecatedAliasesDisabling(rule:)","abstract":"Returns the deprecated rule aliases that are disabling the specified rule in this region.","parent_name":"Region"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4fileSSSgvp":{"name":"file","abstract":"
The file path on disk for this location.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4lineSiSgvp":{"name":"line","abstract":"The line offset in the file for this location. 1-indexed.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV9characterSiSgvp":{"name":"character","abstract":"The character offset in the file for this location. 1-indexed.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV11descriptionSSvp":{"name":"description","abstract":"A lossless printable description of this location.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV12relativeFileSSSgvp":{"name":"relativeFile","abstract":"The file path for this location relative to the current working directory.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4file4line9characterACSSSg_SiSgAHtcfc":{"name":"init(file:line:character:)","abstract":"Creates a Location
by specifying its properties directly.
Creates a Location
based on a SwiftLintFile
and a byte-offset into the file.","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4file8positionAcA0aB4FileC_0A6Syntax16AbsolutePositionVtcfc":{"name":"init(file:position:)","abstract":"
Creates a Location
based on a SwiftLintFile
and a SwiftSyntax AbsolutePosition
into the file.","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4file15characterOffsetAcA0aB4FileC_Sitcfc":{"name":"init(file:characterOffset:)","abstract":"
Creates a Location
based on a SwiftLintFile
and a UTF8 character-offset into the file.","parent_name":"Location"},"Structs/Location.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"Location"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV4codeSSvp":{"name":"code","abstract":"
The contents of the example
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV13configurationSDySSs8Sendable_pGSgvp":{"name":"configuration","abstract":"The untyped configuration to apply to the rule, if deviating from the default configuration.","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV20testMultiByteOffsetsSbvp":{"name":"testMultiByteOffsets","abstract":"
Whether the example should be tested by prepending multibyte grapheme clusters
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV11testOnLinuxSbvp":{"name":"testOnLinux","abstract":"Whether the example should be tested on Linux
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV4files12StaticStringVvp":{"name":"file","abstract":"The path to the file where the example was created
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV4lineSuvp":{"name":"line","abstract":"The line in the file where the example was created
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV_13configuration20testMultiByteOffsets0F17WrappingInComment0fjK6String0F14DisableCommand0F7OnLinux4file4line24excludeFromDocumentationACSS_SDySSs8Sendable_pGSgS5bs06StaticM0VSuSbtcfc":{"name":"init(_:configuration:testMultiByteOffsets:testWrappingInComment:testWrappingInString:testDisableCommand:testOnLinux:file:line:excludeFromDocumentation:)","abstract":"Create a new Example with the specified code, file, and line.
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV4with4codeACSS_tF":{"name":"with(code:)","abstract":"Returns the same example, but with the code
that is passed in
Returns a copy of the Example with all instances of the “↓” character removed.
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV7focusedACyF":{"name":"focused()","abstract":"Makes the current example focused. This is for debugging purposes only.
","parent_name":"Example"},"Structs/Example.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"Example"},"Structs/Example.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"Example"},"Structs/Example.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"Example"},"Structs/Correction.html#/s:13SwiftLintCore10CorrectionV15ruleDescriptionAA04RuleF0Vvp":{"name":"ruleDescription","abstract":"The description of the rule for which this correction was applied.
","parent_name":"Correction"},"Structs/Correction.html#/s:13SwiftLintCore10CorrectionV8locationAA8LocationVvp":{"name":"location","abstract":"The location of the original violation that was corrected.
","parent_name":"Correction"},"Structs/Correction.html#/s:13SwiftLintCore10CorrectionV18consoleDescriptionSSvp":{"name":"consoleDescription","abstract":"The console-printable description for this correction.
","parent_name":"Correction"},"Structs/Correction.html#/s:13SwiftLintCore10CorrectionV15ruleDescription8locationAcA04RuleF0V_AA8LocationVtcfc":{"name":"init(ruleDescription:location:)","abstract":"Memberwise initializer.
","parent_name":"Correction"},"Structs/Command/Modifier.html#/s:13SwiftLintCore7CommandV8ModifierO8previousyA2EmF":{"name":"previous","abstract":"The command should only apply to the line preceding its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:13SwiftLintCore7CommandV8ModifierO4thisyA2EmF":{"name":"this","abstract":"The command should only apply to the same line as its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:13SwiftLintCore7CommandV8ModifierO4nextyA2EmF":{"name":"next","abstract":"The command should only apply to the line following its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:13SwiftLintCore7CommandV8ModifierO7invalidyA2EmF":{"name":"invalid","abstract":"The modifier string was invalid.
","parent_name":"Modifier"},"Structs/Command/Action.html#/s:13SwiftLintCore7CommandV6ActionO6enableyA2EmF":{"name":"enable","abstract":"The rule(s) associated with this command should be enabled by the SwiftLint engine.
","parent_name":"Action"},"Structs/Command/Action.html#/s:13SwiftLintCore7CommandV6ActionO7disableyA2EmF":{"name":"disable","abstract":"The rule(s) associated with this command should be disabled by the SwiftLint engine.
","parent_name":"Action"},"Structs/Command/Action.html#/s:13SwiftLintCore7CommandV6ActionO7invalidyA2EmF":{"name":"invalid","abstract":"The action string was invalid.
","parent_name":"Action"},"Structs/Command/Action.html":{"name":"Action","abstract":"The action (verb) that SwiftLint should perform when interpreting this command.
","parent_name":"Command"},"Structs/Command/Modifier.html":{"name":"Modifier","abstract":"The modifier for a command, used to modify its scope.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV6actionAC6ActionOvp":{"name":"action","abstract":"The action (verb) that SwiftLint should perform when interpreting this command.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV15ruleIdentifiersShyAA14RuleIdentifierOGvp":{"name":"ruleIdentifiers","abstract":"The identifiers for the rules associated with this command.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV4lineSivp":{"name":"line","abstract":"The line in the source file where this command is defined.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV9characterSiSgvp":{"name":"character","abstract":"The character offset within the line in the source file where this command is defined.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV8modifierAC8ModifierOSgvp":{"name":"modifier","abstract":"This command’s modifier, if any.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV6action15ruleIdentifiers4line9character8modifier15trailingCommentA2C6ActionO_ShyAA14RuleIdentifierOGS2iSgAC8ModifierOSgSSSgtcfc":{"name":"init(action:ruleIdentifiers:line:character:modifier:trailingComment:)","abstract":"Creates a command based on the specified parameters.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV12actionString4line9characterACSS_S2itcfc":{"name":"init(actionString:line:character:)","abstract":"Creates a command based on the specified parameters.
","parent_name":"Command"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32ChildOptionSeverityConfigurationV5errorACyxGvpZ":{"name":"error","abstract":"Configuration with a warning severity.
","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32ChildOptionSeverityConfigurationV7warningACyxGvpZ":{"name":"warning","abstract":"Configuration with an error severity.
","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32ChildOptionSeverityConfigurationV3offACyxGvpZ":{"name":"off","abstract":"Configuration disabling an option.
","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32ChildOptionSeverityConfigurationV8severityAA09ViolationF0OSgvp":{"name":"severity","abstract":"The ChildOptionSeverityConfiguration
mapped to a usually used ViolationSeverity
. It’s nil
if the option","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP5apply13configurationyyp_tKF":{"name":"apply(configuration:)","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"ChildOptionSeverityConfiguration"},"Structs/Baseline.html#/s:13SwiftLintCore8BaselineV10violationsSayAA14StyleViolationVGvp":{"name":"violations","abstract":"
The stored violations.
","parent_name":"Baseline"},"Structs/Baseline.html#/s:13SwiftLintCore8BaselineV8fromPathACSS_tKcfc":{"name":"init(fromPath:)","abstract":"Creates a Baseline
from a saved file.
Creates a Baseline
from a list of violations.
Writes a Baseline
to disk in JSON format.
Filters out violations that are present in the Baseline
.
Returns the violations that are present in another Baseline
, but not in this one.
Creates an empty Stack
.
The number of elements in this stack.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV4pushyyxF":{"name":"push(_:)","abstract":"Pushes (appends) an element onto the stack.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV3popxSgyF":{"name":"pop()","abstract":"Removes and returns the last element of the stack.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV4peekxSgyF":{"name":"peek()","abstract":"Returns the last element of the stack if the stack is not empty; otherwise, nil.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV8contains5whereS2bxXE_tF":{"name":"contains(where:)","abstract":"Check whether the sequence contains an element that satisfies the given predicate.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV10modifyLast2byyyxzXE_tF":{"name":"modifyLast(by:)","abstract":"Modify the last element.
","parent_name":"Stack"},"Structs/Stack.html#/s:ST12makeIterator0B0QzyF":{"name":"makeIterator()","parent_name":"Stack"},"Structs/Stack.html#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp":{"name":"debugDescription","parent_name":"Stack"},"Structs/Stack.html":{"name":"Stack","abstract":"A basic stack type implementing the LIFO principle - only the last inserted element can be accessed and removed.
"},"Structs/Baseline.html":{"name":"Baseline","abstract":"A set of violations that can be used to filter newly detected violations.
"},"Structs/ChildOptionSeverityConfiguration.html":{"name":"ChildOptionSeverityConfiguration","abstract":"A rule configuration that allows to disable (off
) an option of a rule or specify its severity level in which"},"Structs/Command.html":{"name":"Command","abstract":"
A SwiftLint-interpretable command to modify SwiftLint’s behavior embedded as comments in source code.
"},"Structs/Correction.html":{"name":"Correction","abstract":"A value describing a SwiftLint violation that was corrected.
"},"Structs/Example.html":{"name":"Example","abstract":"Captures code and context information for an example of a triggering or"},"Structs/Location.html":{"name":"Location","abstract":"
The placement of a segment of Swift in a collection of source files.
"},"Structs/Region.html":{"name":"Region","abstract":"A contiguous region of Swift source code.
"},"Structs/RuleConfigurationDescription.html":{"name":"RuleConfigurationDescription","abstract":"Description of a rule configuration.
"},"Structs/RuleConfigurationOption.html":{"name":"RuleConfigurationOption","abstract":"A single option of a RuleConfigurationDescription
.
A result builder creating configuration descriptions.
"},"Structs/ConfigurationElement.html":{"name":"ConfigurationElement","abstract":"A single parameter of a rule configuration.
"},"Structs/SeverityConfiguration.html":{"name":"SeverityConfiguration","abstract":"A rule configuration that allows specifying the desired severity level for violations.
"},"Structs/RuleDescription.html":{"name":"RuleDescription","abstract":"A detailed description for a SwiftLint rule. Used for both documentation and testing purposes.
"},"Structs/RuleList.html":{"name":"RuleList","abstract":"A list of available SwiftLint rules.
"},"Structs/RuleParameter.html":{"name":"RuleParameter","abstract":"A configuration parameter for rules.
"},"Structs/StyleViolation.html":{"name":"StyleViolation","abstract":"A value describing an instance of Swift source code that is considered invalid by a SwiftLint rule.
"},"Structs/SwiftLintSyntaxMap.html":{"name":"SwiftLintSyntaxMap","abstract":"Represents a Swift file’s syntax information.
"},"Structs/SwiftLintSyntaxToken.html":{"name":"SwiftLintSyntaxToken","abstract":"A SwiftLint-aware Swift syntax token.
"},"Structs/SwiftVersion.html":{"name":"SwiftVersion","abstract":"A value describing the version of the Swift compiler.
"},"Structs/ReasonedRuleViolation.html":{"name":"ReasonedRuleViolation","abstract":"A violation produced by ViolationsSyntaxVisitor
s.
A rule configuration used for defining custom rules in yaml.
"},"Structs/SeverityLevelsConfiguration.html":{"name":"SeverityLevelsConfiguration","abstract":"A rule configuration that allows specifying thresholds for warning
and error
severities.
Produce a ViolationsSyntaxVisitor
for the given file.
Produce a violation for the given file and absolute position.
","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxRule.html#/s:13SwiftLintCore0A10SyntaxRuleP10preprocess4file0aD0010SourceFileD0VSgAA0abI0C_tF":{"name":"preprocess(file:)","abstract":"Gives a chance for the rule to do some pre-processing on the syntax tree.","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxRule.html#/s:13SwiftLintCore4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxCorrectableRule.html#/s:13SwiftLintCore0A21SyntaxCorrectableRuleP12makeRewriter4fileAA010ViolationsdH0Cy17ConfigurationTypeQzGSgAA0aB4FileC_tF":{"name":"makeRewriter(file:)","abstract":"
Produce a ViolationsSyntaxRewriter
for the given file.
The configuration of a rule’s severity.
","parent_name":"SeverityBasedRuleConfiguration"},"Protocols/SeverityBasedRuleConfiguration.html#/s:13SwiftLintCore30SeverityBasedRuleConfigurationPAAE8severityAA09ViolationD0Ovp":{"name":"severity","abstract":"The severity of a rule.
","parent_name":"SeverityBasedRuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP6ParentQa":{"name":"Parent","abstract":"The type of the rule that’s using this configuration.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP20parameterDescriptionAA0deG0VSgvp":{"name":"parameterDescription","abstract":"A description for this configuration’s parameters. It can be built using the annotated result builder.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP5apply13configurationyyp_tKF":{"name":"apply(configuration:)","abstract":"Apply an untyped configuration to the current value.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP8validateyyKF":{"name":"validate()","abstract":"Run a sanity check on the configuration, perform optional postprocessing steps and/or warn about potential","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationPAAE13supportedKeysShySSGvp":{"name":"supportedKeys","abstract":"
All keys supported by this configuration.
","parent_name":"RuleConfiguration"},"Protocols/AnalyzerRule.html#/s:13SwiftLintCore4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"AnalyzerRule"},"Protocols/SubstitutionCorrectableRule.html#/s:13SwiftLintCore27SubstitutionCorrectableRuleP15violationRanges2inSaySo8_NSRangeVGAA0aB4FileC_tF":{"name":"violationRanges(in:)","abstract":"Returns the NSString-based NSRange
s to be replaced in the specified file.
Returns the substitution to apply for the given range.
","parent_name":"SubstitutionCorrectableRule"},"Protocols/SubstitutionCorrectableRule.html#/s:13SwiftLintCore15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","parent_name":"SubstitutionCorrectableRule"},"Protocols/CorrectableRule.html#/s:13SwiftLintCore15CorrectableRuleP7correct4file17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_SaySSGtF":{"name":"correct(file:compilerArguments:)","abstract":"Attempts to correct the violations to this rule in the specified file.
","parent_name":"CorrectableRule"},"Protocols/CorrectableRule.html#/s:13SwiftLintCore15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","abstract":"Attempts to correct the violations to this rule in the specified file.
","parent_name":"CorrectableRule"},"Protocols/CorrectableRule.html#/s:13SwiftLintCore15CorrectableRuleP7correct4file5using17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_AA0E7StorageCSaySSGtF":{"name":"correct(file:using:compilerArguments:)","abstract":"Attempts to correct the violations to this rule in the specified file after collecting file info for all files","parent_name":"CorrectableRule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP17ConfigurationTypeQa":{"name":"ConfigurationType","abstract":"
The type of the configuration used to configure this rule.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP11descriptionAA0D11DescriptionVvpZ":{"name":"description","abstract":"A verbose description of many of this rule’s properties.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP13configuration17ConfigurationTypeQzvp":{"name":"configuration","abstract":"This rule’s configuration.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP06shouldB10EmptyFilesSbvp":{"name":"shouldLintEmptyFiles","abstract":"Whether this rule should be used on empty files. Defaults to false
.
A default initializer for rules. All rules need to be trivially initializable.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP13configurationxyp_tKcfc":{"name":"init(configuration:)","abstract":"Creates a rule by applying its configuration.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP30createConfigurationDescription16exclusiveOptionsAA0dfG0VShySSG_tF":{"name":"createConfigurationDescription(exclusiveOptions:)","abstract":"Create a description of how this rule has been configured to run.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP8validate4file17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_SaySSGtF":{"name":"validate(file:compilerArguments:)","abstract":"Executes the rule on a file and returns any violations to the rule’s expectations.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","abstract":"Executes the rule on a file and returns any violations to the rule’s expectations.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP9isEqualToySbAaB_pF":{"name":"isEqualTo(_:)","abstract":"Whether or not the specified rule is equivalent to the current rule.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP11collectInfo3for4into17compilerArgumentsyAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"collectInfo(for:into:compilerArguments:)","abstract":"Collects information for the specified file in a storage object, to be analyzed by a CollectedLinter
.
Executes the rule on a file after collecting file info for all files and returns any violations to the rule’s","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP13canBeDisabled9violation2bySbAA14StyleViolationV_AA0D10IdentifierOtF":{"name":"canBeDisabled(violation:by:)","abstract":"
Checks if a style violation can be disabled by a command specifying a rule ID. Only the rule can claim that for","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP9isEnabled2in3forSbAA6RegionV_SStF":{"name":"isEnabled(in:for:)","abstract":"
Checks if a the rule is enabled in a given region. A specific rule ID can be provided in case a rule supports","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RulePAAE16cacheDescriptionSSvp":{"name":"cacheDescription","abstract":"
The cache description which will be used to determine if a previous","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RulePAAE10identifierSSvpZ":{"name":"identifier","abstract":"
The rule’s unique identifier which is the same as Rule.description.identifier
.
The kind of information to collect for each file being linted for this rule.
","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore14CollectingRuleP11collectInfo3for17compilerArguments04FileG0QzAA0abK0C_SaySSGtF":{"name":"collectInfo(for:compilerArguments:)","abstract":"Collects information for the specified file, to be analyzed by a CollectedLinter
.
Collects information for the specified file, to be analyzed by a CollectedLinter
.
Executes the rule on a file after collecting file info for all files and returns any violations to the rule’s","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore14CollectingRuleP8validate4file13collectedInfoSayAA14StyleViolationVGAA0aB4FileC_SDyAK0lI0QzGtF":{"name":"validate(file:collectedInfo:)","abstract":"
Executes the rule on a file after collecting file info for all files and returns any violations to the rule’s","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore4RuleP11collectInfo3for4into17compilerArgumentsyAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"collectInfo(for:into:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore4RuleP8validate4file5using17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"validate(file:using:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore4RuleP8validate4file17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_SaySSGtF":{"name":"validate(file:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CacheDescriptionProvider.html#/s:13SwiftLintCore24CacheDescriptionProviderP05cacheE0SSvp":{"name":"cacheDescription","abstract":"
The cache description which will be used to determine if a previous","parent_name":"CacheDescriptionProvider"},"Protocols/ASTRule.html#/s:13SwiftLintCore7ASTRuleP8KindTypeQa":{"name":"KindType","abstract":"
The kind of token being recursed over.
","parent_name":"ASTRule"},"Protocols/ASTRule.html#/s:13SwiftLintCore7ASTRuleP8validate4file4kind10dictionarySayAA14StyleViolationVGAA0aB4FileC_8KindTypeQzAA22SourceKittenDictionaryVtF":{"name":"validate(file:kind:dictionary:)","abstract":"Executes the rule on a file and a subset of its AST structure, returning any violations to the rule’s","parent_name":"ASTRule"},"Protocols/ASTRule.html#/s:13SwiftLintCore7ASTRuleP4kind4from8KindTypeQzSgAA22SourceKittenDictionaryV_tF":{"name":"kind(from:)","abstract":"
Get the kind
from the specified dictionary.
Executes the rule on a file and a subset of its AST structure, returning any violations to the rule’s","parent_name":"ASTRule"},"Protocols/VersionComparable.html#/s:13SwiftLintCore17VersionComparableP8rawValueSSvp":{"name":"rawValue","abstract":"
The version string.
","parent_name":"VersionComparable"},"Protocols/VersionComparable.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"VersionComparable"},"Protocols/VersionComparable.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"VersionComparable"},"Protocols/AcceptableByConfigurationElement.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","abstract":"Initializer taking a value from a configuration to create an element of Self
.
Make the object an option.
","parent_name":"AcceptableByConfigurationElement"},"Protocols/AcceptableByConfigurationElement.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP13asDescription4withAA04RulefI0VSS_tF":{"name":"asDescription(with:)","abstract":"Make the object a description.
","parent_name":"AcceptableByConfigurationElement"},"Protocols/AcceptableByConfigurationElement.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP5apply_6ruleIDyyp_SStKF":{"name":"apply(_:ruleID:)","abstract":"Update the object.
","parent_name":"AcceptableByConfigurationElement"},"Protocols/Documentable.html#/s:13SwiftLintCore12DocumentableP8markdownSSyF":{"name":"markdown()","abstract":"Convert an object to Markdown.
","parent_name":"Documentable"},"Protocols/Documentable.html#/s:13SwiftLintCore12DocumentableP8oneLinerSSyF":{"name":"oneLiner()","abstract":"Convert an object to a single line string.
","parent_name":"Documentable"},"Protocols/Documentable.html#/s:13SwiftLintCore12DocumentableP10hasContentSbvp":{"name":"hasContent","abstract":"Indicate if the item has some content that is useful to document.
","parent_name":"Documentable"},"Protocols/Documentable.html#/s:13SwiftLintCore12DocumentableP4yamlSSyF":{"name":"yaml()","abstract":"Convert an object to YAML as used in .swiftlint.yml
.
A type that can be converted into a human-readable representation.
"},"Protocols/AcceptableByConfigurationElement.html":{"name":"AcceptableByConfigurationElement","abstract":"Type of an object that can be used as a configuration element.
"},"Protocols.html#/s:13SwiftLintCore19InlinableOptionTypeP":{"name":"InlinableOptionType","abstract":"An option type that can appear inlined into its using configuration.
"},"Protocols/VersionComparable.html":{"name":"VersionComparable","abstract":"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"},"Protocols/CacheDescriptionProvider.html":{"name":"CacheDescriptionProvider","abstract":"
Interface providing access to a cache description.
"},"Protocols.html#/s:13SwiftLintCore17AnyCollectingRuleP":{"name":"AnyCollectingRule","abstract":"Type-erased protocol used to check whether a rule is collectable.
"},"Protocols/CollectingRule.html":{"name":"CollectingRule","abstract":"A rule that requires knowledge of all other files being linted.
"},"Protocols/Rule.html":{"name":"Rule","abstract":"An executable value that can identify issues (violations) in Swift source code.
"},"Protocols.html#/s:13SwiftLintCore9OptInRuleP":{"name":"OptInRule","abstract":"A rule that is not enabled by default. Rules conforming to this need to be explicitly enabled by users.
"},"Protocols/CorrectableRule.html":{"name":"CorrectableRule","abstract":"A rule that can correct violations.
"},"Protocols/SubstitutionCorrectableRule.html":{"name":"SubstitutionCorrectableRule","abstract":"A correctable rule that can apply its corrections by replacing the content of ranges in the offending file with"},"Protocols.html#/s:13SwiftLintCore17SourceKitFreeRuleP":{"name":"SourceKitFreeRule","abstract":"
A rule that does not need SourceKit to operate and can still operate even after SourceKit has crashed.
"},"Protocols/AnalyzerRule.html":{"name":"AnalyzerRule","abstract":"A rule that can operate on the post-typechecked AST using compiler arguments. Performs rules that are more like"},"Protocols/RuleConfiguration.html":{"name":"RuleConfiguration","abstract":"
A configuration value for a rule to allow users to modify its behavior.
"},"Protocols/SeverityBasedRuleConfiguration.html":{"name":"SeverityBasedRuleConfiguration","abstract":"A configuration for a rule that allows to configure at least the severity.
"},"Protocols/SwiftSyntaxCorrectableRule.html":{"name":"SwiftSyntaxCorrectableRule","abstract":"A SwiftLint CorrectableRule that performs its corrections using a SwiftSyntax SyntaxRewriter
.
A SwiftLint Rule backed by SwiftSyntax that does not use SourceKit requests.
"},"Extensions/Double.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Double"},"Extensions/Double.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Double"},"Extensions/Int.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Int"},"Extensions/Int.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Int"},"Extensions/Set.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Set"},"Extensions/Set.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Set"},"Extensions/String.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"String"},"Extensions/String.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"String"},"Extensions/Bool.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Bool"},"Extensions/Bool.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Bool"},"Extensions/Optional.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Optional"},"Extensions/Optional.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Optional"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE26skipWrappingInCommentTestsSayACGyF":{"name":"skipWrappingInCommentTests()","abstract":"Make these examples skip wrapping in comment tests.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE25skipWrappingInStringTestsSayACGyF":{"name":"skipWrappingInStringTests()","abstract":"Make these examples skip wrapping in string tests.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE24skipMultiByteOffsetTestsSayACGyF":{"name":"skipMultiByteOffsetTests()","abstract":"Make these examples skip multi-byte offset tests.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE23skipDisableCommandTestsSayACGyF":{"name":"skipDisableCommandTests()","abstract":"Make these examples skip disable command tests.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE23removingViolationMarkerSayACGyF":{"name":"removingViolationMarker()","abstract":"Remove all violation markers from the examples.
","parent_name":"Array"},"Extensions/Array.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Array"},"Extensions/Array.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA0aB11SyntaxTokenVRszlE5kindsSay21SourceKittenFramework0D4KindOGvp":{"name":"kinds","abstract":"The kinds for these tokens.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA21ReasonedRuleViolationVRszlE6appendyy0A6Syntax16AbsolutePositionVF":{"name":"append(_:)","abstract":"Add a violation at the specified position using the default description and severity.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA21ReasonedRuleViolationVRszlE6append2at10correctiony0A6Syntax16AbsolutePositionV_AC0F10CorrectionVSgtF":{"name":"append(at:correction:)","abstract":"Add a violation and the correction at the specified position using the default description and severity.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA21ReasonedRuleViolationVRszlE6append10contentsOfySay0A6Syntax16AbsolutePositionVG_tF":{"name":"append(contentsOf:)","abstract":"Add violations for the specified positions using the default description and severity.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCore0A6Syntax04DeclD8Protocol_pXpRszlE3allSayAbC_pXpGvpZ":{"name":"all","abstract":"All visitable declaration syntax types.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCore0A6Syntax04DeclD8Protocol_pXpRszlE9allExceptySayAbC_pXpGAbC_pXpd_tFZ":{"name":"allExcept(_:)","abstract":"All declarations except for the specified ones.
","parent_name":"Array"},"Extensions/Array.html":{"name":"Array"},"Extensions/Optional.html":{"name":"Optional"},"Extensions/Bool.html":{"name":"Bool"},"Extensions/String.html":{"name":"String"},"Extensions/Set.html":{"name":"Set"},"Extensions/Int.html":{"name":"Int"},"Extensions/Double.html":{"name":"Double"},"Enums/IdentifierDeclaration.html#/s:13SwiftLintCore21IdentifierDeclarationO9parameteryAC0A6Syntax05TokenG0V_tcACmF":{"name":"parameter(name:)","abstract":"Parameter declaration with a name token.
","parent_name":"IdentifierDeclaration"},"Enums/IdentifierDeclaration.html#/s:13SwiftLintCore21IdentifierDeclarationO13localVariableyAC0A6Syntax05TokenH0V_tcACmF":{"name":"localVariable(name:)","abstract":"Local variable declaration with a name token.
","parent_name":"IdentifierDeclaration"},"Enums/IdentifierDeclaration.html#/s:13SwiftLintCore21IdentifierDeclarationO16implicitVariableyACSS_tcACmF":{"name":"implicitVariable(name:)","abstract":"A variable that is implicitly added by the compiler (e.g. error
in catch
clauses).
A variable hidden from scope because its name is a wildcard _
.
Special case that marks a type boundary at which name lookup stops.
","parent_name":"IdentifierDeclaration"},"Enums/IdentifierDeclaration.html#/s:13SwiftLintCore21IdentifierDeclarationO8declares2id18disregardBackticksSbSS_SbtF":{"name":"declares(id:disregardBackticks:)","abstract":"Check whether self declares a variable given by name.
","parent_name":"IdentifierDeclaration"},"Enums/ViolationSeverity.html#/s:13SwiftLintCore17ViolationSeverityO7warningyA2CmF":{"name":"warning","abstract":"Non-fatal. If using SwiftLint as an Xcode build phase, Xcode will mark the build as having succeeded.
","parent_name":"ViolationSeverity"},"Enums/ViolationSeverity.html#/s:13SwiftLintCore17ViolationSeverityO5erroryA2CmF":{"name":"error","abstract":"Fatal. If using SwiftLint as an Xcode build phase, Xcode will mark the build as having failed.
","parent_name":"ViolationSeverity"},"Enums/ViolationSeverity.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"ViolationSeverity"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO4callyA2CmF":{"name":"call","abstract":"A call to a named function or closure.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO8argumentyA2CmF":{"name":"argument","abstract":"An argument value for a function or closure.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO5arrayyA2CmF":{"name":"array","abstract":"An Array expression.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO10dictionaryyA2CmF":{"name":"dictionary","abstract":"A Dictionary expression.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO13objectLiteralyA2CmF":{"name":"objectLiteral","abstract":"An object literal expression. https://developer.apple.com/swift/blog/?id=33
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO7closureyA2CmF":{"name":"closure","abstract":"A closure expression. https://docs.swift.org/swift-book/LanguageGuide/Closures.html
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO5tupleyA2CmF":{"name":"tuple","abstract":"A tuple expression. https://docs.swift.org/swift-book/ReferenceManual/Types.html#ID448
","parent_name":"SwiftExpressionKind"},"Enums/RuleListError.html#/s:13SwiftLintCore13RuleListErrorO24duplicatedConfigurationsyAcA0D0_pXp_tcACmF":{"name":"duplicatedConfigurations(rule:)","abstract":"The rule list contains more than one configuration for the specified rule.
","parent_name":"RuleListError"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO4lintyA2CmF":{"name":"lint","abstract":"Describes rules that validate Swift source conventions.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO9idiomaticyA2CmF":{"name":"idiomatic","abstract":"Describes rules that validate common practices in the Swift community.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO5styleyA2CmF":{"name":"style","abstract":"Describes rules that validate stylistic choices.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO7metricsyA2CmF":{"name":"metrics","abstract":"Describes rules that validate magnitudes or measurements of Swift source.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO11performanceyA2CmF":{"name":"performance","abstract":"Describes rules that validate that code patterns with poor performance are avoided.
","parent_name":"RuleKind"},"Enums/RuleIdentifier.html#/s:13SwiftLintCore14RuleIdentifierO3allyA2CmF":{"name":"all","abstract":"Special identifier that should be treated as referring to ‘all’ SwiftLint rules. One helpful usecase is in","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:13SwiftLintCore14RuleIdentifierO6singleyACSS_tcACmF":{"name":"single(identifier:)","abstract":"
Represents a single SwiftLint rule with the specified identifier.
","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:13SwiftLintCore14RuleIdentifierO20stringRepresentationSSvp":{"name":"stringRepresentation","abstract":"The spelling of the string for this identifier.
","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:13SwiftLintCore14RuleIdentifierOyACSScfc":{"name":"init(_:)","abstract":"Creates a RuleIdentifier
by its string representation.
An irrelevant option. It will be ignored in documentation serialization.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO4flagyACSbcACmF":{"name":"flag(_:)","abstract":"A boolean flag.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO6stringyACSScACmF":{"name":"string(_:)","abstract":"A string option.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO6symbolyACSScACmF":{"name":"symbol(_:)","abstract":"Like a string option but without quotes in the serialized output.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO7integeryACSicACmF":{"name":"integer(_:)","abstract":"An integer option.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO5floatyACSdcACmF":{"name":"float(_:)","abstract":"A floating point number option.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO8severityyAcA17ViolationSeverityOcACmF":{"name":"severity(_:)","abstract":"Special option for a ViolationSeverity
.
A list of options.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO6nestedyAcA28RuleConfigurationDescriptionVcACmF":{"name":"nested(_:)","abstract":"An option which is another set of configuration options to be nested in the serialized output.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore12DocumentableP10hasContentSbvp":{"name":"hasContent","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore12DocumentableP8markdownSSyF":{"name":"markdown()","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore12DocumentableP8oneLinerSSyF":{"name":"oneLiner()","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore12DocumentableP4yamlSSyF":{"name":"yaml()","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO2egoiyAA017RuleConfigurationD0VSS_ACtFZ":{"name":"=>(_:_:)","abstract":"Operator enabling an easy way to create a configuration option.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO4nestyAcA28RuleConfigurationDescriptionVyXEFZ":{"name":"nest(_:)","abstract":"Create an option defined by nested configuration description.
","parent_name":"OptionType"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO20invalidConfigurationyACSS_SSSgtcACmF":{"name":"invalidConfiguration(ruleID:message:)","abstract":"The configuration didn’t match internal expectations.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO29deprecatedConfigurationOptionyACSS_S2SSgtcACmF":{"name":"deprecatedConfigurationOption(ruleID:key:alternative:)","abstract":"Issued when an option is deprecated. Suggests an alternative optionally.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO14nothingAppliedyACSS_tcACmF":{"name":"nothingApplied(ruleID:)","abstract":"Used in configuration parsing when no changes have been applied. Use only internally!
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO18listedMultipleTimeyACSS_SitcACmF":{"name":"listedMultipleTime(ruleID:times:)","abstract":"Rule is listed multiple times in the configuration.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO17renamedIdentifieryACSS_SStcACmF":{"name":"renamedIdentifier(old:new:)","abstract":"An identifier old
has been renamed to new
.
Some configuration keys are invalid.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO25inconsistentConfigurationyACSS_SStcACmF":{"name":"inconsistentConfiguration(ruleID:message:)","abstract":"The configuration is inconsistent, that is options are mutually exclusive or one drives other values","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO14invalidRuleIDsyACShySSGcACmF":{"name":"invalidRuleIDs(_:)","abstract":"
Used rule IDs are invalid.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO25ruleNotPresentInOnlyRulesyACSS_tcACmF":{"name":"ruleNotPresentInOnlyRules(ruleID:)","abstract":"Found a rule configuration for a rule that is not present in only_rules
.
Found a rule configuration for a rule that is disabled.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO33ruleDisabledInParentConfigurationyACSS_tcACmF":{"name":"ruleDisabledInParentConfiguration(ruleID:)","abstract":"Found a rule configuration for a rule that is disabled in the parent configuration.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO019ruleNotEnabledInOptH5RulesyACSS_tcACmF":{"name":"ruleNotEnabledInOptInRules(ruleID:)","abstract":"Found a rule configuration for a rule that is not enabled in opt_in_rules
.
Found a rule configuration for a rule that is not enabled in parent only_rules
.
A generic warning specified by a string.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO12genericErroryACSScACmF":{"name":"genericError(_:)","abstract":"A generic error specified by a string.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO14ruleDeprecatedyACSS_tcACmF":{"name":"ruleDeprecated(ruleID:)","abstract":"A deprecation warning for a rule.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO19initialFileNotFoundyACSS_tcACmF":{"name":"initialFileNotFound(path:)","abstract":"The initial configuration file was not found.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO12fileNotFoundyACSS_tcACmF":{"name":"fileNotFound(path:)","abstract":"A file at specified path was not found.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO15fileNotReadableyACSSSg_SStcACmF":{"name":"fileNotReadable(path:ruleID:)","abstract":"The file at path
is not readable or cannot be opened.
The file at path
is not writable.
The file at path
cannot be indexed by a specific rule.
No arguments were provided to compile a file at path
within a specific rule.
Cursor information cannot be extracted from a specific location.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO11yamlParsingyACSScACmF":{"name":"yamlParsing(_:)","abstract":"An error that occurred when parsing YAML.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO19baselineNotReadableyACSS_tcACmF":{"name":"baselineNotReadable(path:)","abstract":"The baseline file at path
is not readable or cannot be opened.
Print the issue to the console.
","parent_name":"Issue"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO7privateyA2CmF":{"name":"private","abstract":"Accessible by the declaration’s immediate lexical scope.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO11fileprivateyA2CmF":{"name":"fileprivate","abstract":"Accessible by the declaration’s same file.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO8internalyA2CmF":{"name":"internal","abstract":"Accessible by the declaration’s same module, or modules importing it with the @testable
attribute.
Accessible by all the modules defined in the same Swift package.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO6publicyA2CmF":{"name":"public","abstract":"Accessible by the declaration’s same program.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO4openyA2CmF":{"name":"open","abstract":"Accessible and customizable (via subclassing or overrides) by the declaration’s same program.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO11descriptionACSgSS_tcfc":{"name":"init(description:)","abstract":"Initializes an access control level by its Swift source keyword value.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO9isPrivateSbvp":{"name":"isPrivate","abstract":"Returns true if is private
or fileprivate
The accessibility of a Swift source declaration.
"},"Enums/Issue.html":{"name":"Issue","abstract":"All possible SwiftLint issues which are printed as warnings by default.
"},"Enums/OptionType.html":{"name":"OptionType","abstract":"Type of an option.
"},"Enums/RuleIdentifier.html":{"name":"RuleIdentifier","abstract":"An identifier representing a SwiftLint rule, or all rules.
"},"Enums/RuleKind.html":{"name":"RuleKind","abstract":"All the possible rule kinds (categories).
"},"Enums/RuleListError.html":{"name":"RuleListError","abstract":"All possible rule list configuration errors.
"},"Enums/SwiftExpressionKind.html":{"name":"SwiftExpressionKind","abstract":"The kind of expression for a contiguous set of Swift source tokens.
"},"Enums/ViolationSeverity.html":{"name":"ViolationSeverity","abstract":"The magnitude of a StyleViolation
.
An identifier declaration.
"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC13configurationxvp":{"name":"configuration","abstract":"A rule’s configuration.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC4fileAA0aB4FileCvp":{"name":"file","abstract":"The file from which the traversed syntax tree stems from.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC17locationConverter0aE0014SourceLocationH0Cvp":{"name":"locationConverter","abstract":"A source location converter associated with the syntax tree being traversed.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC13configuration4fileACyxGx_AA0aB4FileCtcfc":{"name":"init(configuration:file:)","abstract":"Initializer for a ViolationsSyntaxVisitor
.
Positions in a source file where violations should be reported.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC21skippableDeclarationsSay0aE004DeclE8Protocol_pXpGvp":{"name":"skippableDeclarations","abstract":"List of declaration types that shall be skipped while traversing the AST.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE09ActorDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE09ClassDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE08EnumDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE013ExtensionDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE012FunctionDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE015InitializerDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE012ProtocolDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE010StructDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE013SubscriptDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE012VariableDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC5Scopea":{"name":"Scope","abstract":"A type that remembers the declared identifiers (in order) up to the current position in the code.
","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC5scopeAA5StackVySayAA21IdentifierDeclarationOGGvp":{"name":"scope","abstract":"The hierarchical stack of identifiers declared up to the current position in the code.
","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC13configuration4file5scopeACyxGx_AA0aB4FileCAA5StackVySayAA21IdentifierDeclarationOGGtcfc":{"name":"init(configuration:file:scope:)","abstract":"Initializer.
","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC18hasSeenDeclaration3forSbSS_tF":{"name":"hasSeenDeclaration(for:)","abstract":"Indicate whether a given identifier is in scope.
","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC5visity0A6Syntax0iG12ContinueKindOAE017CodeBlockItemListI0VF":{"name":"visit(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC9visitPostyy0A6Syntax017CodeBlockItemListJ0VF":{"name":"visitPost(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC9visitPostyy0A6Syntax012VariableDeclJ0VF":{"name":"visitPost(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC9visitPostyy0A6Syntax09GuardStmtJ0VF":{"name":"visitPost(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC5visity0A6Syntax0iG12ContinueKindOAE011MemberBlockI0VF":{"name":"visit(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC9visitPostyy0A6Syntax011MemberBlockJ0VF":{"name":"visitPost(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC13configuration4fileACyxGx_AA0aB4FileCtcfc":{"name":"init(configuration:file:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax012AccessorDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09ActorDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax011CatchClauseI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09ClassDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax011ClosureExprI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09DeferStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax06DoStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax08EnumDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax013ExtensionDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax012FunctionDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax07ForStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09GuardStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax06IfExprI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax015InitializerDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax014PatternBindingI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax019PrecedenceGroupDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax012ProtocolDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax010RepeatStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax010StructDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax010SwitchExprI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09WhileStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC17collectViolations3foryqd__Sg_t0A6Syntax06BracedJ0Rd__lF":{"name":"collectViolations(for:)","abstract":"Collects violations for the given braced item. Intended to be specialized by subclasses.
","parent_name":"CodeBlockVisitor"},"Classes/BodyLengthRuleVisitor/Kind.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC4KindO7closureyAEyx_GAGmAA0F0RzlF":{"name":"closure","abstract":"Closure code blocks.
","parent_name":"Kind"},"Classes/BodyLengthRuleVisitor/Kind.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC4KindO8functionyAEyx_GAGmAA0F0RzlF":{"name":"function","abstract":"Function body blocks.
","parent_name":"Kind"},"Classes/BodyLengthRuleVisitor/Kind.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC4KindO4typeyAEyx_GAGmAA0F0RzlF":{"name":"type","abstract":"Type (class, enum, …) member blocks.
","parent_name":"Kind"},"Classes/BodyLengthRuleVisitor/Kind.html":{"name":"Kind","abstract":"The code block types to check.
","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC4kind4file13configurationACyxGAC4KindOyx_G_AA0aB4FileCAA27SeverityLevelsConfigurationVyxGtcfc":{"name":"init(kind:file:configuration:)","abstract":"Initializer.
","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax08EnumDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax09ClassDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax010StructDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax09ActorDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax011ClosureExprJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax012FunctionDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax015InitializerDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/CodeIndentingRewriter/IndentationStyle.html#/s:13SwiftLintCore21CodeIndentingRewriterC16IndentationStyleO12indentSpacesyAESicAEmF":{"name":"indentSpaces(_:)","abstract":"Indentation with a number of spaces.
","parent_name":"IndentationStyle"},"Classes/CodeIndentingRewriter/IndentationStyle.html#/s:13SwiftLintCore21CodeIndentingRewriterC16IndentationStyleO14unindentSpacesyAESicAEmF":{"name":"unindentSpaces(_:)","abstract":"Reverse indentation of a number of spaces.
","parent_name":"IndentationStyle"},"Classes/CodeIndentingRewriter/IndentationStyle.html#/s:13SwiftLintCore21CodeIndentingRewriterC16IndentationStyleO10indentTabsyAESicAEmF":{"name":"indentTabs(_:)","abstract":"Indentation with a number of tabs
","parent_name":"IndentationStyle"},"Classes/CodeIndentingRewriter/IndentationStyle.html#/s:13SwiftLintCore21CodeIndentingRewriterC16IndentationStyleO12unindentTabsyAESicAEmF":{"name":"unindentTabs(_:)","abstract":"Reverse indentation of a number of tabs.
","parent_name":"IndentationStyle"},"Classes/CodeIndentingRewriter/IndentationStyle.html":{"name":"IndentationStyle","abstract":"Style defining whether the rewriter shall indent or unindent and whether it shall use tabs or spaces and","parent_name":"CodeIndentingRewriter"},"Classes/CodeIndentingRewriter.html#/s:13SwiftLintCore21CodeIndentingRewriterC5styleA2C16IndentationStyleO_tcfc":{"name":"init(style:)","abstract":"
Initializer accepting an indentation style.
","parent_name":"CodeIndentingRewriter"},"Classes/CodeIndentingRewriter.html#/s:13SwiftLintCore21CodeIndentingRewriterC5visity0A6Syntax05TokenH0VAGF":{"name":"visit(_:)","parent_name":"CodeIndentingRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC13configurationxvp":{"name":"configuration","abstract":"A rule’s configuration.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC4fileAA0aB4FileCvp":{"name":"file","abstract":"The file from which the traversed syntax tree stems from.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC17locationConverter0aE0014SourceLocationH0Cvp":{"name":"locationConverter","abstract":"A converter of positions in the traversed source file.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC15disabledRegionsSay0aE011SourceRangeVGvp":{"name":"disabledRegions","abstract":"The regions in the traversed file that are disabled by a command.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC19correctionPositionsSay0aE016AbsolutePositionVGvp":{"name":"correctionPositions","abstract":"Positions in a source file where corrections were applied.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC13configuration4fileACyxGx_AA0aB4FileCtcfc":{"name":"init(configuration:file:)","abstract":"Initializer for a ViolationsSyntaxRewriter
.
The underlying SourceKitten file.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC2id10Foundation4UUIDVvp":{"name":"id","abstract":"The associated unique identifier for this file.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC06isTestD0Sbvp":{"name":"isTestFile","abstract":"Whether or not this is a file generated for testing purposes.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC9isVirtualSbvp":{"name":"isVirtual","abstract":"A file is virtual if it is not backed by a filesystem path.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC4fileAC21SourceKittenFramework0D0C_tcfc":{"name":"init(file:)","abstract":"Creates a SwiftLintFile
with a SourceKitten File
.
Creates a SwiftLintFile
by specifying its path on disk.","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC20pathDeferringReadingACSS_tcfc":{"name":"init(pathDeferringReading:)","abstract":"
Creates a SwiftLintFile
by specifying its path on disk. Unlike the SwiftLintFile(path:)
initializer, this","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC8contentsACSS_tcfc":{"name":"init(contents:)","abstract":"
Creates a SwiftLintFile
that is not backed by a file on disk by specifying its contents.
The path on disk for this file.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC8contentsSSvp":{"name":"contents","abstract":"The file’s contents.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC10stringView21SourceKittenFramework06StringF0Vvp":{"name":"stringView","abstract":"A string view into the contents of this file optimized for string manipulation operations.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC5linesSay21SourceKittenFramework4LineVGvp":{"name":"lines","abstract":"The parsed lines for this file’s contents.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"SwiftLintFile"},"Classes/RuleStorage.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RuleStorage"},"Classes/RuleStorage.html#/s:13SwiftLintCore11RuleStorageCACycfc":{"name":"init()","abstract":"Creates a RuleStorage
with no initial stored data.
Shared rule registry instance.
","parent_name":"RuleRegistry"},"Classes/RuleRegistry.html#/s:13SwiftLintCore12RuleRegistryC4listAA0D4ListVvp":{"name":"list","abstract":"Rule list associated with this registry. Lazily created, and","parent_name":"RuleRegistry"},"Classes/RuleRegistry.html#/s:13SwiftLintCore12RuleRegistryC8register5rulesySayAA0D0_pXpG_tF":{"name":"register(rules:)","abstract":"
Register rules.
","parent_name":"RuleRegistry"},"Classes/RuleRegistry.html#/s:13SwiftLintCore12RuleRegistryC4rule5forIDAA0D0_pXpSgSS_tF":{"name":"rule(forID:)","abstract":"Look up a rule for a given ID.
","parent_name":"RuleRegistry"},"Classes/RuleRegistry.html":{"name":"RuleRegistry","abstract":"Container to register and look up SwiftLint rules.
"},"Classes/RuleStorage.html":{"name":"RuleStorage","abstract":"A storage mechanism for aggregating the results of CollectingRule
s.
A unit of Swift source code, either on disk or in memory.
"},"Classes/ViolationsSyntaxRewriter.html":{"name":"ViolationsSyntaxRewriter","abstract":"A SwiftSyntax SyntaxRewriter
that produces absolute positions where corrections were applied.
Rewriter that indents or unindents a syntax piece including comments and nested"},"Classes/BodyLengthRuleVisitor.html":{"name":"BodyLengthRuleVisitor","abstract":"
Visitor that collection violations of code block lengths.
"},"Classes/CodeBlockVisitor.html":{"name":"CodeBlockVisitor","abstract":"A visitor that collects style violations for all available code blocks.
"},"Classes/DeclaredIdentifiersTrackingVisitor.html":{"name":"DeclaredIdentifiersTrackingVisitor","abstract":"A specialized ViolationsSyntaxVisitor
that tracks declared identifiers per scope while traversing the AST.
A SwiftSyntax SyntaxVisitor
that produces absolute positions where violations should be reported.
The following guides are available globally.
"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally.
"},"Enums.html":{"name":"Enumerations","abstract":"The following enumerations are available globally.
"},"Extensions.html":{"name":"Extensions","abstract":"The following extensions are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally.
"},"Structs.html":{"name":"Structures","abstract":"The following structures are available globally.
"},"Macros.html":{"name":"Macros","abstract":"The following macros are available globally.
"}} \ No newline at end of file +{"Macros.html#/s:13SwiftLintCore16AutoConfigParseryycfm":{"name":"AutoConfigParser()","abstract":"Macro to be attached to rule configurations. It generates the configuration parsing logic"},"Macros.html#/s:13SwiftLintCore32AcceptableByConfigurationElementyycfm":{"name":"AcceptableByConfigurationElement()","abstract":"
Macro that lets an enum with a String
raw type automatically conform to AcceptableByConfigurationElement
.
Macro that adds a conformance to the SwiftSyntaxRule
protocol and a default makeVisitor(file:)
implementation"},"Structs/SeverityLevelsConfiguration.html#/s:13SwiftLintCore27SeverityLevelsConfigurationV7warningSivp":{"name":"warning","abstract":"
The threshold for a violation to be a warning.
","parent_name":"SeverityLevelsConfiguration"},"Structs/SeverityLevelsConfiguration.html#/s:13SwiftLintCore27SeverityLevelsConfigurationV5errorSiSgvp":{"name":"error","abstract":"The threshold for a violation to be an error.
","parent_name":"SeverityLevelsConfiguration"},"Structs/SeverityLevelsConfiguration.html#/s:13SwiftLintCore27SeverityLevelsConfigurationV7warning5errorACyxGSi_SiSgtcfc":{"name":"init(warning:error:)","abstract":"Create a SeverityLevelsConfiguration
based on the specified warning
and error
thresholds.
The rule parameters that define the thresholds that should map to each severity.
","parent_name":"SeverityLevelsConfiguration"},"Structs/SeverityLevelsConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP5apply13configurationyyp_tKF":{"name":"apply(configuration:)","parent_name":"SeverityLevelsConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV10identifierSSvp":{"name":"identifier","abstract":"The identifier for this custom rule.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV4nameSSSgvp":{"name":"name","abstract":"The name for this custom rule.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV7messageSSvp":{"name":"message","abstract":"The message to be presented when producing violations.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV8includedSaySo19NSRegularExpressionCGvp":{"name":"included","abstract":"Regular expressions to include when matching the file path.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV8excludedSaySo19NSRegularExpressionCGvp":{"name":"excluded","abstract":"Regular expressions to exclude when matching the file path.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV18excludedMatchKindsShy21SourceKittenFramework10SyntaxKindOGvp":{"name":"excludedMatchKinds","abstract":"The syntax kinds to exclude from matches. If the regex matched syntax kinds from this list, it would","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore30SeverityBasedRuleConfigurationP08severityG0AA0dG0Vy6ParentQzGvp":{"name":"severityConfiguration","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV12captureGroupSivp":{"name":"captureGroup","abstract":"
The index of the regex capture group to match.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore24CacheDescriptionProviderP05cacheE0SSvp":{"name":"cacheDescription","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV11descriptionAA15RuleDescriptionVvp":{"name":"description","abstract":"The RuleDescription
for the custom rule defined here.
Create a RegexConfiguration
with the specified identifier, with other properties to be set later.
Create a ViolationCorrection
.
The correction of a violation that is basically the violation’s range in the source code and a","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV8position0A6Syntax16AbsolutePositionVvp":{"name":"position","abstract":"
The violation’s position.
","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV6reasonSSSgvp":{"name":"reason","abstract":"A specific reason for the violation.
","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV8severityAA0F8SeverityOSgvp":{"name":"severity","abstract":"The violation’s severity.
","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV10correctionAC0F10CorrectionVSgvp":{"name":"correction","abstract":"An optional correction of the violation to be used in rewriting (see SwiftSyntaxCorrectableRule
). Can be","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV8position6reason8severity10correctionAC0A6Syntax16AbsolutePositionV_SSSgAA0F8SeverityOSgAC0F10CorrectionVSgtcfc":{"name":"init(position:reason:severity:correction:)","abstract":"
Creates a ReasonedRuleViolation
.
Swift 5
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV10fiveDotOneACvpZ":{"name":"fiveDotOne","abstract":"Swift 5.1
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV10fiveDotTwoACvpZ":{"name":"fiveDotTwo","abstract":"Swift 5.2
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV12fiveDotThreeACvpZ":{"name":"fiveDotThree","abstract":"Swift 5.3
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV11fiveDotFourACvpZ":{"name":"fiveDotFour","abstract":"Swift 5.4
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV11fiveDotFiveACvpZ":{"name":"fiveDotFive","abstract":"Swift 5.5
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV10fiveDotSixACvpZ":{"name":"fiveDotSix","abstract":"Swift 5.6
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV12fiveDotSevenACvpZ":{"name":"fiveDotSeven","abstract":"Swift 5.7
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV12fiveDotEightACvpZ":{"name":"fiveDotEight","abstract":"Swift 5.8
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV11fiveDotNineACvpZ":{"name":"fiveDotNine","abstract":"Swift 5.9
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV3sixACvpZ":{"name":"six","abstract":"Swift 6
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV7currentACvpZ":{"name":"current","abstract":"The current detected Swift compiler version, based on the currently accessible SourceKit version.
","parent_name":"SwiftVersion"},"Structs/SwiftLintSyntaxToken.html#/s:13SwiftLintCore0aB11SyntaxTokenV5value21SourceKittenFramework0dE0Vvp":{"name":"value","abstract":"The raw SyntaxToken
obtained by SourceKitten.
The syntax kind associated with is token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:13SwiftLintCore0aB11SyntaxTokenV5valueAC21SourceKittenFramework0dE0V_tcfc":{"name":"init(value:)","abstract":"Creates a SwiftLintSyntaxToken
from the raw SyntaxToken
obtained by SourceKitten.
The byte range in a source file for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:13SwiftLintCore0aB11SyntaxTokenV6offset21SourceKittenFramework9ByteCountVvp":{"name":"offset","abstract":"The starting byte offset in a source file for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:13SwiftLintCore0aB11SyntaxTokenV6length21SourceKittenFramework9ByteCountVvp":{"name":"length","abstract":"The length in bytes for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxMap.html#/s:13SwiftLintCore0aB9SyntaxMapV5value21SourceKittenFramework0dE0Vvp":{"name":"value","abstract":"The raw SyntaxMap
obtained by SourceKitten.
The SwiftLint-specific syntax tokens for this syntax map.
","parent_name":"SwiftLintSyntaxMap"},"Structs/SwiftLintSyntaxMap.html#/s:13SwiftLintCore0aB9SyntaxMapV5valueAC21SourceKittenFramework0dE0V_tcfc":{"name":"init(value:)","abstract":"Creates a SwiftLintSyntaxMap
from the raw SyntaxMap
obtained by SourceKitten.
Returns array of syntax tokens intersecting with byte range.
","parent_name":"SwiftLintSyntaxMap"},"Structs/SwiftLintSyntaxMap.html#/s:13SwiftLintCore0aB9SyntaxMapV5kinds11inByteRangeSay21SourceKittenFramework0D4KindOGAF0hI0V_tF":{"name":"kinds(inByteRange:)","abstract":"Returns the syntax kinds in the specified byte range.
","parent_name":"SwiftLintSyntaxMap"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV14ruleIdentifierSSvp":{"name":"ruleIdentifier","abstract":"The identifier of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV15ruleDescriptionSSvp":{"name":"ruleDescription","abstract":"The description of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV8ruleNameSSvp":{"name":"ruleName","abstract":"The name of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV8severityAA0E8SeverityOvp":{"name":"severity","abstract":"The severity of this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV8locationAA8LocationVvp":{"name":"location","abstract":"The location of this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV6reasonSSvp":{"name":"reason","abstract":"The justification for this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV11descriptionSSvp":{"name":"description","abstract":"A printable description for this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV15ruleDescription8severity8location6reasonAcA04RuleG0V_AA0E8SeverityOAA8LocationVSSSgtcfc":{"name":"init(ruleDescription:severity:location:reason:)","abstract":"Creates a StyleViolation
by specifying its properties directly.
Returns the same violation, but with the severity
that is passed in
Returns the same violation, but with the location
that is passed in
The severity that should be assigned to the violation of this parameter’s value is met.
","parent_name":"RuleParameter"},"Structs/RuleParameter.html#/s:13SwiftLintCore13RuleParameterV5valuexvp":{"name":"value","abstract":"The value to configure the rule.
","parent_name":"RuleParameter"},"Structs/RuleParameter.html#/s:13SwiftLintCore13RuleParameterV8severity5valueACyxGAA17ViolationSeverityO_xtcfc":{"name":"init(severity:value:)","abstract":"Creates a RuleParameter
by specifying its properties directly.
The rules contained in this list.
","parent_name":"RuleList"},"Structs/RuleList.html#/s:13SwiftLintCore8RuleListV5rulesAcA0D0_pXpd_tcfc":{"name":"init(rules:)","abstract":"Creates a RuleList
by specifying all its rules.
Creates a RuleList
by specifying all its rules.
The rule’s unique identifier, to be used in configuration files and SwiftLint commands.","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV4nameSSvp":{"name":"name","abstract":"
The rule’s human-readable name. Should be short, descriptive and formatted in Title Case. May contain spaces.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV11descriptionSSvp":{"name":"description","abstract":"The rule’s verbose description. Should read as a sentence or short paragraph. Good things to include are an","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV4kindAA0D4KindOvp":{"name":"kind","abstract":"
The RuleKind
that best categorizes this rule.
Swift source examples that do not trigger a violation for this rule. Used for documentation purposes to inform","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV18triggeringExamplesSayAA7ExampleVGvp":{"name":"triggeringExamples","abstract":"
Swift source examples that do trigger one or more violations for this rule. Used for documentation purposes to","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV11correctionsSDyAA7ExampleVAFGvp":{"name":"corrections","abstract":"
Pairs of Swift source examples, where keys are examples that trigger violations for this rule, and the values","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV17deprecatedAliasesShySSGvp":{"name":"deprecatedAliases","abstract":"
Any previous iteration of the rule’s identifier that was previously shipped with SwiftLint.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV03minA7VersionAA0aG0Vvp":{"name":"minSwiftVersion","abstract":"The oldest version of the Swift compiler supported by this rule.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV18requiresFileOnDiskSbvp":{"name":"requiresFileOnDisk","abstract":"Whether or not this rule can only be executed on a file physically on-disk. Typically necessary for rules","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV07consoleE0SSvp":{"name":"consoleDescription","abstract":"
The console-printable string for this description.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV14allIdentifiersSaySSGvp":{"name":"allIdentifiers","abstract":"All identifiers that have been used to uniquely identify this rule in past and current SwiftLint versions.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV10identifier4name11description4kind03minA7Version21nonTriggeringExamples010triggeringN011corrections17deprecatedAliases18requiresFileOnDiskACSS_S2SAA0D4KindOAA0aK0VSayAA7ExampleVGATSDyA2SGShySSGSbtcfc":{"name":"init(identifier:name:description:kind:minSwiftVersion:nonTriggeringExamples:triggeringExamples:corrections:deprecatedAliases:requiresFileOnDisk:)","abstract":"Creates a RuleDescription
by specifying all its properties directly.
Configuration with a warning severity.
","parent_name":"SeverityConfiguration"},"Structs/SeverityConfiguration.html#/s:13SwiftLintCore21SeverityConfigurationV7warningACyxGvpZ":{"name":"warning","abstract":"Configuration with an error severity.
","parent_name":"SeverityConfiguration"},"Structs/SeverityConfiguration.html#/s:13SwiftLintCore30SeverityBasedRuleConfigurationP08severityG0AA0dG0Vy6ParentQzGvp":{"name":"severityConfiguration","parent_name":"SeverityConfiguration"},"Structs/SeverityConfiguration.html#/s:13SwiftLintCore21SeverityConfigurationVyACyxGAA09ViolationD0Ocfc":{"name":"init(_:)","abstract":"Create a SeverityConfiguration
with the specified severity.
Severity configurations are special in that they shall not be nested when an option name is provided.","parent_name":"SeverityConfiguration"},"Structs/ConfigurationElement/DeprecationNotice.html#/s:13SwiftLintCore20ConfigurationElementV17DeprecationNoticeO18suggestAlternativeyAEyx_GSS_SStcAGmSQRzs8SendableRzAA012AcceptableBydE0RzlF":{"name":"suggestAlternative(ruleID:name:)","abstract":"
Warning suggesting an alternative option.
","parent_name":"DeprecationNotice"},"Structs/ConfigurationElement/DeprecationNotice.html":{"name":"DeprecationNotice","abstract":"A deprecation notice.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV12wrappedValuexvp":{"name":"wrappedValue","abstract":"Wrapped option value.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV14projectedValueACyxGvp":{"name":"projectedValue","abstract":"The wrapper itself providing access to all its data. This field can only be accessed by the","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV3keySSvp":{"name":"key","abstract":"
Name of this configuration entry.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV6inlineSbvp":{"name":"inline","abstract":"Whether this configuration element will be inlined into its description.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV12wrappedValue3key17deprecationNotice13postprocessorACyxGx_SSAC011DeprecationJ0Oyx_GSgyxzYbctcfc":{"name":"init(wrappedValue:key:deprecationNotice:postprocessor:)","abstract":"Default constructor.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV3keyACyqd__SgGSS_tcAERszSQRd__s8SendableRd__AA012AcceptableBydE0Rd__lufc":{"name":"init(key:)","abstract":"Constructor for optional values.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV12wrappedValue6inlineACyxGx_SbtcAA19InlinableOptionTypeRzrlufc":{"name":"init(wrappedValue:inline:)","abstract":"Constructor for an InlinableOptionType
without a key.
Constructor for an InlinableOptionType
with a name. The configuration will explicitly not be inlined.
An option serving as a marker for an empty configuration description.
","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationOption.html#/s:13SwiftLintCore12DocumentableP10hasContentSbvp":{"name":"hasContent","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationOption.html#/s:13SwiftLintCore12DocumentableP8markdownSSyF":{"name":"markdown()","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationOption.html#/s:13SwiftLintCore12DocumentableP8oneLinerSSyF":{"name":"oneLiner()","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationOption.html#/s:13SwiftLintCore12DocumentableP4yamlSSyF":{"name":"yaml()","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationDescription.html#/s:13SwiftLintCore12DocumentableP10hasContentSbvp":{"name":"hasContent","parent_name":"RuleConfigurationDescription"},"Structs/RuleConfigurationDescription.html#/s:13SwiftLintCore12DocumentableP8oneLinerSSyF":{"name":"oneLiner()","parent_name":"RuleConfigurationDescription"},"Structs/RuleConfigurationDescription.html#/s:13SwiftLintCore12DocumentableP8markdownSSyF":{"name":"markdown()","parent_name":"RuleConfigurationDescription"},"Structs/RuleConfigurationDescription.html#/s:13SwiftLintCore12DocumentableP4yamlSSyF":{"name":"yaml()","parent_name":"RuleConfigurationDescription"},"Structs/Region.html#/s:13SwiftLintCore6RegionV5startAA8LocationVvp":{"name":"start","abstract":"The location describing the start of the region. All locations that are less than this value","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV3endAA8LocationVvp":{"name":"end","abstract":"
The location describing the end of the region. All locations that are greater than this value","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV23disabledRuleIdentifiersShyAA0F10IdentifierOGvp":{"name":"disabledRuleIdentifiers","abstract":"
All SwiftLint rule identifiers that are disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV5start3end23disabledRuleIdentifiersAcA8LocationV_AHShyAA0H10IdentifierOGtcfc":{"name":"init(start:end:disabledRuleIdentifiers:)","abstract":"Creates a Region by setting explicit values for all its properties.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV8containsySbAA8LocationVF":{"name":"contains(_:)","abstract":"Whether the specific location is contained in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV13isRuleEnabledySbxAA0F0RzlF":{"name":"isRuleEnabled(_:)","abstract":"Whether the specified rule is enabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV14isRuleDisabledySbxAA0F0RzlF":{"name":"isRuleDisabled(_:)","abstract":"Whether the specified rule is disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV16areRulesDisabled7ruleIDsSbSaySSG_tF":{"name":"areRulesDisabled(ruleIDs:)","abstract":"Whether the given rules are disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV26deprecatedAliasesDisabling4ruleShySSGx_tAA4RuleRzlF":{"name":"deprecatedAliasesDisabling(rule:)","abstract":"Returns the deprecated rule aliases that are disabling the specified rule in this region.","parent_name":"Region"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4fileSSSgvp":{"name":"file","abstract":"
The file path on disk for this location.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4lineSiSgvp":{"name":"line","abstract":"The line offset in the file for this location. 1-indexed.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV9characterSiSgvp":{"name":"character","abstract":"The character offset in the file for this location. 1-indexed.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV11descriptionSSvp":{"name":"description","abstract":"A lossless printable description of this location.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV12relativeFileSSSgvp":{"name":"relativeFile","abstract":"The file path for this location relative to the current working directory.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4file4line9characterACSSSg_SiSgAHtcfc":{"name":"init(file:line:character:)","abstract":"Creates a Location
by specifying its properties directly.
Creates a Location
based on a SwiftLintFile
and a byte-offset into the file.","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4file8positionAcA0aB4FileC_0A6Syntax16AbsolutePositionVtcfc":{"name":"init(file:position:)","abstract":"
Creates a Location
based on a SwiftLintFile
and a SwiftSyntax AbsolutePosition
into the file.","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4file15characterOffsetAcA0aB4FileC_Sitcfc":{"name":"init(file:characterOffset:)","abstract":"
Creates a Location
based on a SwiftLintFile
and a UTF8 character-offset into the file.","parent_name":"Location"},"Structs/Location.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"Location"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV4codeSSvp":{"name":"code","abstract":"
The contents of the example
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV13configurationSDySSs8Sendable_pGSgvp":{"name":"configuration","abstract":"The untyped configuration to apply to the rule, if deviating from the default configuration.","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV20testMultiByteOffsetsSbvp":{"name":"testMultiByteOffsets","abstract":"
Whether the example should be tested by prepending multibyte grapheme clusters
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV11testOnLinuxSbvp":{"name":"testOnLinux","abstract":"Whether the example should be tested on Linux
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV4files12StaticStringVvp":{"name":"file","abstract":"The path to the file where the example was created
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV4lineSuvp":{"name":"line","abstract":"The line in the file where the example was created
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV_13configuration20testMultiByteOffsets0F17WrappingInComment0fjK6String0F14DisableCommand0F7OnLinux4file4line24excludeFromDocumentationACSS_SDySSs8Sendable_pGSgS5bs06StaticM0VSuSbtcfc":{"name":"init(_:configuration:testMultiByteOffsets:testWrappingInComment:testWrappingInString:testDisableCommand:testOnLinux:file:line:excludeFromDocumentation:)","abstract":"Create a new Example with the specified code, file, and line.
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV4with4codeACSS_tF":{"name":"with(code:)","abstract":"Returns the same example, but with the code
that is passed in
Returns a copy of the Example with all instances of the “↓” character removed.
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV7focusedACyF":{"name":"focused()","abstract":"Makes the current example focused. This is for debugging purposes only.
","parent_name":"Example"},"Structs/Example.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"Example"},"Structs/Example.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"Example"},"Structs/Example.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"Example"},"Structs/Correction.html#/s:13SwiftLintCore10CorrectionV15ruleDescriptionAA04RuleF0Vvp":{"name":"ruleDescription","abstract":"The description of the rule for which this correction was applied.
","parent_name":"Correction"},"Structs/Correction.html#/s:13SwiftLintCore10CorrectionV8locationAA8LocationVvp":{"name":"location","abstract":"The location of the original violation that was corrected.
","parent_name":"Correction"},"Structs/Correction.html#/s:13SwiftLintCore10CorrectionV18consoleDescriptionSSvp":{"name":"consoleDescription","abstract":"The console-printable description for this correction.
","parent_name":"Correction"},"Structs/Correction.html#/s:13SwiftLintCore10CorrectionV15ruleDescription8locationAcA04RuleF0V_AA8LocationVtcfc":{"name":"init(ruleDescription:location:)","abstract":"Memberwise initializer.
","parent_name":"Correction"},"Structs/Command/Modifier.html#/s:13SwiftLintCore7CommandV8ModifierO8previousyA2EmF":{"name":"previous","abstract":"The command should only apply to the line preceding its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:13SwiftLintCore7CommandV8ModifierO4thisyA2EmF":{"name":"this","abstract":"The command should only apply to the same line as its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:13SwiftLintCore7CommandV8ModifierO4nextyA2EmF":{"name":"next","abstract":"The command should only apply to the line following its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:13SwiftLintCore7CommandV8ModifierO7invalidyA2EmF":{"name":"invalid","abstract":"The modifier string was invalid.
","parent_name":"Modifier"},"Structs/Command/Action.html#/s:13SwiftLintCore7CommandV6ActionO6enableyA2EmF":{"name":"enable","abstract":"The rule(s) associated with this command should be enabled by the SwiftLint engine.
","parent_name":"Action"},"Structs/Command/Action.html#/s:13SwiftLintCore7CommandV6ActionO7disableyA2EmF":{"name":"disable","abstract":"The rule(s) associated with this command should be disabled by the SwiftLint engine.
","parent_name":"Action"},"Structs/Command/Action.html#/s:13SwiftLintCore7CommandV6ActionO7invalidyA2EmF":{"name":"invalid","abstract":"The action string was invalid.
","parent_name":"Action"},"Structs/Command/Action.html":{"name":"Action","abstract":"The action (verb) that SwiftLint should perform when interpreting this command.
","parent_name":"Command"},"Structs/Command/Modifier.html":{"name":"Modifier","abstract":"The modifier for a command, used to modify its scope.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV6actionAC6ActionOvp":{"name":"action","abstract":"The action (verb) that SwiftLint should perform when interpreting this command.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV15ruleIdentifiersShyAA14RuleIdentifierOGvp":{"name":"ruleIdentifiers","abstract":"The identifiers for the rules associated with this command.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV4lineSivp":{"name":"line","abstract":"The line in the source file where this command is defined.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV9characterSiSgvp":{"name":"character","abstract":"The character offset within the line in the source file where this command is defined.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV8modifierAC8ModifierOSgvp":{"name":"modifier","abstract":"This command’s modifier, if any.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV6action15ruleIdentifiers4line9character8modifier15trailingCommentA2C6ActionO_ShyAA14RuleIdentifierOGS2iSgAC8ModifierOSgSSSgtcfc":{"name":"init(action:ruleIdentifiers:line:character:modifier:trailingComment:)","abstract":"Creates a command based on the specified parameters.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV12actionString4line9characterACSS_S2itcfc":{"name":"init(actionString:line:character:)","abstract":"Creates a command based on the specified parameters.
","parent_name":"Command"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32ChildOptionSeverityConfigurationV5errorACyxGvpZ":{"name":"error","abstract":"Configuration with a warning severity.
","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32ChildOptionSeverityConfigurationV7warningACyxGvpZ":{"name":"warning","abstract":"Configuration with an error severity.
","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32ChildOptionSeverityConfigurationV3offACyxGvpZ":{"name":"off","abstract":"Configuration disabling an option.
","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32ChildOptionSeverityConfigurationV8severityAA09ViolationF0OSgvp":{"name":"severity","abstract":"The ChildOptionSeverityConfiguration
mapped to a usually used ViolationSeverity
. It’s nil
if the option","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP5apply13configurationyyp_tKF":{"name":"apply(configuration:)","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"ChildOptionSeverityConfiguration"},"Structs/Baseline.html#/s:13SwiftLintCore8BaselineV10violationsSayAA14StyleViolationVGvp":{"name":"violations","abstract":"
The stored violations.
","parent_name":"Baseline"},"Structs/Baseline.html#/s:13SwiftLintCore8BaselineV8fromPathACSS_tKcfc":{"name":"init(fromPath:)","abstract":"Creates a Baseline
from a saved file.
Creates a Baseline
from a list of violations.
Writes a Baseline
to disk in JSON format.
Filters out violations that are present in the Baseline
.
Returns the violations that are present in another Baseline
, but not in this one.
Creates an empty Stack
.
The number of elements in this stack.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV4pushyyxF":{"name":"push(_:)","abstract":"Pushes (appends) an element onto the stack.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV3popxSgyF":{"name":"pop()","abstract":"Removes and returns the last element of the stack.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV4peekxSgyF":{"name":"peek()","abstract":"Returns the last element of the stack if the stack is not empty; otherwise, nil.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV8contains5whereS2bxXE_tF":{"name":"contains(where:)","abstract":"Check whether the sequence contains an element that satisfies the given predicate.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV10modifyLast2byyyxzXE_tF":{"name":"modifyLast(by:)","abstract":"Modify the last element.
","parent_name":"Stack"},"Structs/Stack.html#/s:ST12makeIterator0B0QzyF":{"name":"makeIterator()","parent_name":"Stack"},"Structs/Stack.html#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp":{"name":"debugDescription","parent_name":"Stack"},"Structs/Stack.html":{"name":"Stack","abstract":"A basic stack type implementing the LIFO principle - only the last inserted element can be accessed and removed.
"},"Structs/Baseline.html":{"name":"Baseline","abstract":"A set of violations that can be used to filter newly detected violations.
"},"Structs/ChildOptionSeverityConfiguration.html":{"name":"ChildOptionSeverityConfiguration","abstract":"A rule configuration that allows to disable (off
) an option of a rule or specify its severity level in which"},"Structs/Command.html":{"name":"Command","abstract":"
A SwiftLint-interpretable command to modify SwiftLint’s behavior embedded as comments in source code.
"},"Structs/Correction.html":{"name":"Correction","abstract":"A value describing a SwiftLint violation that was corrected.
"},"Structs/Example.html":{"name":"Example","abstract":"Captures code and context information for an example of a triggering or"},"Structs/Location.html":{"name":"Location","abstract":"
The placement of a segment of Swift in a collection of source files.
"},"Structs/Region.html":{"name":"Region","abstract":"A contiguous region of Swift source code.
"},"Structs/RuleConfigurationDescription.html":{"name":"RuleConfigurationDescription","abstract":"Description of a rule configuration.
"},"Structs/RuleConfigurationOption.html":{"name":"RuleConfigurationOption","abstract":"A single option of a RuleConfigurationDescription
.
A result builder creating configuration descriptions.
"},"Structs/ConfigurationElement.html":{"name":"ConfigurationElement","abstract":"A single parameter of a rule configuration.
"},"Structs/SeverityConfiguration.html":{"name":"SeverityConfiguration","abstract":"A rule configuration that allows specifying the desired severity level for violations.
"},"Structs/RuleDescription.html":{"name":"RuleDescription","abstract":"A detailed description for a SwiftLint rule. Used for both documentation and testing purposes.
"},"Structs/RuleList.html":{"name":"RuleList","abstract":"A list of available SwiftLint rules.
"},"Structs/RuleParameter.html":{"name":"RuleParameter","abstract":"A configuration parameter for rules.
"},"Structs/StyleViolation.html":{"name":"StyleViolation","abstract":"A value describing an instance of Swift source code that is considered invalid by a SwiftLint rule.
"},"Structs/SwiftLintSyntaxMap.html":{"name":"SwiftLintSyntaxMap","abstract":"Represents a Swift file’s syntax information.
"},"Structs/SwiftLintSyntaxToken.html":{"name":"SwiftLintSyntaxToken","abstract":"A SwiftLint-aware Swift syntax token.
"},"Structs/SwiftVersion.html":{"name":"SwiftVersion","abstract":"A value describing the version of the Swift compiler.
"},"Structs/ReasonedRuleViolation.html":{"name":"ReasonedRuleViolation","abstract":"A violation produced by ViolationsSyntaxVisitor
s.
A rule configuration used for defining custom rules in yaml.
"},"Structs/SeverityLevelsConfiguration.html":{"name":"SeverityLevelsConfiguration","abstract":"A rule configuration that allows specifying thresholds for warning
and error
severities.
Produce a ViolationsSyntaxVisitor
for the given file.
Produce a violation for the given file and absolute position.
","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxRule.html#/s:13SwiftLintCore0A10SyntaxRuleP10preprocess4file0aD0010SourceFileD0VSgAA0abI0C_tF":{"name":"preprocess(file:)","abstract":"Gives a chance for the rule to do some pre-processing on the syntax tree.","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxRule.html#/s:13SwiftLintCore4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxCorrectableRule.html#/s:13SwiftLintCore0A21SyntaxCorrectableRuleP12makeRewriter4fileAA010ViolationsdH0Cy17ConfigurationTypeQzGSgAA0aB4FileC_tF":{"name":"makeRewriter(file:)","abstract":"
Produce a ViolationsSyntaxRewriter
for the given file.
The configuration of a rule’s severity.
","parent_name":"SeverityBasedRuleConfiguration"},"Protocols/SeverityBasedRuleConfiguration.html#/s:13SwiftLintCore30SeverityBasedRuleConfigurationPAAE8severityAA09ViolationD0Ovp":{"name":"severity","abstract":"The severity of a rule.
","parent_name":"SeverityBasedRuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP6ParentQa":{"name":"Parent","abstract":"The type of the rule that’s using this configuration.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP20parameterDescriptionAA0deG0VSgvp":{"name":"parameterDescription","abstract":"A description for this configuration’s parameters. It can be built using the annotated result builder.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP5apply13configurationyyp_tKF":{"name":"apply(configuration:)","abstract":"Apply an untyped configuration to the current value.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP8validateyyKF":{"name":"validate()","abstract":"Run a sanity check on the configuration, perform optional postprocessing steps and/or warn about potential","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationPAAE13supportedKeysShySSGvp":{"name":"supportedKeys","abstract":"
All keys supported by this configuration.
","parent_name":"RuleConfiguration"},"Protocols/AnalyzerRule.html#/s:13SwiftLintCore4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"AnalyzerRule"},"Protocols/SubstitutionCorrectableRule.html#/s:13SwiftLintCore27SubstitutionCorrectableRuleP15violationRanges2inSaySo8_NSRangeVGAA0aB4FileC_tF":{"name":"violationRanges(in:)","abstract":"Returns the NSString-based NSRange
s to be replaced in the specified file.
Returns the substitution to apply for the given range.
","parent_name":"SubstitutionCorrectableRule"},"Protocols/SubstitutionCorrectableRule.html#/s:13SwiftLintCore15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","parent_name":"SubstitutionCorrectableRule"},"Protocols/CorrectableRule.html#/s:13SwiftLintCore15CorrectableRuleP7correct4file17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_SaySSGtF":{"name":"correct(file:compilerArguments:)","abstract":"Attempts to correct the violations to this rule in the specified file.
","parent_name":"CorrectableRule"},"Protocols/CorrectableRule.html#/s:13SwiftLintCore15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","abstract":"Attempts to correct the violations to this rule in the specified file.
","parent_name":"CorrectableRule"},"Protocols/CorrectableRule.html#/s:13SwiftLintCore15CorrectableRuleP7correct4file5using17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_AA0E7StorageCSaySSGtF":{"name":"correct(file:using:compilerArguments:)","abstract":"Attempts to correct the violations to this rule in the specified file after collecting file info for all files","parent_name":"CorrectableRule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP17ConfigurationTypeQa":{"name":"ConfigurationType","abstract":"
The type of the configuration used to configure this rule.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP11descriptionAA0D11DescriptionVvpZ":{"name":"description","abstract":"A verbose description of many of this rule’s properties.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP13configuration17ConfigurationTypeQzvp":{"name":"configuration","abstract":"This rule’s configuration.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP06shouldB10EmptyFilesSbvp":{"name":"shouldLintEmptyFiles","abstract":"Whether this rule should be used on empty files. Defaults to false
.
A default initializer for rules. All rules need to be trivially initializable.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP13configurationxyp_tKcfc":{"name":"init(configuration:)","abstract":"Creates a rule by applying its configuration.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP30createConfigurationDescription16exclusiveOptionsAA0dfG0VShySSG_tF":{"name":"createConfigurationDescription(exclusiveOptions:)","abstract":"Create a description of how this rule has been configured to run.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP8validate4file17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_SaySSGtF":{"name":"validate(file:compilerArguments:)","abstract":"Executes the rule on a file and returns any violations to the rule’s expectations.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","abstract":"Executes the rule on a file and returns any violations to the rule’s expectations.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP9isEqualToySbAaB_pF":{"name":"isEqualTo(_:)","abstract":"Whether or not the specified rule is equivalent to the current rule.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP11collectInfo3for4into17compilerArgumentsyAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"collectInfo(for:into:compilerArguments:)","abstract":"Collects information for the specified file in a storage object, to be analyzed by a CollectedLinter
.
Executes the rule on a file after collecting file info for all files and returns any violations to the rule’s","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP13canBeDisabled9violation2bySbAA14StyleViolationV_AA0D10IdentifierOtF":{"name":"canBeDisabled(violation:by:)","abstract":"
Checks if a style violation can be disabled by a command specifying a rule ID. Only the rule can claim that for","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP9isEnabled2in3forSbAA6RegionV_SStF":{"name":"isEnabled(in:for:)","abstract":"
Checks if a the rule is enabled in a given region. A specific rule ID can be provided in case a rule supports","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RulePAAE16cacheDescriptionSSvp":{"name":"cacheDescription","abstract":"
The cache description which will be used to determine if a previous","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RulePAAE10identifierSSvpZ":{"name":"identifier","abstract":"
The rule’s unique identifier which is the same as Rule.description.identifier
.
The kind of information to collect for each file being linted for this rule.
","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore14CollectingRuleP11collectInfo3for17compilerArguments04FileG0QzAA0abK0C_SaySSGtF":{"name":"collectInfo(for:compilerArguments:)","abstract":"Collects information for the specified file, to be analyzed by a CollectedLinter
.
Collects information for the specified file, to be analyzed by a CollectedLinter
.
Executes the rule on a file after collecting file info for all files and returns any violations to the rule’s","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore14CollectingRuleP8validate4file13collectedInfoSayAA14StyleViolationVGAA0aB4FileC_SDyAK0lI0QzGtF":{"name":"validate(file:collectedInfo:)","abstract":"
Executes the rule on a file after collecting file info for all files and returns any violations to the rule’s","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore4RuleP11collectInfo3for4into17compilerArgumentsyAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"collectInfo(for:into:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore4RuleP8validate4file5using17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"validate(file:using:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore4RuleP8validate4file17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_SaySSGtF":{"name":"validate(file:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CacheDescriptionProvider.html#/s:13SwiftLintCore24CacheDescriptionProviderP05cacheE0SSvp":{"name":"cacheDescription","abstract":"
The cache description which will be used to determine if a previous","parent_name":"CacheDescriptionProvider"},"Protocols/ASTRule.html#/s:13SwiftLintCore7ASTRuleP8KindTypeQa":{"name":"KindType","abstract":"
The kind of token being recursed over.
","parent_name":"ASTRule"},"Protocols/ASTRule.html#/s:13SwiftLintCore7ASTRuleP8validate4file4kind10dictionarySayAA14StyleViolationVGAA0aB4FileC_8KindTypeQzAA22SourceKittenDictionaryVtF":{"name":"validate(file:kind:dictionary:)","abstract":"Executes the rule on a file and a subset of its AST structure, returning any violations to the rule’s","parent_name":"ASTRule"},"Protocols/ASTRule.html#/s:13SwiftLintCore7ASTRuleP4kind4from8KindTypeQzSgAA22SourceKittenDictionaryV_tF":{"name":"kind(from:)","abstract":"
Get the kind
from the specified dictionary.
Executes the rule on a file and a subset of its AST structure, returning any violations to the rule’s","parent_name":"ASTRule"},"Protocols/VersionComparable.html#/s:13SwiftLintCore17VersionComparableP8rawValueSSvp":{"name":"rawValue","abstract":"
The version string.
","parent_name":"VersionComparable"},"Protocols/VersionComparable.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"VersionComparable"},"Protocols/VersionComparable.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"VersionComparable"},"Protocols/AcceptableByConfigurationElement.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","abstract":"Initializer taking a value from a configuration to create an element of Self
.
Make the object an option.
","parent_name":"AcceptableByConfigurationElement"},"Protocols/AcceptableByConfigurationElement.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP13asDescription4withAA04RulefI0VSS_tF":{"name":"asDescription(with:)","abstract":"Make the object a description.
","parent_name":"AcceptableByConfigurationElement"},"Protocols/AcceptableByConfigurationElement.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP5apply_6ruleIDyyp_SStKF":{"name":"apply(_:ruleID:)","abstract":"Update the object.
","parent_name":"AcceptableByConfigurationElement"},"Protocols/Documentable.html#/s:13SwiftLintCore12DocumentableP8markdownSSyF":{"name":"markdown()","abstract":"Convert an object to Markdown.
","parent_name":"Documentable"},"Protocols/Documentable.html#/s:13SwiftLintCore12DocumentableP8oneLinerSSyF":{"name":"oneLiner()","abstract":"Convert an object to a single line string.
","parent_name":"Documentable"},"Protocols/Documentable.html#/s:13SwiftLintCore12DocumentableP10hasContentSbvp":{"name":"hasContent","abstract":"Indicate if the item has some content that is useful to document.
","parent_name":"Documentable"},"Protocols/Documentable.html#/s:13SwiftLintCore12DocumentableP4yamlSSyF":{"name":"yaml()","abstract":"Convert an object to YAML as used in .swiftlint.yml
.
A type that can be converted into a human-readable representation.
"},"Protocols/AcceptableByConfigurationElement.html":{"name":"AcceptableByConfigurationElement","abstract":"Type of an object that can be used as a configuration element.
"},"Protocols.html#/s:13SwiftLintCore19InlinableOptionTypeP":{"name":"InlinableOptionType","abstract":"An option type that can appear inlined into its using configuration.
"},"Protocols/VersionComparable.html":{"name":"VersionComparable","abstract":"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"},"Protocols/CacheDescriptionProvider.html":{"name":"CacheDescriptionProvider","abstract":"
Interface providing access to a cache description.
"},"Protocols.html#/s:13SwiftLintCore17AnyCollectingRuleP":{"name":"AnyCollectingRule","abstract":"Type-erased protocol used to check whether a rule is collectable.
"},"Protocols/CollectingRule.html":{"name":"CollectingRule","abstract":"A rule that requires knowledge of all other files being linted.
"},"Protocols/Rule.html":{"name":"Rule","abstract":"An executable value that can identify issues (violations) in Swift source code.
"},"Protocols.html#/s:13SwiftLintCore9OptInRuleP":{"name":"OptInRule","abstract":"A rule that is not enabled by default. Rules conforming to this need to be explicitly enabled by users.
"},"Protocols/CorrectableRule.html":{"name":"CorrectableRule","abstract":"A rule that can correct violations.
"},"Protocols/SubstitutionCorrectableRule.html":{"name":"SubstitutionCorrectableRule","abstract":"A correctable rule that can apply its corrections by replacing the content of ranges in the offending file with"},"Protocols.html#/s:13SwiftLintCore17SourceKitFreeRuleP":{"name":"SourceKitFreeRule","abstract":"
A rule that does not need SourceKit to operate and can still operate even after SourceKit has crashed.
"},"Protocols/AnalyzerRule.html":{"name":"AnalyzerRule","abstract":"A rule that can operate on the post-typechecked AST using compiler arguments. Performs rules that are more like"},"Protocols/RuleConfiguration.html":{"name":"RuleConfiguration","abstract":"
A configuration value for a rule to allow users to modify its behavior.
"},"Protocols/SeverityBasedRuleConfiguration.html":{"name":"SeverityBasedRuleConfiguration","abstract":"A configuration for a rule that allows to configure at least the severity.
"},"Protocols/SwiftSyntaxCorrectableRule.html":{"name":"SwiftSyntaxCorrectableRule","abstract":"A SwiftLint CorrectableRule that performs its corrections using a SwiftSyntax SyntaxRewriter
.
A SwiftLint Rule backed by SwiftSyntax that does not use SourceKit requests.
"},"Extensions/Double.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Double"},"Extensions/Double.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Double"},"Extensions/Int.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Int"},"Extensions/Int.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Int"},"Extensions/Set.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Set"},"Extensions/Set.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Set"},"Extensions/String.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"String"},"Extensions/String.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"String"},"Extensions/Bool.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Bool"},"Extensions/Bool.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Bool"},"Extensions/Optional.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Optional"},"Extensions/Optional.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Optional"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE26skipWrappingInCommentTestsSayACGyF":{"name":"skipWrappingInCommentTests()","abstract":"Make these examples skip wrapping in comment tests.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE25skipWrappingInStringTestsSayACGyF":{"name":"skipWrappingInStringTests()","abstract":"Make these examples skip wrapping in string tests.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE24skipMultiByteOffsetTestsSayACGyF":{"name":"skipMultiByteOffsetTests()","abstract":"Make these examples skip multi-byte offset tests.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE23skipDisableCommandTestsSayACGyF":{"name":"skipDisableCommandTests()","abstract":"Make these examples skip disable command tests.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE23removingViolationMarkerSayACGyF":{"name":"removingViolationMarker()","abstract":"Remove all violation markers from the examples.
","parent_name":"Array"},"Extensions/Array.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Array"},"Extensions/Array.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA0aB11SyntaxTokenVRszlE5kindsSay21SourceKittenFramework0D4KindOGvp":{"name":"kinds","abstract":"The kinds for these tokens.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA21ReasonedRuleViolationVRszlE6appendyy0A6Syntax16AbsolutePositionVF":{"name":"append(_:)","abstract":"Add a violation at the specified position using the default description and severity.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA21ReasonedRuleViolationVRszlE6append2at10correctiony0A6Syntax16AbsolutePositionV_AC0F10CorrectionVSgtF":{"name":"append(at:correction:)","abstract":"Add a violation and the correction at the specified position using the default description and severity.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA21ReasonedRuleViolationVRszlE6append10contentsOfySay0A6Syntax16AbsolutePositionVG_tF":{"name":"append(contentsOf:)","abstract":"Add violations for the specified positions using the default description and severity.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCore0A6Syntax04DeclD8Protocol_pXpRszlE3allSayAbC_pXpGvpZ":{"name":"all","abstract":"All visitable declaration syntax types.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCore0A6Syntax04DeclD8Protocol_pXpRszlE9allExceptySayAbC_pXpGAbC_pXpd_tFZ":{"name":"allExcept(_:)","abstract":"All declarations except for the specified ones.
","parent_name":"Array"},"Extensions/Array.html":{"name":"Array"},"Extensions/Optional.html":{"name":"Optional"},"Extensions/Bool.html":{"name":"Bool"},"Extensions/String.html":{"name":"String"},"Extensions/Set.html":{"name":"Set"},"Extensions/Int.html":{"name":"Int"},"Extensions/Double.html":{"name":"Double"},"Enums/IdentifierDeclaration.html#/s:13SwiftLintCore21IdentifierDeclarationO9parameteryAC0A6Syntax05TokenG0V_tcACmF":{"name":"parameter(name:)","abstract":"Parameter declaration with a name token.
","parent_name":"IdentifierDeclaration"},"Enums/IdentifierDeclaration.html#/s:13SwiftLintCore21IdentifierDeclarationO13localVariableyAC0A6Syntax05TokenH0V_tcACmF":{"name":"localVariable(name:)","abstract":"Local variable declaration with a name token.
","parent_name":"IdentifierDeclaration"},"Enums/IdentifierDeclaration.html#/s:13SwiftLintCore21IdentifierDeclarationO16implicitVariableyACSS_tcACmF":{"name":"implicitVariable(name:)","abstract":"A variable that is implicitly added by the compiler (e.g. error
in catch
clauses).
A variable hidden from scope because its name is a wildcard _
.
Special case that marks a type boundary at which name lookup stops.
","parent_name":"IdentifierDeclaration"},"Enums/IdentifierDeclaration.html#/s:13SwiftLintCore21IdentifierDeclarationO8declares2id18disregardBackticksSbSS_SbtF":{"name":"declares(id:disregardBackticks:)","abstract":"Check whether self declares a variable given by name.
","parent_name":"IdentifierDeclaration"},"Enums/ViolationSeverity.html#/s:13SwiftLintCore17ViolationSeverityO7warningyA2CmF":{"name":"warning","abstract":"Non-fatal. If using SwiftLint as an Xcode build phase, Xcode will mark the build as having succeeded.
","parent_name":"ViolationSeverity"},"Enums/ViolationSeverity.html#/s:13SwiftLintCore17ViolationSeverityO5erroryA2CmF":{"name":"error","abstract":"Fatal. If using SwiftLint as an Xcode build phase, Xcode will mark the build as having failed.
","parent_name":"ViolationSeverity"},"Enums/ViolationSeverity.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"ViolationSeverity"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO4callyA2CmF":{"name":"call","abstract":"A call to a named function or closure.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO8argumentyA2CmF":{"name":"argument","abstract":"An argument value for a function or closure.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO5arrayyA2CmF":{"name":"array","abstract":"An Array expression.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO10dictionaryyA2CmF":{"name":"dictionary","abstract":"A Dictionary expression.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO13objectLiteralyA2CmF":{"name":"objectLiteral","abstract":"An object literal expression. https://developer.apple.com/swift/blog/?id=33
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO7closureyA2CmF":{"name":"closure","abstract":"A closure expression. https://docs.swift.org/swift-book/LanguageGuide/Closures.html
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO5tupleyA2CmF":{"name":"tuple","abstract":"A tuple expression. https://docs.swift.org/swift-book/ReferenceManual/Types.html#ID448
","parent_name":"SwiftExpressionKind"},"Enums/RuleListError.html#/s:13SwiftLintCore13RuleListErrorO24duplicatedConfigurationsyAcA0D0_pXp_tcACmF":{"name":"duplicatedConfigurations(rule:)","abstract":"The rule list contains more than one configuration for the specified rule.
","parent_name":"RuleListError"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO4lintyA2CmF":{"name":"lint","abstract":"Describes rules that validate Swift source conventions.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO9idiomaticyA2CmF":{"name":"idiomatic","abstract":"Describes rules that validate common practices in the Swift community.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO5styleyA2CmF":{"name":"style","abstract":"Describes rules that validate stylistic choices.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO7metricsyA2CmF":{"name":"metrics","abstract":"Describes rules that validate magnitudes or measurements of Swift source.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO11performanceyA2CmF":{"name":"performance","abstract":"Describes rules that validate that code patterns with poor performance are avoided.
","parent_name":"RuleKind"},"Enums/RuleIdentifier.html#/s:13SwiftLintCore14RuleIdentifierO3allyA2CmF":{"name":"all","abstract":"Special identifier that should be treated as referring to ‘all’ SwiftLint rules. One helpful usecase is in","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:13SwiftLintCore14RuleIdentifierO6singleyACSS_tcACmF":{"name":"single(identifier:)","abstract":"
Represents a single SwiftLint rule with the specified identifier.
","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:13SwiftLintCore14RuleIdentifierO20stringRepresentationSSvp":{"name":"stringRepresentation","abstract":"The spelling of the string for this identifier.
","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:13SwiftLintCore14RuleIdentifierOyACSScfc":{"name":"init(_:)","abstract":"Creates a RuleIdentifier
by its string representation.
An irrelevant option. It will be ignored in documentation serialization.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO4flagyACSbcACmF":{"name":"flag(_:)","abstract":"A boolean flag.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO6stringyACSScACmF":{"name":"string(_:)","abstract":"A string option.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO6symbolyACSScACmF":{"name":"symbol(_:)","abstract":"Like a string option but without quotes in the serialized output.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO7integeryACSicACmF":{"name":"integer(_:)","abstract":"An integer option.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO5floatyACSdcACmF":{"name":"float(_:)","abstract":"A floating point number option.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO8severityyAcA17ViolationSeverityOcACmF":{"name":"severity(_:)","abstract":"Special option for a ViolationSeverity
.
A list of options.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO6nestedyAcA28RuleConfigurationDescriptionVcACmF":{"name":"nested(_:)","abstract":"An option which is another set of configuration options to be nested in the serialized output.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore12DocumentableP10hasContentSbvp":{"name":"hasContent","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore12DocumentableP8markdownSSyF":{"name":"markdown()","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore12DocumentableP8oneLinerSSyF":{"name":"oneLiner()","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore12DocumentableP4yamlSSyF":{"name":"yaml()","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO2egoiyAA017RuleConfigurationD0VSS_ACtFZ":{"name":"=>(_:_:)","abstract":"Operator enabling an easy way to create a configuration option.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO4nestyAcA28RuleConfigurationDescriptionVyXEFZ":{"name":"nest(_:)","abstract":"Create an option defined by nested configuration description.
","parent_name":"OptionType"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO20invalidConfigurationyACSS_SSSgtcACmF":{"name":"invalidConfiguration(ruleID:message:)","abstract":"The configuration didn’t match internal expectations.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO29deprecatedConfigurationOptionyACSS_S2SSgtcACmF":{"name":"deprecatedConfigurationOption(ruleID:key:alternative:)","abstract":"Issued when an option is deprecated. Suggests an alternative optionally.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO14nothingAppliedyACSS_tcACmF":{"name":"nothingApplied(ruleID:)","abstract":"Used in configuration parsing when no changes have been applied. Use only internally!
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO18listedMultipleTimeyACSS_SitcACmF":{"name":"listedMultipleTime(ruleID:times:)","abstract":"Rule is listed multiple times in the configuration.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO17renamedIdentifieryACSS_SStcACmF":{"name":"renamedIdentifier(old:new:)","abstract":"An identifier old
has been renamed to new
.
Some configuration keys are invalid.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO25inconsistentConfigurationyACSS_SStcACmF":{"name":"inconsistentConfiguration(ruleID:message:)","abstract":"The configuration is inconsistent, that is options are mutually exclusive or one drives other values","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO14invalidRuleIDsyACShySSGcACmF":{"name":"invalidRuleIDs(_:)","abstract":"
Used rule IDs are invalid.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO25ruleNotPresentInOnlyRulesyACSS_tcACmF":{"name":"ruleNotPresentInOnlyRules(ruleID:)","abstract":"Found a rule configuration for a rule that is not present in only_rules
.
Found a rule configuration for a rule that is disabled.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO33ruleDisabledInParentConfigurationyACSS_tcACmF":{"name":"ruleDisabledInParentConfiguration(ruleID:)","abstract":"Found a rule configuration for a rule that is disabled in the parent configuration.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO019ruleNotEnabledInOptH5RulesyACSS_tcACmF":{"name":"ruleNotEnabledInOptInRules(ruleID:)","abstract":"Found a rule configuration for a rule that is not enabled in opt_in_rules
.
Found a rule configuration for a rule that is not enabled in parent only_rules
.
A generic warning specified by a string.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO12genericErroryACSScACmF":{"name":"genericError(_:)","abstract":"A generic error specified by a string.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO14ruleDeprecatedyACSS_tcACmF":{"name":"ruleDeprecated(ruleID:)","abstract":"A deprecation warning for a rule.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO19initialFileNotFoundyACSS_tcACmF":{"name":"initialFileNotFound(path:)","abstract":"The initial configuration file was not found.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO12fileNotFoundyACSS_tcACmF":{"name":"fileNotFound(path:)","abstract":"A file at specified path was not found.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO15fileNotReadableyACSSSg_SStcACmF":{"name":"fileNotReadable(path:ruleID:)","abstract":"The file at path
is not readable or cannot be opened.
The file at path
is not writable.
The file at path
cannot be indexed by a specific rule.
No arguments were provided to compile a file at path
within a specific rule.
Cursor information cannot be extracted from a specific location.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO11yamlParsingyACSScACmF":{"name":"yamlParsing(_:)","abstract":"An error that occurred when parsing YAML.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO19baselineNotReadableyACSS_tcACmF":{"name":"baselineNotReadable(path:)","abstract":"The baseline file at path
is not readable or cannot be opened.
Print the issue to the console.
","parent_name":"Issue"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO7privateyA2CmF":{"name":"private","abstract":"Accessible by the declaration’s immediate lexical scope.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO11fileprivateyA2CmF":{"name":"fileprivate","abstract":"Accessible by the declaration’s same file.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO8internalyA2CmF":{"name":"internal","abstract":"Accessible by the declaration’s same module, or modules importing it with the @testable
attribute.
Accessible by all the modules defined in the same Swift package.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO6publicyA2CmF":{"name":"public","abstract":"Accessible by the declaration’s same program.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO4openyA2CmF":{"name":"open","abstract":"Accessible and customizable (via subclassing or overrides) by the declaration’s same program.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO11descriptionACSgSS_tcfc":{"name":"init(description:)","abstract":"Initializes an access control level by its Swift source keyword value.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO9isPrivateSbvp":{"name":"isPrivate","abstract":"Returns true if is private
or fileprivate
The accessibility of a Swift source declaration.
"},"Enums/Issue.html":{"name":"Issue","abstract":"All possible SwiftLint issues which are printed as warnings by default.
"},"Enums/OptionType.html":{"name":"OptionType","abstract":"Type of an option.
"},"Enums/RuleIdentifier.html":{"name":"RuleIdentifier","abstract":"An identifier representing a SwiftLint rule, or all rules.
"},"Enums/RuleKind.html":{"name":"RuleKind","abstract":"All the possible rule kinds (categories).
"},"Enums/RuleListError.html":{"name":"RuleListError","abstract":"All possible rule list configuration errors.
"},"Enums/SwiftExpressionKind.html":{"name":"SwiftExpressionKind","abstract":"The kind of expression for a contiguous set of Swift source tokens.
"},"Enums/ViolationSeverity.html":{"name":"ViolationSeverity","abstract":"The magnitude of a StyleViolation
.
An identifier declaration.
"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC13configurationxvp":{"name":"configuration","abstract":"A rule’s configuration.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC4fileAA0aB4FileCvp":{"name":"file","abstract":"The file from which the traversed syntax tree stems from.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC17locationConverter0aE0014SourceLocationH0Cvp":{"name":"locationConverter","abstract":"A source location converter associated with the syntax tree being traversed.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC13configuration4fileACyxGx_AA0aB4FileCtcfc":{"name":"init(configuration:file:)","abstract":"Initializer for a ViolationsSyntaxVisitor
.
Positions in a source file where violations should be reported.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC21skippableDeclarationsSay0aE004DeclE8Protocol_pXpGvp":{"name":"skippableDeclarations","abstract":"List of declaration types that shall be skipped while traversing the AST.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE09ActorDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE09ClassDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE08EnumDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE013ExtensionDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE012FunctionDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE015InitializerDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE012ProtocolDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE010StructDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE013SubscriptDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE012VariableDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC5Scopea":{"name":"Scope","abstract":"A type that remembers the declared identifiers (in order) up to the current position in the code.
","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC5scopeAA5StackVySayAA21IdentifierDeclarationOGGvp":{"name":"scope","abstract":"The hierarchical stack of identifiers declared up to the current position in the code.
","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC13configuration4file5scopeACyxGx_AA0aB4FileCAA5StackVySayAA21IdentifierDeclarationOGGtcfc":{"name":"init(configuration:file:scope:)","abstract":"Initializer.
","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC18hasSeenDeclaration3forSbSS_tF":{"name":"hasSeenDeclaration(for:)","abstract":"Indicate whether a given identifier is in scope.
","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC5visity0A6Syntax0iG12ContinueKindOAE017CodeBlockItemListI0VF":{"name":"visit(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC9visitPostyy0A6Syntax017CodeBlockItemListJ0VF":{"name":"visitPost(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC9visitPostyy0A6Syntax012VariableDeclJ0VF":{"name":"visitPost(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC9visitPostyy0A6Syntax09GuardStmtJ0VF":{"name":"visitPost(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC5visity0A6Syntax0iG12ContinueKindOAE011MemberBlockI0VF":{"name":"visit(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC9visitPostyy0A6Syntax011MemberBlockJ0VF":{"name":"visitPost(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC13configuration4fileACyxGx_AA0aB4FileCtcfc":{"name":"init(configuration:file:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax012AccessorDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09ActorDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax011CatchClauseI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09ClassDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax011ClosureExprI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09DeferStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax06DoStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax08EnumDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax013ExtensionDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax012FunctionDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax07ForStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09GuardStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax06IfExprI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax015InitializerDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax014PatternBindingI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax019PrecedenceGroupDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax012ProtocolDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax010RepeatStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax010StructDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax010SwitchExprI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09WhileStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC17collectViolations3foryqd__Sg_t0A6Syntax06BracedJ0Rd__lF":{"name":"collectViolations(for:)","abstract":"Collects violations for the given braced item. Intended to be specialized by subclasses.
","parent_name":"CodeBlockVisitor"},"Classes/BodyLengthRuleVisitor/Kind.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC4KindO7closureyAEyx_GAGmAA0F0RzlF":{"name":"closure","abstract":"Closure code blocks.
","parent_name":"Kind"},"Classes/BodyLengthRuleVisitor/Kind.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC4KindO8functionyAEyx_GAGmAA0F0RzlF":{"name":"function","abstract":"Function body blocks.
","parent_name":"Kind"},"Classes/BodyLengthRuleVisitor/Kind.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC4KindO4typeyAEyx_GAGmAA0F0RzlF":{"name":"type","abstract":"Type (class, enum, …) member blocks.
","parent_name":"Kind"},"Classes/BodyLengthRuleVisitor/Kind.html":{"name":"Kind","abstract":"The code block types to check.
","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC4kind4file13configurationACyxGAC4KindOyx_G_AA0aB4FileCAA27SeverityLevelsConfigurationVyxGtcfc":{"name":"init(kind:file:configuration:)","abstract":"Initializer.
","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax08EnumDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax09ClassDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax010StructDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax09ActorDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax011ClosureExprJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax012FunctionDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax015InitializerDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/CodeIndentingRewriter/IndentationStyle.html#/s:13SwiftLintCore21CodeIndentingRewriterC16IndentationStyleO12indentSpacesyAESicAEmF":{"name":"indentSpaces(_:)","abstract":"Indentation with a number of spaces.
","parent_name":"IndentationStyle"},"Classes/CodeIndentingRewriter/IndentationStyle.html#/s:13SwiftLintCore21CodeIndentingRewriterC16IndentationStyleO14unindentSpacesyAESicAEmF":{"name":"unindentSpaces(_:)","abstract":"Reverse indentation of a number of spaces.
","parent_name":"IndentationStyle"},"Classes/CodeIndentingRewriter/IndentationStyle.html#/s:13SwiftLintCore21CodeIndentingRewriterC16IndentationStyleO10indentTabsyAESicAEmF":{"name":"indentTabs(_:)","abstract":"Indentation with a number of tabs
","parent_name":"IndentationStyle"},"Classes/CodeIndentingRewriter/IndentationStyle.html#/s:13SwiftLintCore21CodeIndentingRewriterC16IndentationStyleO12unindentTabsyAESicAEmF":{"name":"unindentTabs(_:)","abstract":"Reverse indentation of a number of tabs.
","parent_name":"IndentationStyle"},"Classes/CodeIndentingRewriter/IndentationStyle.html":{"name":"IndentationStyle","abstract":"Style defining whether the rewriter shall indent or unindent and whether it shall use tabs or spaces and","parent_name":"CodeIndentingRewriter"},"Classes/CodeIndentingRewriter.html#/s:13SwiftLintCore21CodeIndentingRewriterC5styleA2C16IndentationStyleO_tcfc":{"name":"init(style:)","abstract":"
Initializer accepting an indentation style.
","parent_name":"CodeIndentingRewriter"},"Classes/CodeIndentingRewriter.html#/s:13SwiftLintCore21CodeIndentingRewriterC5visity0A6Syntax05TokenH0VAGF":{"name":"visit(_:)","parent_name":"CodeIndentingRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC13configurationxvp":{"name":"configuration","abstract":"A rule’s configuration.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC4fileAA0aB4FileCvp":{"name":"file","abstract":"The file from which the traversed syntax tree stems from.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC17locationConverter0aE0014SourceLocationH0Cvp":{"name":"locationConverter","abstract":"A converter of positions in the traversed source file.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC15disabledRegionsSay0aE011SourceRangeVGvp":{"name":"disabledRegions","abstract":"The regions in the traversed file that are disabled by a command.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC19correctionPositionsSay0aE016AbsolutePositionVGvp":{"name":"correctionPositions","abstract":"Positions in a source file where corrections were applied.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC13configuration4fileACyxGx_AA0aB4FileCtcfc":{"name":"init(configuration:file:)","abstract":"Initializer for a ViolationsSyntaxRewriter
.
The underlying SourceKitten file.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC2id10Foundation4UUIDVvp":{"name":"id","abstract":"The associated unique identifier for this file.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC06isTestD0Sbvp":{"name":"isTestFile","abstract":"Whether or not this is a file generated for testing purposes.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC9isVirtualSbvp":{"name":"isVirtual","abstract":"A file is virtual if it is not backed by a filesystem path.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC4file06isTestD00F7VirtualAC21SourceKittenFramework0D0C_S2btcfc":{"name":"init(file:isTestFile:isVirtual:)","abstract":"Creates a SwiftLintFile
with a SourceKitten File
.
Creates a SwiftLintFile
by specifying its path on disk.","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC20pathDeferringReadingACSS_tcfc":{"name":"init(pathDeferringReading:)","abstract":"
Creates a SwiftLintFile
by specifying its path on disk. Unlike the SwiftLintFile(path:)
initializer, this","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC8contents06isTestD0ACSS_Sbtcfc":{"name":"init(contents:isTestFile:)","abstract":"
Creates a SwiftLintFile
that is not backed by a file on disk by specifying its contents.
The path on disk for this file.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC8contentsSSvp":{"name":"contents","abstract":"The file’s contents.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC10stringView21SourceKittenFramework06StringF0Vvp":{"name":"stringView","abstract":"A string view into the contents of this file optimized for string manipulation operations.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC5linesSay21SourceKittenFramework4LineVGvp":{"name":"lines","abstract":"The parsed lines for this file’s contents.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"SwiftLintFile"},"Classes/RuleStorage.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RuleStorage"},"Classes/RuleStorage.html#/s:13SwiftLintCore11RuleStorageCACycfc":{"name":"init()","abstract":"Creates a RuleStorage
with no initial stored data.
Shared rule registry instance.
","parent_name":"RuleRegistry"},"Classes/RuleRegistry.html#/s:13SwiftLintCore12RuleRegistryC4listAA0D4ListVvp":{"name":"list","abstract":"Rule list associated with this registry. Lazily created, and","parent_name":"RuleRegistry"},"Classes/RuleRegistry.html#/s:13SwiftLintCore12RuleRegistryC8register5rulesySayAA0D0_pXpG_tF":{"name":"register(rules:)","abstract":"
Register rules.
","parent_name":"RuleRegistry"},"Classes/RuleRegistry.html#/s:13SwiftLintCore12RuleRegistryC4rule5forIDAA0D0_pXpSgSS_tF":{"name":"rule(forID:)","abstract":"Look up a rule for a given ID.
","parent_name":"RuleRegistry"},"Classes/RuleRegistry.html":{"name":"RuleRegistry","abstract":"Container to register and look up SwiftLint rules.
"},"Classes/RuleStorage.html":{"name":"RuleStorage","abstract":"A storage mechanism for aggregating the results of CollectingRule
s.
A unit of Swift source code, either on disk or in memory.
"},"Classes/ViolationsSyntaxRewriter.html":{"name":"ViolationsSyntaxRewriter","abstract":"A SwiftSyntax SyntaxRewriter
that produces absolute positions where corrections were applied.
Rewriter that indents or unindents a syntax piece including comments and nested"},"Classes/BodyLengthRuleVisitor.html":{"name":"BodyLengthRuleVisitor","abstract":"
Visitor that collection violations of code block lengths.
"},"Classes/CodeBlockVisitor.html":{"name":"CodeBlockVisitor","abstract":"A visitor that collects style violations for all available code blocks.
"},"Classes/DeclaredIdentifiersTrackingVisitor.html":{"name":"DeclaredIdentifiersTrackingVisitor","abstract":"A specialized ViolationsSyntaxVisitor
that tracks declared identifiers per scope while traversing the AST.
A SwiftSyntax SyntaxVisitor
that produces absolute positions where violations should be reported.
The following guides are available globally.
"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally.
"},"Enums.html":{"name":"Enumerations","abstract":"The following enumerations are available globally.
"},"Extensions.html":{"name":"Extensions","abstract":"The following extensions are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally.
"},"Structs.html":{"name":"Structures","abstract":"The following structures are available globally.
"},"Macros.html":{"name":"Macros","abstract":"The following macros are available globally.
"}} \ No newline at end of file diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/docSet.dsidx b/docsets/SwiftLintCore.docset/Contents/Resources/docSet.dsidx index 98495b4ea3..7c0e1636f0 100644 Binary files a/docsets/SwiftLintCore.docset/Contents/Resources/docSet.dsidx and b/docsets/SwiftLintCore.docset/Contents/Resources/docSet.dsidx differ diff --git a/docsets/SwiftLintCore.tgz b/docsets/SwiftLintCore.tgz index 9691fbac35..994932c61f 100644 Binary files a/docsets/SwiftLintCore.tgz and b/docsets/SwiftLintCore.tgz differ diff --git a/search.json b/search.json index a125ee0d60..40bd251c99 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -{"Macros.html#/s:13SwiftLintCore16AutoConfigParseryycfm":{"name":"AutoConfigParser()","abstract":"Macro to be attached to rule configurations. It generates the configuration parsing logic"},"Macros.html#/s:13SwiftLintCore32AcceptableByConfigurationElementyycfm":{"name":"AcceptableByConfigurationElement()","abstract":"
Macro that lets an enum with a String
raw type automatically conform to AcceptableByConfigurationElement
.
Macro that adds a conformance to the SwiftSyntaxRule
protocol and a default makeVisitor(file:)
implementation"},"Structs/SeverityLevelsConfiguration.html#/s:13SwiftLintCore27SeverityLevelsConfigurationV7warningSivp":{"name":"warning","abstract":"
The threshold for a violation to be a warning.
","parent_name":"SeverityLevelsConfiguration"},"Structs/SeverityLevelsConfiguration.html#/s:13SwiftLintCore27SeverityLevelsConfigurationV5errorSiSgvp":{"name":"error","abstract":"The threshold for a violation to be an error.
","parent_name":"SeverityLevelsConfiguration"},"Structs/SeverityLevelsConfiguration.html#/s:13SwiftLintCore27SeverityLevelsConfigurationV7warning5errorACyxGSi_SiSgtcfc":{"name":"init(warning:error:)","abstract":"Create a SeverityLevelsConfiguration
based on the specified warning
and error
thresholds.
The rule parameters that define the thresholds that should map to each severity.
","parent_name":"SeverityLevelsConfiguration"},"Structs/SeverityLevelsConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP5apply13configurationyyp_tKF":{"name":"apply(configuration:)","parent_name":"SeverityLevelsConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV10identifierSSvp":{"name":"identifier","abstract":"The identifier for this custom rule.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV4nameSSSgvp":{"name":"name","abstract":"The name for this custom rule.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV7messageSSvp":{"name":"message","abstract":"The message to be presented when producing violations.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV8includedSaySo19NSRegularExpressionCGvp":{"name":"included","abstract":"Regular expressions to include when matching the file path.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV8excludedSaySo19NSRegularExpressionCGvp":{"name":"excluded","abstract":"Regular expressions to exclude when matching the file path.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV18excludedMatchKindsShy21SourceKittenFramework10SyntaxKindOGvp":{"name":"excludedMatchKinds","abstract":"The syntax kinds to exclude from matches. If the regex matched syntax kinds from this list, it would","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore30SeverityBasedRuleConfigurationP08severityG0AA0dG0Vy6ParentQzGvp":{"name":"severityConfiguration","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV12captureGroupSivp":{"name":"captureGroup","abstract":"
The index of the regex capture group to match.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore24CacheDescriptionProviderP05cacheE0SSvp":{"name":"cacheDescription","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV11descriptionAA15RuleDescriptionVvp":{"name":"description","abstract":"The RuleDescription
for the custom rule defined here.
Create a RegexConfiguration
with the specified identifier, with other properties to be set later.
Create a ViolationCorrection
.
The correction of a violation that is basically the violation’s range in the source code and a","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV8position0A6Syntax16AbsolutePositionVvp":{"name":"position","abstract":"
The violation’s position.
","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV6reasonSSSgvp":{"name":"reason","abstract":"A specific reason for the violation.
","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV8severityAA0F8SeverityOSgvp":{"name":"severity","abstract":"The violation’s severity.
","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV10correctionAC0F10CorrectionVSgvp":{"name":"correction","abstract":"An optional correction of the violation to be used in rewriting (see SwiftSyntaxCorrectableRule
). Can be","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV8position6reason8severity10correctionAC0A6Syntax16AbsolutePositionV_SSSgAA0F8SeverityOSgAC0F10CorrectionVSgtcfc":{"name":"init(position:reason:severity:correction:)","abstract":"
Creates a ReasonedRuleViolation
.
Swift 5
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV10fiveDotOneACvpZ":{"name":"fiveDotOne","abstract":"Swift 5.1
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV10fiveDotTwoACvpZ":{"name":"fiveDotTwo","abstract":"Swift 5.2
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV12fiveDotThreeACvpZ":{"name":"fiveDotThree","abstract":"Swift 5.3
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV11fiveDotFourACvpZ":{"name":"fiveDotFour","abstract":"Swift 5.4
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV11fiveDotFiveACvpZ":{"name":"fiveDotFive","abstract":"Swift 5.5
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV10fiveDotSixACvpZ":{"name":"fiveDotSix","abstract":"Swift 5.6
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV12fiveDotSevenACvpZ":{"name":"fiveDotSeven","abstract":"Swift 5.7
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV12fiveDotEightACvpZ":{"name":"fiveDotEight","abstract":"Swift 5.8
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV11fiveDotNineACvpZ":{"name":"fiveDotNine","abstract":"Swift 5.9
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV3sixACvpZ":{"name":"six","abstract":"Swift 6
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV7currentACvpZ":{"name":"current","abstract":"The current detected Swift compiler version, based on the currently accessible SourceKit version.
","parent_name":"SwiftVersion"},"Structs/SwiftLintSyntaxToken.html#/s:13SwiftLintCore0aB11SyntaxTokenV5value21SourceKittenFramework0dE0Vvp":{"name":"value","abstract":"The raw SyntaxToken
obtained by SourceKitten.
The syntax kind associated with is token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:13SwiftLintCore0aB11SyntaxTokenV5valueAC21SourceKittenFramework0dE0V_tcfc":{"name":"init(value:)","abstract":"Creates a SwiftLintSyntaxToken
from the raw SyntaxToken
obtained by SourceKitten.
The byte range in a source file for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:13SwiftLintCore0aB11SyntaxTokenV6offset21SourceKittenFramework9ByteCountVvp":{"name":"offset","abstract":"The starting byte offset in a source file for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:13SwiftLintCore0aB11SyntaxTokenV6length21SourceKittenFramework9ByteCountVvp":{"name":"length","abstract":"The length in bytes for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxMap.html#/s:13SwiftLintCore0aB9SyntaxMapV5value21SourceKittenFramework0dE0Vvp":{"name":"value","abstract":"The raw SyntaxMap
obtained by SourceKitten.
The SwiftLint-specific syntax tokens for this syntax map.
","parent_name":"SwiftLintSyntaxMap"},"Structs/SwiftLintSyntaxMap.html#/s:13SwiftLintCore0aB9SyntaxMapV5valueAC21SourceKittenFramework0dE0V_tcfc":{"name":"init(value:)","abstract":"Creates a SwiftLintSyntaxMap
from the raw SyntaxMap
obtained by SourceKitten.
Returns array of syntax tokens intersecting with byte range.
","parent_name":"SwiftLintSyntaxMap"},"Structs/SwiftLintSyntaxMap.html#/s:13SwiftLintCore0aB9SyntaxMapV5kinds11inByteRangeSay21SourceKittenFramework0D4KindOGAF0hI0V_tF":{"name":"kinds(inByteRange:)","abstract":"Returns the syntax kinds in the specified byte range.
","parent_name":"SwiftLintSyntaxMap"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV14ruleIdentifierSSvp":{"name":"ruleIdentifier","abstract":"The identifier of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV15ruleDescriptionSSvp":{"name":"ruleDescription","abstract":"The description of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV8ruleNameSSvp":{"name":"ruleName","abstract":"The name of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV8severityAA0E8SeverityOvp":{"name":"severity","abstract":"The severity of this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV8locationAA8LocationVvp":{"name":"location","abstract":"The location of this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV6reasonSSvp":{"name":"reason","abstract":"The justification for this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV11descriptionSSvp":{"name":"description","abstract":"A printable description for this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV15ruleDescription8severity8location6reasonAcA04RuleG0V_AA0E8SeverityOAA8LocationVSSSgtcfc":{"name":"init(ruleDescription:severity:location:reason:)","abstract":"Creates a StyleViolation
by specifying its properties directly.
Returns the same violation, but with the severity
that is passed in
Returns the same violation, but with the location
that is passed in
The severity that should be assigned to the violation of this parameter’s value is met.
","parent_name":"RuleParameter"},"Structs/RuleParameter.html#/s:13SwiftLintCore13RuleParameterV5valuexvp":{"name":"value","abstract":"The value to configure the rule.
","parent_name":"RuleParameter"},"Structs/RuleParameter.html#/s:13SwiftLintCore13RuleParameterV8severity5valueACyxGAA17ViolationSeverityO_xtcfc":{"name":"init(severity:value:)","abstract":"Creates a RuleParameter
by specifying its properties directly.
The rules contained in this list.
","parent_name":"RuleList"},"Structs/RuleList.html#/s:13SwiftLintCore8RuleListV5rulesAcA0D0_pXpd_tcfc":{"name":"init(rules:)","abstract":"Creates a RuleList
by specifying all its rules.
Creates a RuleList
by specifying all its rules.
The rule’s unique identifier, to be used in configuration files and SwiftLint commands.","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV4nameSSvp":{"name":"name","abstract":"
The rule’s human-readable name. Should be short, descriptive and formatted in Title Case. May contain spaces.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV11descriptionSSvp":{"name":"description","abstract":"The rule’s verbose description. Should read as a sentence or short paragraph. Good things to include are an","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV4kindAA0D4KindOvp":{"name":"kind","abstract":"
The RuleKind
that best categorizes this rule.
Swift source examples that do not trigger a violation for this rule. Used for documentation purposes to inform","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV18triggeringExamplesSayAA7ExampleVGvp":{"name":"triggeringExamples","abstract":"
Swift source examples that do trigger one or more violations for this rule. Used for documentation purposes to","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV11correctionsSDyAA7ExampleVAFGvp":{"name":"corrections","abstract":"
Pairs of Swift source examples, where keys are examples that trigger violations for this rule, and the values","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV17deprecatedAliasesShySSGvp":{"name":"deprecatedAliases","abstract":"
Any previous iteration of the rule’s identifier that was previously shipped with SwiftLint.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV03minA7VersionAA0aG0Vvp":{"name":"minSwiftVersion","abstract":"The oldest version of the Swift compiler supported by this rule.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV18requiresFileOnDiskSbvp":{"name":"requiresFileOnDisk","abstract":"Whether or not this rule can only be executed on a file physically on-disk. Typically necessary for rules","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV07consoleE0SSvp":{"name":"consoleDescription","abstract":"
The console-printable string for this description.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV14allIdentifiersSaySSGvp":{"name":"allIdentifiers","abstract":"All identifiers that have been used to uniquely identify this rule in past and current SwiftLint versions.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV10identifier4name11description4kind03minA7Version21nonTriggeringExamples010triggeringN011corrections17deprecatedAliases18requiresFileOnDiskACSS_S2SAA0D4KindOAA0aK0VSayAA7ExampleVGATSDyA2SGShySSGSbtcfc":{"name":"init(identifier:name:description:kind:minSwiftVersion:nonTriggeringExamples:triggeringExamples:corrections:deprecatedAliases:requiresFileOnDisk:)","abstract":"Creates a RuleDescription
by specifying all its properties directly.
Configuration with a warning severity.
","parent_name":"SeverityConfiguration"},"Structs/SeverityConfiguration.html#/s:13SwiftLintCore21SeverityConfigurationV7warningACyxGvpZ":{"name":"warning","abstract":"Configuration with an error severity.
","parent_name":"SeverityConfiguration"},"Structs/SeverityConfiguration.html#/s:13SwiftLintCore30SeverityBasedRuleConfigurationP08severityG0AA0dG0Vy6ParentQzGvp":{"name":"severityConfiguration","parent_name":"SeverityConfiguration"},"Structs/SeverityConfiguration.html#/s:13SwiftLintCore21SeverityConfigurationVyACyxGAA09ViolationD0Ocfc":{"name":"init(_:)","abstract":"Create a SeverityConfiguration
with the specified severity.
Severity configurations are special in that they shall not be nested when an option name is provided.","parent_name":"SeverityConfiguration"},"Structs/ConfigurationElement/DeprecationNotice.html#/s:13SwiftLintCore20ConfigurationElementV17DeprecationNoticeO18suggestAlternativeyAEyx_GSS_SStcAGmSQRzAA012AcceptableBydE0RzlF":{"name":"suggestAlternative(ruleID:name:)","abstract":"
Warning suggesting an alternative option.
","parent_name":"DeprecationNotice"},"Structs/ConfigurationElement/DeprecationNotice.html":{"name":"DeprecationNotice","abstract":"A deprecation notice.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV12wrappedValuexvp":{"name":"wrappedValue","abstract":"Wrapped option value.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV14projectedValueACyxGvp":{"name":"projectedValue","abstract":"The wrapper itself providing access to all its data. This field can only be accessed by the","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV3keySSvp":{"name":"key","abstract":"
Name of this configuration entry.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV6inlineSbvp":{"name":"inline","abstract":"Whether this configuration element will be inlined into its description.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV12wrappedValue3key17deprecationNotice13postprocessorACyxGx_SSAC011DeprecationJ0Oyx_GSgyxzctcfc":{"name":"init(wrappedValue:key:deprecationNotice:postprocessor:)","abstract":"Default constructor.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV3keyACyqd__SgGSS_tcAERszSQRd__AA012AcceptableBydE0Rd__lufc":{"name":"init(key:)","abstract":"Constructor for optional values.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV12wrappedValue6inlineACyxGx_SbtcAA19InlinableOptionTypeRzrlufc":{"name":"init(wrappedValue:inline:)","abstract":"Constructor for an InlinableOptionType
without a key.
Constructor for an InlinableOptionType
with a name. The configuration will explicitly not be inlined.
An option serving as a marker for an empty configuration description.
","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationOption.html#/s:13SwiftLintCore12DocumentableP10hasContentSbvp":{"name":"hasContent","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationOption.html#/s:13SwiftLintCore12DocumentableP8markdownSSyF":{"name":"markdown()","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationOption.html#/s:13SwiftLintCore12DocumentableP8oneLinerSSyF":{"name":"oneLiner()","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationOption.html#/s:13SwiftLintCore12DocumentableP4yamlSSyF":{"name":"yaml()","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationDescription.html#/s:13SwiftLintCore12DocumentableP10hasContentSbvp":{"name":"hasContent","parent_name":"RuleConfigurationDescription"},"Structs/RuleConfigurationDescription.html#/s:13SwiftLintCore12DocumentableP8oneLinerSSyF":{"name":"oneLiner()","parent_name":"RuleConfigurationDescription"},"Structs/RuleConfigurationDescription.html#/s:13SwiftLintCore12DocumentableP8markdownSSyF":{"name":"markdown()","parent_name":"RuleConfigurationDescription"},"Structs/RuleConfigurationDescription.html#/s:13SwiftLintCore12DocumentableP4yamlSSyF":{"name":"yaml()","parent_name":"RuleConfigurationDescription"},"Structs/Region.html#/s:13SwiftLintCore6RegionV5startAA8LocationVvp":{"name":"start","abstract":"The location describing the start of the region. All locations that are less than this value","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV3endAA8LocationVvp":{"name":"end","abstract":"
The location describing the end of the region. All locations that are greater than this value","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV23disabledRuleIdentifiersShyAA0F10IdentifierOGvp":{"name":"disabledRuleIdentifiers","abstract":"
All SwiftLint rule identifiers that are disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV5start3end23disabledRuleIdentifiersAcA8LocationV_AHShyAA0H10IdentifierOGtcfc":{"name":"init(start:end:disabledRuleIdentifiers:)","abstract":"Creates a Region by setting explicit values for all its properties.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV8containsySbAA8LocationVF":{"name":"contains(_:)","abstract":"Whether the specific location is contained in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV13isRuleEnabledySbxAA0F0RzlF":{"name":"isRuleEnabled(_:)","abstract":"Whether the specified rule is enabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV14isRuleDisabledySbxAA0F0RzlF":{"name":"isRuleDisabled(_:)","abstract":"Whether the specified rule is disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV16areRulesDisabled7ruleIDsSbSaySSG_tF":{"name":"areRulesDisabled(ruleIDs:)","abstract":"Whether the given rules are disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV26deprecatedAliasesDisabling4ruleShySSGx_tAA4RuleRzlF":{"name":"deprecatedAliasesDisabling(rule:)","abstract":"Returns the deprecated rule aliases that are disabling the specified rule in this region.","parent_name":"Region"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4fileSSSgvp":{"name":"file","abstract":"
The file path on disk for this location.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4lineSiSgvp":{"name":"line","abstract":"The line offset in the file for this location. 1-indexed.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV9characterSiSgvp":{"name":"character","abstract":"The character offset in the file for this location. 1-indexed.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV11descriptionSSvp":{"name":"description","abstract":"A lossless printable description of this location.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV12relativeFileSSSgvp":{"name":"relativeFile","abstract":"The file path for this location relative to the current working directory.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4file4line9characterACSSSg_SiSgAHtcfc":{"name":"init(file:line:character:)","abstract":"Creates a Location
by specifying its properties directly.
Creates a Location
based on a SwiftLintFile
and a byte-offset into the file.","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4file8positionAcA0aB4FileC_0A6Syntax16AbsolutePositionVtcfc":{"name":"init(file:position:)","abstract":"
Creates a Location
based on a SwiftLintFile
and a SwiftSyntax AbsolutePosition
into the file.","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4file15characterOffsetAcA0aB4FileC_Sitcfc":{"name":"init(file:characterOffset:)","abstract":"
Creates a Location
based on a SwiftLintFile
and a UTF8 character-offset into the file.","parent_name":"Location"},"Structs/Location.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"Location"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV4codeSSvp":{"name":"code","abstract":"
The contents of the example
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV13configurationSDySSs8Sendable_pGSgvp":{"name":"configuration","abstract":"The untyped configuration to apply to the rule, if deviating from the default configuration.","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV20testMultiByteOffsetsSbvp":{"name":"testMultiByteOffsets","abstract":"
Whether the example should be tested by prepending multibyte grapheme clusters
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV11testOnLinuxSbvp":{"name":"testOnLinux","abstract":"Whether the example should be tested on Linux
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV4files12StaticStringVvp":{"name":"file","abstract":"The path to the file where the example was created
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV4lineSuvp":{"name":"line","abstract":"The line in the file where the example was created
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV_13configuration20testMultiByteOffsets0F17WrappingInComment0fjK6String0F14DisableCommand0F7OnLinux4file4line24excludeFromDocumentationACSS_SDySSs8Sendable_pGSgS5bs06StaticM0VSuSbtcfc":{"name":"init(_:configuration:testMultiByteOffsets:testWrappingInComment:testWrappingInString:testDisableCommand:testOnLinux:file:line:excludeFromDocumentation:)","abstract":"Create a new Example with the specified code, file, and line.
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV4with4codeACSS_tF":{"name":"with(code:)","abstract":"Returns the same example, but with the code
that is passed in
Returns a copy of the Example with all instances of the “↓” character removed.
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV7focusedACyF":{"name":"focused()","abstract":"Makes the current example focused. This is for debugging purposes only.
","parent_name":"Example"},"Structs/Example.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"Example"},"Structs/Example.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"Example"},"Structs/Example.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"Example"},"Structs/Correction.html#/s:13SwiftLintCore10CorrectionV15ruleDescriptionAA04RuleF0Vvp":{"name":"ruleDescription","abstract":"The description of the rule for which this correction was applied.
","parent_name":"Correction"},"Structs/Correction.html#/s:13SwiftLintCore10CorrectionV8locationAA8LocationVvp":{"name":"location","abstract":"The location of the original violation that was corrected.
","parent_name":"Correction"},"Structs/Correction.html#/s:13SwiftLintCore10CorrectionV18consoleDescriptionSSvp":{"name":"consoleDescription","abstract":"The console-printable description for this correction.
","parent_name":"Correction"},"Structs/Correction.html#/s:13SwiftLintCore10CorrectionV15ruleDescription8locationAcA04RuleF0V_AA8LocationVtcfc":{"name":"init(ruleDescription:location:)","abstract":"Memberwise initializer.
","parent_name":"Correction"},"Structs/Command/Modifier.html#/s:13SwiftLintCore7CommandV8ModifierO8previousyA2EmF":{"name":"previous","abstract":"The command should only apply to the line preceding its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:13SwiftLintCore7CommandV8ModifierO4thisyA2EmF":{"name":"this","abstract":"The command should only apply to the same line as its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:13SwiftLintCore7CommandV8ModifierO4nextyA2EmF":{"name":"next","abstract":"The command should only apply to the line following its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:13SwiftLintCore7CommandV8ModifierO7invalidyA2EmF":{"name":"invalid","abstract":"The modifier string was invalid.
","parent_name":"Modifier"},"Structs/Command/Action.html#/s:13SwiftLintCore7CommandV6ActionO6enableyA2EmF":{"name":"enable","abstract":"The rule(s) associated with this command should be enabled by the SwiftLint engine.
","parent_name":"Action"},"Structs/Command/Action.html#/s:13SwiftLintCore7CommandV6ActionO7disableyA2EmF":{"name":"disable","abstract":"The rule(s) associated with this command should be disabled by the SwiftLint engine.
","parent_name":"Action"},"Structs/Command/Action.html#/s:13SwiftLintCore7CommandV6ActionO7invalidyA2EmF":{"name":"invalid","abstract":"The action string was invalid.
","parent_name":"Action"},"Structs/Command/Action.html":{"name":"Action","abstract":"The action (verb) that SwiftLint should perform when interpreting this command.
","parent_name":"Command"},"Structs/Command/Modifier.html":{"name":"Modifier","abstract":"The modifier for a command, used to modify its scope.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV6actionAC6ActionOvp":{"name":"action","abstract":"The action (verb) that SwiftLint should perform when interpreting this command.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV15ruleIdentifiersShyAA14RuleIdentifierOGvp":{"name":"ruleIdentifiers","abstract":"The identifiers for the rules associated with this command.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV4lineSivp":{"name":"line","abstract":"The line in the source file where this command is defined.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV9characterSiSgvp":{"name":"character","abstract":"The character offset within the line in the source file where this command is defined.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV8modifierAC8ModifierOSgvp":{"name":"modifier","abstract":"This command’s modifier, if any.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV6action15ruleIdentifiers4line9character8modifier15trailingCommentA2C6ActionO_ShyAA14RuleIdentifierOGS2iSgAC8ModifierOSgSSSgtcfc":{"name":"init(action:ruleIdentifiers:line:character:modifier:trailingComment:)","abstract":"Creates a command based on the specified parameters.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV12actionString4line9characterACSS_S2itcfc":{"name":"init(actionString:line:character:)","abstract":"Creates a command based on the specified parameters.
","parent_name":"Command"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32ChildOptionSeverityConfigurationV5errorACyxGvpZ":{"name":"error","abstract":"Configuration with a warning severity.
","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32ChildOptionSeverityConfigurationV7warningACyxGvpZ":{"name":"warning","abstract":"Configuration with an error severity.
","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32ChildOptionSeverityConfigurationV3offACyxGvpZ":{"name":"off","abstract":"Configuration disabling an option.
","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32ChildOptionSeverityConfigurationV8severityAA09ViolationF0OSgvp":{"name":"severity","abstract":"The ChildOptionSeverityConfiguration
mapped to a usually used ViolationSeverity
. It’s nil
if the option","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP5apply13configurationyyp_tKF":{"name":"apply(configuration:)","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"ChildOptionSeverityConfiguration"},"Structs/Baseline.html#/s:13SwiftLintCore8BaselineV10violationsSayAA14StyleViolationVGvp":{"name":"violations","abstract":"
The stored violations.
","parent_name":"Baseline"},"Structs/Baseline.html#/s:13SwiftLintCore8BaselineV8fromPathACSS_tKcfc":{"name":"init(fromPath:)","abstract":"Creates a Baseline
from a saved file.
Creates a Baseline
from a list of violations.
Writes a Baseline
to disk in JSON format.
Filters out violations that are present in the Baseline
.
Returns the violations that are present in another Baseline
, but not in this one.
Creates an empty Stack
.
The number of elements in this stack.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV4pushyyxF":{"name":"push(_:)","abstract":"Pushes (appends) an element onto the stack.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV3popxSgyF":{"name":"pop()","abstract":"Removes and returns the last element of the stack.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV4peekxSgyF":{"name":"peek()","abstract":"Returns the last element of the stack if the stack is not empty; otherwise, nil.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV8contains5whereS2bxXE_tF":{"name":"contains(where:)","abstract":"Check whether the sequence contains an element that satisfies the given predicate.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV10modifyLast2byyyxzXE_tF":{"name":"modifyLast(by:)","abstract":"Modify the last element.
","parent_name":"Stack"},"Structs/Stack.html#/s:ST12makeIterator0B0QzyF":{"name":"makeIterator()","parent_name":"Stack"},"Structs/Stack.html#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp":{"name":"debugDescription","parent_name":"Stack"},"Structs/Stack.html":{"name":"Stack","abstract":"A basic stack type implementing the LIFO principle - only the last inserted element can be accessed and removed.
"},"Structs/Baseline.html":{"name":"Baseline","abstract":"A set of violations that can be used to filter newly detected violations.
"},"Structs/ChildOptionSeverityConfiguration.html":{"name":"ChildOptionSeverityConfiguration","abstract":"A rule configuration that allows to disable (off
) an option of a rule or specify its severity level in which"},"Structs/Command.html":{"name":"Command","abstract":"
A SwiftLint-interpretable command to modify SwiftLint’s behavior embedded as comments in source code.
"},"Structs/Correction.html":{"name":"Correction","abstract":"A value describing a SwiftLint violation that was corrected.
"},"Structs/Example.html":{"name":"Example","abstract":"Captures code and context information for an example of a triggering or"},"Structs/Location.html":{"name":"Location","abstract":"
The placement of a segment of Swift in a collection of source files.
"},"Structs/Region.html":{"name":"Region","abstract":"A contiguous region of Swift source code.
"},"Structs/RuleConfigurationDescription.html":{"name":"RuleConfigurationDescription","abstract":"Description of a rule configuration.
"},"Structs/RuleConfigurationOption.html":{"name":"RuleConfigurationOption","abstract":"A single option of a RuleConfigurationDescription
.
A result builder creating configuration descriptions.
"},"Structs/ConfigurationElement.html":{"name":"ConfigurationElement","abstract":"A single parameter of a rule configuration.
"},"Structs/SeverityConfiguration.html":{"name":"SeverityConfiguration","abstract":"A rule configuration that allows specifying the desired severity level for violations.
"},"Structs/RuleDescription.html":{"name":"RuleDescription","abstract":"A detailed description for a SwiftLint rule. Used for both documentation and testing purposes.
"},"Structs/RuleList.html":{"name":"RuleList","abstract":"A list of available SwiftLint rules.
"},"Structs/RuleParameter.html":{"name":"RuleParameter","abstract":"A configuration parameter for rules.
"},"Structs/StyleViolation.html":{"name":"StyleViolation","abstract":"A value describing an instance of Swift source code that is considered invalid by a SwiftLint rule.
"},"Structs/SwiftLintSyntaxMap.html":{"name":"SwiftLintSyntaxMap","abstract":"Represents a Swift file’s syntax information.
"},"Structs/SwiftLintSyntaxToken.html":{"name":"SwiftLintSyntaxToken","abstract":"A SwiftLint-aware Swift syntax token.
"},"Structs/SwiftVersion.html":{"name":"SwiftVersion","abstract":"A value describing the version of the Swift compiler.
"},"Structs/ReasonedRuleViolation.html":{"name":"ReasonedRuleViolation","abstract":"A violation produced by ViolationsSyntaxVisitor
s.
A rule configuration used for defining custom rules in yaml.
"},"Structs/SeverityLevelsConfiguration.html":{"name":"SeverityLevelsConfiguration","abstract":"A rule configuration that allows specifying thresholds for warning
and error
severities.
Produce a ViolationsSyntaxVisitor
for the given file.
Produce a violation for the given file and absolute position.
","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxRule.html#/s:13SwiftLintCore0A10SyntaxRuleP10preprocess4file0aD0010SourceFileD0VSgAA0abI0C_tF":{"name":"preprocess(file:)","abstract":"Gives a chance for the rule to do some pre-processing on the syntax tree.","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxRule.html#/s:13SwiftLintCore4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxCorrectableRule.html#/s:13SwiftLintCore0A21SyntaxCorrectableRuleP12makeRewriter4fileAA010ViolationsdH0Cy17ConfigurationTypeQzGSgAA0aB4FileC_tF":{"name":"makeRewriter(file:)","abstract":"
Produce a ViolationsSyntaxRewriter
for the given file.
The configuration of a rule’s severity.
","parent_name":"SeverityBasedRuleConfiguration"},"Protocols/SeverityBasedRuleConfiguration.html#/s:13SwiftLintCore30SeverityBasedRuleConfigurationPAAE8severityAA09ViolationD0Ovp":{"name":"severity","abstract":"The severity of a rule.
","parent_name":"SeverityBasedRuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP6ParentQa":{"name":"Parent","abstract":"The type of the rule that’s using this configuration.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP20parameterDescriptionAA0deG0VSgvp":{"name":"parameterDescription","abstract":"A description for this configuration’s parameters. It can be built using the annotated result builder.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP5apply13configurationyyp_tKF":{"name":"apply(configuration:)","abstract":"Apply an untyped configuration to the current value.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP8validateyyKF":{"name":"validate()","abstract":"Run a sanity check on the configuration, perform optional postprocessing steps and/or warn about potential","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationPAAE13supportedKeysShySSGvp":{"name":"supportedKeys","abstract":"
All keys supported by this configuration.
","parent_name":"RuleConfiguration"},"Protocols/AnalyzerRule.html#/s:13SwiftLintCore4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"AnalyzerRule"},"Protocols/SubstitutionCorrectableRule.html#/s:13SwiftLintCore27SubstitutionCorrectableRuleP15violationRanges2inSaySo8_NSRangeVGAA0aB4FileC_tF":{"name":"violationRanges(in:)","abstract":"Returns the NSString-based NSRange
s to be replaced in the specified file.
Returns the substitution to apply for the given range.
","parent_name":"SubstitutionCorrectableRule"},"Protocols/SubstitutionCorrectableRule.html#/s:13SwiftLintCore15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","parent_name":"SubstitutionCorrectableRule"},"Protocols/CorrectableRule.html#/s:13SwiftLintCore15CorrectableRuleP7correct4file17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_SaySSGtF":{"name":"correct(file:compilerArguments:)","abstract":"Attempts to correct the violations to this rule in the specified file.
","parent_name":"CorrectableRule"},"Protocols/CorrectableRule.html#/s:13SwiftLintCore15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","abstract":"Attempts to correct the violations to this rule in the specified file.
","parent_name":"CorrectableRule"},"Protocols/CorrectableRule.html#/s:13SwiftLintCore15CorrectableRuleP7correct4file5using17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_AA0E7StorageCSaySSGtF":{"name":"correct(file:using:compilerArguments:)","abstract":"Attempts to correct the violations to this rule in the specified file after collecting file info for all files","parent_name":"CorrectableRule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP17ConfigurationTypeQa":{"name":"ConfigurationType","abstract":"
The type of the configuration used to configure this rule.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP11descriptionAA0D11DescriptionVvpZ":{"name":"description","abstract":"A verbose description of many of this rule’s properties.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP13configuration17ConfigurationTypeQzvp":{"name":"configuration","abstract":"This rule’s configuration.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP06shouldB10EmptyFilesSbvp":{"name":"shouldLintEmptyFiles","abstract":"Whether this rule should be used on empty files. Defaults to false
.
A default initializer for rules. All rules need to be trivially initializable.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP13configurationxyp_tKcfc":{"name":"init(configuration:)","abstract":"Creates a rule by applying its configuration.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP30createConfigurationDescription16exclusiveOptionsAA0dfG0VShySSG_tF":{"name":"createConfigurationDescription(exclusiveOptions:)","abstract":"Create a description of how this rule has been configured to run.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP8validate4file17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_SaySSGtF":{"name":"validate(file:compilerArguments:)","abstract":"Executes the rule on a file and returns any violations to the rule’s expectations.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","abstract":"Executes the rule on a file and returns any violations to the rule’s expectations.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP9isEqualToySbAaB_pF":{"name":"isEqualTo(_:)","abstract":"Whether or not the specified rule is equivalent to the current rule.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP11collectInfo3for4into17compilerArgumentsyAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"collectInfo(for:into:compilerArguments:)","abstract":"Collects information for the specified file in a storage object, to be analyzed by a CollectedLinter
.
Executes the rule on a file after collecting file info for all files and returns any violations to the rule’s","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP13canBeDisabled9violation2bySbAA14StyleViolationV_AA0D10IdentifierOtF":{"name":"canBeDisabled(violation:by:)","abstract":"
Checks if a style violation can be disabled by a command specifying a rule ID. Only the rule can claim that for","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP9isEnabled2in3forSbAA6RegionV_SStF":{"name":"isEnabled(in:for:)","abstract":"
Checks if a the rule is enabled in a given region. A specific rule ID can be provided in case a rule supports","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RulePAAE16cacheDescriptionSSvp":{"name":"cacheDescription","abstract":"
The cache description which will be used to determine if a previous","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RulePAAE10identifierSSvpZ":{"name":"identifier","abstract":"
The rule’s unique identifier which is the same as Rule.description.identifier
.
The kind of information to collect for each file being linted for this rule.
","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore14CollectingRuleP11collectInfo3for17compilerArguments04FileG0QzAA0abK0C_SaySSGtF":{"name":"collectInfo(for:compilerArguments:)","abstract":"Collects information for the specified file, to be analyzed by a CollectedLinter
.
Collects information for the specified file, to be analyzed by a CollectedLinter
.
Executes the rule on a file after collecting file info for all files and returns any violations to the rule’s","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore14CollectingRuleP8validate4file13collectedInfoSayAA14StyleViolationVGAA0aB4FileC_SDyAK0lI0QzGtF":{"name":"validate(file:collectedInfo:)","abstract":"
Executes the rule on a file after collecting file info for all files and returns any violations to the rule’s","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore4RuleP11collectInfo3for4into17compilerArgumentsyAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"collectInfo(for:into:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore4RuleP8validate4file5using17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"validate(file:using:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore4RuleP8validate4file17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_SaySSGtF":{"name":"validate(file:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CacheDescriptionProvider.html#/s:13SwiftLintCore24CacheDescriptionProviderP05cacheE0SSvp":{"name":"cacheDescription","abstract":"
The cache description which will be used to determine if a previous","parent_name":"CacheDescriptionProvider"},"Protocols/ASTRule.html#/s:13SwiftLintCore7ASTRuleP8KindTypeQa":{"name":"KindType","abstract":"
The kind of token being recursed over.
","parent_name":"ASTRule"},"Protocols/ASTRule.html#/s:13SwiftLintCore7ASTRuleP8validate4file4kind10dictionarySayAA14StyleViolationVGAA0aB4FileC_8KindTypeQzAA22SourceKittenDictionaryVtF":{"name":"validate(file:kind:dictionary:)","abstract":"Executes the rule on a file and a subset of its AST structure, returning any violations to the rule’s","parent_name":"ASTRule"},"Protocols/ASTRule.html#/s:13SwiftLintCore7ASTRuleP4kind4from8KindTypeQzSgAA22SourceKittenDictionaryV_tF":{"name":"kind(from:)","abstract":"
Get the kind
from the specified dictionary.
Executes the rule on a file and a subset of its AST structure, returning any violations to the rule’s","parent_name":"ASTRule"},"Protocols/VersionComparable.html#/s:13SwiftLintCore17VersionComparableP8rawValueSSvp":{"name":"rawValue","abstract":"
The version string.
","parent_name":"VersionComparable"},"Protocols/VersionComparable.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"VersionComparable"},"Protocols/VersionComparable.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"VersionComparable"},"Protocols/AcceptableByConfigurationElement.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","abstract":"Initializer taking a value from a configuration to create an element of Self
.
Make the object an option.
","parent_name":"AcceptableByConfigurationElement"},"Protocols/AcceptableByConfigurationElement.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP13asDescription4withAA04RulefI0VSS_tF":{"name":"asDescription(with:)","abstract":"Make the object a description.
","parent_name":"AcceptableByConfigurationElement"},"Protocols/AcceptableByConfigurationElement.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP5apply_6ruleIDyyp_SStKF":{"name":"apply(_:ruleID:)","abstract":"Update the object.
","parent_name":"AcceptableByConfigurationElement"},"Protocols/Documentable.html#/s:13SwiftLintCore12DocumentableP8markdownSSyF":{"name":"markdown()","abstract":"Convert an object to Markdown.
","parent_name":"Documentable"},"Protocols/Documentable.html#/s:13SwiftLintCore12DocumentableP8oneLinerSSyF":{"name":"oneLiner()","abstract":"Convert an object to a single line string.
","parent_name":"Documentable"},"Protocols/Documentable.html#/s:13SwiftLintCore12DocumentableP10hasContentSbvp":{"name":"hasContent","abstract":"Indicate if the item has some content that is useful to document.
","parent_name":"Documentable"},"Protocols/Documentable.html#/s:13SwiftLintCore12DocumentableP4yamlSSyF":{"name":"yaml()","abstract":"Convert an object to YAML as used in .swiftlint.yml
.
A type that can be converted into a human-readable representation.
"},"Protocols/AcceptableByConfigurationElement.html":{"name":"AcceptableByConfigurationElement","abstract":"Type of an object that can be used as a configuration element.
"},"Protocols.html#/s:13SwiftLintCore19InlinableOptionTypeP":{"name":"InlinableOptionType","abstract":"An option type that can appear inlined into its using configuration.
"},"Protocols/VersionComparable.html":{"name":"VersionComparable","abstract":"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"},"Protocols/CacheDescriptionProvider.html":{"name":"CacheDescriptionProvider","abstract":"
Interface providing access to a cache description.
"},"Protocols.html#/s:13SwiftLintCore17AnyCollectingRuleP":{"name":"AnyCollectingRule","abstract":"Type-erased protocol used to check whether a rule is collectable.
"},"Protocols/CollectingRule.html":{"name":"CollectingRule","abstract":"A rule that requires knowledge of all other files being linted.
"},"Protocols/Rule.html":{"name":"Rule","abstract":"An executable value that can identify issues (violations) in Swift source code.
"},"Protocols.html#/s:13SwiftLintCore9OptInRuleP":{"name":"OptInRule","abstract":"A rule that is not enabled by default. Rules conforming to this need to be explicitly enabled by users.
"},"Protocols/CorrectableRule.html":{"name":"CorrectableRule","abstract":"A rule that can correct violations.
"},"Protocols/SubstitutionCorrectableRule.html":{"name":"SubstitutionCorrectableRule","abstract":"A correctable rule that can apply its corrections by replacing the content of ranges in the offending file with"},"Protocols.html#/s:13SwiftLintCore17SourceKitFreeRuleP":{"name":"SourceKitFreeRule","abstract":"
A rule that does not need SourceKit to operate and can still operate even after SourceKit has crashed.
"},"Protocols/AnalyzerRule.html":{"name":"AnalyzerRule","abstract":"A rule that can operate on the post-typechecked AST using compiler arguments. Performs rules that are more like"},"Protocols/RuleConfiguration.html":{"name":"RuleConfiguration","abstract":"
A configuration value for a rule to allow users to modify its behavior.
"},"Protocols/SeverityBasedRuleConfiguration.html":{"name":"SeverityBasedRuleConfiguration","abstract":"A configuration for a rule that allows to configure at least the severity.
"},"Protocols/SwiftSyntaxCorrectableRule.html":{"name":"SwiftSyntaxCorrectableRule","abstract":"A SwiftLint CorrectableRule that performs its corrections using a SwiftSyntax SyntaxRewriter
.
A SwiftLint Rule backed by SwiftSyntax that does not use SourceKit requests.
"},"Extensions/Double.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Double"},"Extensions/Double.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Double"},"Extensions/Int.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Int"},"Extensions/Int.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Int"},"Extensions/Set.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Set"},"Extensions/Set.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Set"},"Extensions/String.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"String"},"Extensions/String.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"String"},"Extensions/Bool.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Bool"},"Extensions/Bool.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Bool"},"Extensions/Optional.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Optional"},"Extensions/Optional.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Optional"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE26skipWrappingInCommentTestsSayACGyF":{"name":"skipWrappingInCommentTests()","abstract":"Make these examples skip wrapping in comment tests.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE25skipWrappingInStringTestsSayACGyF":{"name":"skipWrappingInStringTests()","abstract":"Make these examples skip wrapping in string tests.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE24skipMultiByteOffsetTestsSayACGyF":{"name":"skipMultiByteOffsetTests()","abstract":"Make these examples skip multi-byte offset tests.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE23skipDisableCommandTestsSayACGyF":{"name":"skipDisableCommandTests()","abstract":"Make these examples skip disable command tests.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE23removingViolationMarkerSayACGyF":{"name":"removingViolationMarker()","abstract":"Remove all violation markers from the examples.
","parent_name":"Array"},"Extensions/Array.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Array"},"Extensions/Array.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA0aB11SyntaxTokenVRszlE5kindsSay21SourceKittenFramework0D4KindOGvp":{"name":"kinds","abstract":"The kinds for these tokens.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA21ReasonedRuleViolationVRszlE6appendyy0A6Syntax16AbsolutePositionVF":{"name":"append(_:)","abstract":"Add a violation at the specified position using the default description and severity.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA21ReasonedRuleViolationVRszlE6append2at10correctiony0A6Syntax16AbsolutePositionV_AC0F10CorrectionVSgtF":{"name":"append(at:correction:)","abstract":"Add a violation and the correction at the specified position using the default description and severity.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA21ReasonedRuleViolationVRszlE6append10contentsOfySay0A6Syntax16AbsolutePositionVG_tF":{"name":"append(contentsOf:)","abstract":"Add violations for the specified positions using the default description and severity.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCore0A6Syntax04DeclD8Protocol_pXpRszlE3allSayAbC_pXpGvpZ":{"name":"all","abstract":"All visitable declaration syntax types.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCore0A6Syntax04DeclD8Protocol_pXpRszlE9allExceptySayAbC_pXpGAbC_pXpd_tFZ":{"name":"allExcept(_:)","abstract":"All declarations except for the specified ones.
","parent_name":"Array"},"Extensions/Array.html":{"name":"Array"},"Extensions/Optional.html":{"name":"Optional"},"Extensions/Bool.html":{"name":"Bool"},"Extensions/String.html":{"name":"String"},"Extensions/Set.html":{"name":"Set"},"Extensions/Int.html":{"name":"Int"},"Extensions/Double.html":{"name":"Double"},"Enums/IdentifierDeclaration.html#/s:13SwiftLintCore21IdentifierDeclarationO9parameteryAC0A6Syntax05TokenG0V_tcACmF":{"name":"parameter(name:)","abstract":"Parameter declaration with a name token.
","parent_name":"IdentifierDeclaration"},"Enums/IdentifierDeclaration.html#/s:13SwiftLintCore21IdentifierDeclarationO13localVariableyAC0A6Syntax05TokenH0V_tcACmF":{"name":"localVariable(name:)","abstract":"Local variable declaration with a name token.
","parent_name":"IdentifierDeclaration"},"Enums/IdentifierDeclaration.html#/s:13SwiftLintCore21IdentifierDeclarationO16implicitVariableyACSS_tcACmF":{"name":"implicitVariable(name:)","abstract":"A variable that is implicitly added by the compiler (e.g. error
in catch
clauses).
A variable hidden from scope because its name is a wildcard _
.
Special case that marks a type boundary at which name lookup stops.
","parent_name":"IdentifierDeclaration"},"Enums/IdentifierDeclaration.html#/s:13SwiftLintCore21IdentifierDeclarationO8declares2id18disregardBackticksSbSS_SbtF":{"name":"declares(id:disregardBackticks:)","abstract":"Check whether self declares a variable given by name.
","parent_name":"IdentifierDeclaration"},"Enums/ViolationSeverity.html#/s:13SwiftLintCore17ViolationSeverityO7warningyA2CmF":{"name":"warning","abstract":"Non-fatal. If using SwiftLint as an Xcode build phase, Xcode will mark the build as having succeeded.
","parent_name":"ViolationSeverity"},"Enums/ViolationSeverity.html#/s:13SwiftLintCore17ViolationSeverityO5erroryA2CmF":{"name":"error","abstract":"Fatal. If using SwiftLint as an Xcode build phase, Xcode will mark the build as having failed.
","parent_name":"ViolationSeverity"},"Enums/ViolationSeverity.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"ViolationSeverity"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO4callyA2CmF":{"name":"call","abstract":"A call to a named function or closure.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO8argumentyA2CmF":{"name":"argument","abstract":"An argument value for a function or closure.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO5arrayyA2CmF":{"name":"array","abstract":"An Array expression.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO10dictionaryyA2CmF":{"name":"dictionary","abstract":"A Dictionary expression.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO13objectLiteralyA2CmF":{"name":"objectLiteral","abstract":"An object literal expression. https://developer.apple.com/swift/blog/?id=33
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO7closureyA2CmF":{"name":"closure","abstract":"A closure expression. https://docs.swift.org/swift-book/LanguageGuide/Closures.html
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO5tupleyA2CmF":{"name":"tuple","abstract":"A tuple expression. https://docs.swift.org/swift-book/ReferenceManual/Types.html#ID448
","parent_name":"SwiftExpressionKind"},"Enums/RuleListError.html#/s:13SwiftLintCore13RuleListErrorO24duplicatedConfigurationsyAcA0D0_pXp_tcACmF":{"name":"duplicatedConfigurations(rule:)","abstract":"The rule list contains more than one configuration for the specified rule.
","parent_name":"RuleListError"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO4lintyA2CmF":{"name":"lint","abstract":"Describes rules that validate Swift source conventions.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO9idiomaticyA2CmF":{"name":"idiomatic","abstract":"Describes rules that validate common practices in the Swift community.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO5styleyA2CmF":{"name":"style","abstract":"Describes rules that validate stylistic choices.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO7metricsyA2CmF":{"name":"metrics","abstract":"Describes rules that validate magnitudes or measurements of Swift source.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO11performanceyA2CmF":{"name":"performance","abstract":"Describes rules that validate that code patterns with poor performance are avoided.
","parent_name":"RuleKind"},"Enums/RuleIdentifier.html#/s:13SwiftLintCore14RuleIdentifierO3allyA2CmF":{"name":"all","abstract":"Special identifier that should be treated as referring to ‘all’ SwiftLint rules. One helpful usecase is in","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:13SwiftLintCore14RuleIdentifierO6singleyACSS_tcACmF":{"name":"single(identifier:)","abstract":"
Represents a single SwiftLint rule with the specified identifier.
","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:13SwiftLintCore14RuleIdentifierO20stringRepresentationSSvp":{"name":"stringRepresentation","abstract":"The spelling of the string for this identifier.
","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:13SwiftLintCore14RuleIdentifierOyACSScfc":{"name":"init(_:)","abstract":"Creates a RuleIdentifier
by its string representation.
An irrelevant option. It will be ignored in documentation serialization.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO4flagyACSbcACmF":{"name":"flag(_:)","abstract":"A boolean flag.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO6stringyACSScACmF":{"name":"string(_:)","abstract":"A string option.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO6symbolyACSScACmF":{"name":"symbol(_:)","abstract":"Like a string option but without quotes in the serialized output.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO7integeryACSicACmF":{"name":"integer(_:)","abstract":"An integer option.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO5floatyACSdcACmF":{"name":"float(_:)","abstract":"A floating point number option.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO8severityyAcA17ViolationSeverityOcACmF":{"name":"severity(_:)","abstract":"Special option for a ViolationSeverity
.
A list of options.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO6nestedyAcA28RuleConfigurationDescriptionVcACmF":{"name":"nested(_:)","abstract":"An option which is another set of configuration options to be nested in the serialized output.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore12DocumentableP10hasContentSbvp":{"name":"hasContent","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore12DocumentableP8markdownSSyF":{"name":"markdown()","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore12DocumentableP8oneLinerSSyF":{"name":"oneLiner()","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore12DocumentableP4yamlSSyF":{"name":"yaml()","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO2egoiyAA017RuleConfigurationD0VSS_ACtFZ":{"name":"=>(_:_:)","abstract":"Operator enabling an easy way to create a configuration option.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO4nestyAcA28RuleConfigurationDescriptionVyXEFZ":{"name":"nest(_:)","abstract":"Create an option defined by nested configuration description.
","parent_name":"OptionType"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO20invalidConfigurationyACSS_SSSgtcACmF":{"name":"invalidConfiguration(ruleID:message:)","abstract":"The configuration didn’t match internal expectations.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO29deprecatedConfigurationOptionyACSS_S2SSgtcACmF":{"name":"deprecatedConfigurationOption(ruleID:key:alternative:)","abstract":"Issued when an option is deprecated. Suggests an alternative optionally.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO14nothingAppliedyACSS_tcACmF":{"name":"nothingApplied(ruleID:)","abstract":"Used in configuration parsing when no changes have been applied. Use only internally!
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO18listedMultipleTimeyACSS_SitcACmF":{"name":"listedMultipleTime(ruleID:times:)","abstract":"Rule is listed multiple times in the configuration.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO17renamedIdentifieryACSS_SStcACmF":{"name":"renamedIdentifier(old:new:)","abstract":"An identifier old
has been renamed to new
.
Some configuration keys are invalid.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO25inconsistentConfigurationyACSS_SStcACmF":{"name":"inconsistentConfiguration(ruleID:message:)","abstract":"The configuration is inconsistent, that is options are mutually exclusive or one drives other values","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO14invalidRuleIDsyACShySSGcACmF":{"name":"invalidRuleIDs(_:)","abstract":"
Used rule IDs are invalid.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO25ruleNotPresentInOnlyRulesyACSS_tcACmF":{"name":"ruleNotPresentInOnlyRules(ruleID:)","abstract":"Found a rule configuration for a rule that is not present in only_rules
.
Found a rule configuration for a rule that is disabled.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO33ruleDisabledInParentConfigurationyACSS_tcACmF":{"name":"ruleDisabledInParentConfiguration(ruleID:)","abstract":"Found a rule configuration for a rule that is disabled in the parent configuration.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO019ruleNotEnabledInOptH5RulesyACSS_tcACmF":{"name":"ruleNotEnabledInOptInRules(ruleID:)","abstract":"Found a rule configuration for a rule that is not enabled in opt_in_rules
.
Found a rule configuration for a rule that is not enabled in parent only_rules
.
A generic warning specified by a string.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO12genericErroryACSScACmF":{"name":"genericError(_:)","abstract":"A generic error specified by a string.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO14ruleDeprecatedyACSS_tcACmF":{"name":"ruleDeprecated(ruleID:)","abstract":"A deprecation warning for a rule.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO19initialFileNotFoundyACSS_tcACmF":{"name":"initialFileNotFound(path:)","abstract":"The initial configuration file was not found.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO12fileNotFoundyACSS_tcACmF":{"name":"fileNotFound(path:)","abstract":"A file at specified path was not found.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO15fileNotReadableyACSSSg_SStcACmF":{"name":"fileNotReadable(path:ruleID:)","abstract":"The file at path
is not readable or cannot be opened.
The file at path
is not writable.
The file at path
cannot be indexed by a specific rule.
No arguments were provided to compile a file at path
within a specific rule.
Cursor information cannot be extracted from a specific location.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO11yamlParsingyACSScACmF":{"name":"yamlParsing(_:)","abstract":"An error that occurred when parsing YAML.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO19baselineNotReadableyACSS_tcACmF":{"name":"baselineNotReadable(path:)","abstract":"The baseline file at path
is not readable or cannot be opened.
Print the issue to the console.
","parent_name":"Issue"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO7privateyA2CmF":{"name":"private","abstract":"Accessible by the declaration’s immediate lexical scope.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO11fileprivateyA2CmF":{"name":"fileprivate","abstract":"Accessible by the declaration’s same file.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO8internalyA2CmF":{"name":"internal","abstract":"Accessible by the declaration’s same module, or modules importing it with the @testable
attribute.
Accessible by all the modules defined in the same Swift package.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO6publicyA2CmF":{"name":"public","abstract":"Accessible by the declaration’s same program.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO4openyA2CmF":{"name":"open","abstract":"Accessible and customizable (via subclassing or overrides) by the declaration’s same program.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO11descriptionACSgSS_tcfc":{"name":"init(description:)","abstract":"Initializes an access control level by its Swift source keyword value.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO9isPrivateSbvp":{"name":"isPrivate","abstract":"Returns true if is private
or fileprivate
The accessibility of a Swift source declaration.
"},"Enums/Issue.html":{"name":"Issue","abstract":"All possible SwiftLint issues which are printed as warnings by default.
"},"Enums/OptionType.html":{"name":"OptionType","abstract":"Type of an option.
"},"Enums/RuleIdentifier.html":{"name":"RuleIdentifier","abstract":"An identifier representing a SwiftLint rule, or all rules.
"},"Enums/RuleKind.html":{"name":"RuleKind","abstract":"All the possible rule kinds (categories).
"},"Enums/RuleListError.html":{"name":"RuleListError","abstract":"All possible rule list configuration errors.
"},"Enums/SwiftExpressionKind.html":{"name":"SwiftExpressionKind","abstract":"The kind of expression for a contiguous set of Swift source tokens.
"},"Enums/ViolationSeverity.html":{"name":"ViolationSeverity","abstract":"The magnitude of a StyleViolation
.
An identifier declaration.
"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC13configurationxvp":{"name":"configuration","abstract":"A rule’s configuration.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC4fileAA0aB4FileCvp":{"name":"file","abstract":"The file from which the traversed syntax tree stems from.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC17locationConverter0aE0014SourceLocationH0Cvp":{"name":"locationConverter","abstract":"A source location converter associated with the syntax tree being traversed.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC13configuration4fileACyxGx_AA0aB4FileCtcfc":{"name":"init(configuration:file:)","abstract":"Initializer for a ViolationsSyntaxVisitor
.
Positions in a source file where violations should be reported.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC21skippableDeclarationsSay0aE004DeclE8Protocol_pXpGvp":{"name":"skippableDeclarations","abstract":"List of declaration types that shall be skipped while traversing the AST.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE09ActorDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE09ClassDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE08EnumDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE013ExtensionDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE012FunctionDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE015InitializerDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE012ProtocolDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE010StructDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE013SubscriptDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE012VariableDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC5Scopea":{"name":"Scope","abstract":"A type that remembers the declared identifiers (in order) up to the current position in the code.
","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC5scopeAA5StackVySayAA21IdentifierDeclarationOGGvp":{"name":"scope","abstract":"The hierarchical stack of identifiers declared up to the current position in the code.
","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC13configuration4file5scopeACyxGx_AA0aB4FileCAA5StackVySayAA21IdentifierDeclarationOGGtcfc":{"name":"init(configuration:file:scope:)","abstract":"Initializer.
","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC18hasSeenDeclaration3forSbSS_tF":{"name":"hasSeenDeclaration(for:)","abstract":"Indicate whether a given identifier is in scope.
","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC5visity0A6Syntax0iG12ContinueKindOAE017CodeBlockItemListI0VF":{"name":"visit(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC9visitPostyy0A6Syntax017CodeBlockItemListJ0VF":{"name":"visitPost(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC9visitPostyy0A6Syntax012VariableDeclJ0VF":{"name":"visitPost(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC9visitPostyy0A6Syntax09GuardStmtJ0VF":{"name":"visitPost(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC5visity0A6Syntax0iG12ContinueKindOAE011MemberBlockI0VF":{"name":"visit(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC9visitPostyy0A6Syntax011MemberBlockJ0VF":{"name":"visitPost(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC13configuration4fileACyxGx_AA0aB4FileCtcfc":{"name":"init(configuration:file:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax012AccessorDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09ActorDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax011CatchClauseI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09ClassDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax011ClosureExprI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09DeferStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax06DoStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax08EnumDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax013ExtensionDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax012FunctionDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax07ForStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09GuardStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax06IfExprI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax015InitializerDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax014PatternBindingI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax019PrecedenceGroupDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax012ProtocolDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax010RepeatStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax010StructDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax010SwitchExprI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09WhileStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC17collectViolations3foryqd__Sg_t0A6Syntax06BracedJ0Rd__lF":{"name":"collectViolations(for:)","abstract":"Collects violations for the given braced item. Intended to be specialized by subclasses.
","parent_name":"CodeBlockVisitor"},"Classes/BodyLengthRuleVisitor/Kind.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC4KindO7closureyAEyx_GAGmAA0F0RzlF":{"name":"closure","abstract":"Closure code blocks.
","parent_name":"Kind"},"Classes/BodyLengthRuleVisitor/Kind.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC4KindO8functionyAEyx_GAGmAA0F0RzlF":{"name":"function","abstract":"Function body blocks.
","parent_name":"Kind"},"Classes/BodyLengthRuleVisitor/Kind.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC4KindO4typeyAEyx_GAGmAA0F0RzlF":{"name":"type","abstract":"Type (class, enum, …) member blocks.
","parent_name":"Kind"},"Classes/BodyLengthRuleVisitor/Kind.html":{"name":"Kind","abstract":"The code block types to check.
","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC4kind4file13configurationACyxGAC4KindOyx_G_AA0aB4FileCAA27SeverityLevelsConfigurationVyxGtcfc":{"name":"init(kind:file:configuration:)","abstract":"Initializer.
","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax08EnumDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax09ClassDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax010StructDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax09ActorDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax011ClosureExprJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax012FunctionDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax015InitializerDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/CodeIndentingRewriter/IndentationStyle.html#/s:13SwiftLintCore21CodeIndentingRewriterC16IndentationStyleO12indentSpacesyAESicAEmF":{"name":"indentSpaces(_:)","abstract":"Indentation with a number of spaces.
","parent_name":"IndentationStyle"},"Classes/CodeIndentingRewriter/IndentationStyle.html#/s:13SwiftLintCore21CodeIndentingRewriterC16IndentationStyleO14unindentSpacesyAESicAEmF":{"name":"unindentSpaces(_:)","abstract":"Reverse indentation of a number of spaces.
","parent_name":"IndentationStyle"},"Classes/CodeIndentingRewriter/IndentationStyle.html#/s:13SwiftLintCore21CodeIndentingRewriterC16IndentationStyleO10indentTabsyAESicAEmF":{"name":"indentTabs(_:)","abstract":"Indentation with a number of tabs
","parent_name":"IndentationStyle"},"Classes/CodeIndentingRewriter/IndentationStyle.html#/s:13SwiftLintCore21CodeIndentingRewriterC16IndentationStyleO12unindentTabsyAESicAEmF":{"name":"unindentTabs(_:)","abstract":"Reverse indentation of a number of tabs.
","parent_name":"IndentationStyle"},"Classes/CodeIndentingRewriter/IndentationStyle.html":{"name":"IndentationStyle","abstract":"Style defining whether the rewriter shall indent or unindent and whether it shall use tabs or spaces and","parent_name":"CodeIndentingRewriter"},"Classes/CodeIndentingRewriter.html#/s:13SwiftLintCore21CodeIndentingRewriterC5styleA2C16IndentationStyleO_tcfc":{"name":"init(style:)","abstract":"
Initializer accepting an indentation style.
","parent_name":"CodeIndentingRewriter"},"Classes/CodeIndentingRewriter.html#/s:13SwiftLintCore21CodeIndentingRewriterC5visity0A6Syntax05TokenH0VAGF":{"name":"visit(_:)","parent_name":"CodeIndentingRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC13configurationxvp":{"name":"configuration","abstract":"A rule’s configuration.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC4fileAA0aB4FileCvp":{"name":"file","abstract":"The file from which the traversed syntax tree stems from.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC17locationConverter0aE0014SourceLocationH0Cvp":{"name":"locationConverter","abstract":"A converter of positions in the traversed source file.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC15disabledRegionsSay0aE011SourceRangeVGvp":{"name":"disabledRegions","abstract":"The regions in the traversed file that are disabled by a command.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC19correctionPositionsSay0aE016AbsolutePositionVGvp":{"name":"correctionPositions","abstract":"Positions in a source file where corrections were applied.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC13configuration4fileACyxGx_AA0aB4FileCtcfc":{"name":"init(configuration:file:)","abstract":"Initializer for a ViolationsSyntaxRewriter
.
The underlying SourceKitten file.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC2id10Foundation4UUIDVvp":{"name":"id","abstract":"The associated unique identifier for this file.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC06isTestD0Sbvp":{"name":"isTestFile","abstract":"Whether or not this is a file generated for testing purposes.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC9isVirtualSbvp":{"name":"isVirtual","abstract":"A file is virtual if it is not backed by a filesystem path.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC4fileAC21SourceKittenFramework0D0C_tcfc":{"name":"init(file:)","abstract":"Creates a SwiftLintFile
with a SourceKitten File
.
Creates a SwiftLintFile
by specifying its path on disk.","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC20pathDeferringReadingACSS_tcfc":{"name":"init(pathDeferringReading:)","abstract":"
Creates a SwiftLintFile
by specifying its path on disk. Unlike the SwiftLintFile(path:)
initializer, this","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC8contentsACSS_tcfc":{"name":"init(contents:)","abstract":"
Creates a SwiftLintFile
that is not backed by a file on disk by specifying its contents.
The path on disk for this file.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC8contentsSSvp":{"name":"contents","abstract":"The file’s contents.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC10stringView21SourceKittenFramework06StringF0Vvp":{"name":"stringView","abstract":"A string view into the contents of this file optimized for string manipulation operations.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC5linesSay21SourceKittenFramework4LineVGvp":{"name":"lines","abstract":"The parsed lines for this file’s contents.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"SwiftLintFile"},"Classes/RuleStorage.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RuleStorage"},"Classes/RuleStorage.html#/s:13SwiftLintCore11RuleStorageCACycfc":{"name":"init()","abstract":"Creates a RuleStorage
with no initial stored data.
Shared rule registry instance.
","parent_name":"RuleRegistry"},"Classes/RuleRegistry.html#/s:13SwiftLintCore12RuleRegistryC4listAA0D4ListVvp":{"name":"list","abstract":"Rule list associated with this registry. Lazily created, and","parent_name":"RuleRegistry"},"Classes/RuleRegistry.html#/s:13SwiftLintCore12RuleRegistryC8register5rulesySayAA0D0_pXpG_tF":{"name":"register(rules:)","abstract":"
Register rules.
","parent_name":"RuleRegistry"},"Classes/RuleRegistry.html#/s:13SwiftLintCore12RuleRegistryC4rule5forIDAA0D0_pXpSgSS_tF":{"name":"rule(forID:)","abstract":"Look up a rule for a given ID.
","parent_name":"RuleRegistry"},"Classes/RuleRegistry.html":{"name":"RuleRegistry","abstract":"Container to register and look up SwiftLint rules.
"},"Classes/RuleStorage.html":{"name":"RuleStorage","abstract":"A storage mechanism for aggregating the results of CollectingRule
s.
A unit of Swift source code, either on disk or in memory.
"},"Classes/ViolationsSyntaxRewriter.html":{"name":"ViolationsSyntaxRewriter","abstract":"A SwiftSyntax SyntaxRewriter
that produces absolute positions where corrections were applied.
Rewriter that indents or unindents a syntax piece including comments and nested"},"Classes/BodyLengthRuleVisitor.html":{"name":"BodyLengthRuleVisitor","abstract":"
Visitor that collection violations of code block lengths.
"},"Classes/CodeBlockVisitor.html":{"name":"CodeBlockVisitor","abstract":"A visitor that collects style violations for all available code blocks.
"},"Classes/DeclaredIdentifiersTrackingVisitor.html":{"name":"DeclaredIdentifiersTrackingVisitor","abstract":"A specialized ViolationsSyntaxVisitor
that tracks declared identifiers per scope while traversing the AST.
A SwiftSyntax SyntaxVisitor
that produces absolute positions where violations should be reported.
The following guides are available globally.
"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally.
"},"Enums.html":{"name":"Enumerations","abstract":"The following enumerations are available globally.
"},"Extensions.html":{"name":"Extensions","abstract":"The following extensions are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally.
"},"Structs.html":{"name":"Structures","abstract":"The following structures are available globally.
"},"Macros.html":{"name":"Macros","abstract":"The following macros are available globally.
"}} \ No newline at end of file +{"Macros.html#/s:13SwiftLintCore16AutoConfigParseryycfm":{"name":"AutoConfigParser()","abstract":"Macro to be attached to rule configurations. It generates the configuration parsing logic"},"Macros.html#/s:13SwiftLintCore32AcceptableByConfigurationElementyycfm":{"name":"AcceptableByConfigurationElement()","abstract":"
Macro that lets an enum with a String
raw type automatically conform to AcceptableByConfigurationElement
.
Macro that adds a conformance to the SwiftSyntaxRule
protocol and a default makeVisitor(file:)
implementation"},"Structs/SeverityLevelsConfiguration.html#/s:13SwiftLintCore27SeverityLevelsConfigurationV7warningSivp":{"name":"warning","abstract":"
The threshold for a violation to be a warning.
","parent_name":"SeverityLevelsConfiguration"},"Structs/SeverityLevelsConfiguration.html#/s:13SwiftLintCore27SeverityLevelsConfigurationV5errorSiSgvp":{"name":"error","abstract":"The threshold for a violation to be an error.
","parent_name":"SeverityLevelsConfiguration"},"Structs/SeverityLevelsConfiguration.html#/s:13SwiftLintCore27SeverityLevelsConfigurationV7warning5errorACyxGSi_SiSgtcfc":{"name":"init(warning:error:)","abstract":"Create a SeverityLevelsConfiguration
based on the specified warning
and error
thresholds.
The rule parameters that define the thresholds that should map to each severity.
","parent_name":"SeverityLevelsConfiguration"},"Structs/SeverityLevelsConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP5apply13configurationyyp_tKF":{"name":"apply(configuration:)","parent_name":"SeverityLevelsConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV10identifierSSvp":{"name":"identifier","abstract":"The identifier for this custom rule.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV4nameSSSgvp":{"name":"name","abstract":"The name for this custom rule.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV7messageSSvp":{"name":"message","abstract":"The message to be presented when producing violations.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV8includedSaySo19NSRegularExpressionCGvp":{"name":"included","abstract":"Regular expressions to include when matching the file path.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV8excludedSaySo19NSRegularExpressionCGvp":{"name":"excluded","abstract":"Regular expressions to exclude when matching the file path.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV18excludedMatchKindsShy21SourceKittenFramework10SyntaxKindOGvp":{"name":"excludedMatchKinds","abstract":"The syntax kinds to exclude from matches. If the regex matched syntax kinds from this list, it would","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore30SeverityBasedRuleConfigurationP08severityG0AA0dG0Vy6ParentQzGvp":{"name":"severityConfiguration","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV12captureGroupSivp":{"name":"captureGroup","abstract":"
The index of the regex capture group to match.
","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore24CacheDescriptionProviderP05cacheE0SSvp":{"name":"cacheDescription","parent_name":"RegexConfiguration"},"Structs/RegexConfiguration.html#/s:13SwiftLintCore18RegexConfigurationV11descriptionAA15RuleDescriptionVvp":{"name":"description","abstract":"The RuleDescription
for the custom rule defined here.
Create a RegexConfiguration
with the specified identifier, with other properties to be set later.
Create a ViolationCorrection
.
The correction of a violation that is basically the violation’s range in the source code and a","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV8position0A6Syntax16AbsolutePositionVvp":{"name":"position","abstract":"
The violation’s position.
","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV6reasonSSSgvp":{"name":"reason","abstract":"A specific reason for the violation.
","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV8severityAA0F8SeverityOSgvp":{"name":"severity","abstract":"The violation’s severity.
","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV10correctionAC0F10CorrectionVSgvp":{"name":"correction","abstract":"An optional correction of the violation to be used in rewriting (see SwiftSyntaxCorrectableRule
). Can be","parent_name":"ReasonedRuleViolation"},"Structs/ReasonedRuleViolation.html#/s:13SwiftLintCore21ReasonedRuleViolationV8position6reason8severity10correctionAC0A6Syntax16AbsolutePositionV_SSSgAA0F8SeverityOSgAC0F10CorrectionVSgtcfc":{"name":"init(position:reason:severity:correction:)","abstract":"
Creates a ReasonedRuleViolation
.
Swift 5
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV10fiveDotOneACvpZ":{"name":"fiveDotOne","abstract":"Swift 5.1
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV10fiveDotTwoACvpZ":{"name":"fiveDotTwo","abstract":"Swift 5.2
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV12fiveDotThreeACvpZ":{"name":"fiveDotThree","abstract":"Swift 5.3
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV11fiveDotFourACvpZ":{"name":"fiveDotFour","abstract":"Swift 5.4
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV11fiveDotFiveACvpZ":{"name":"fiveDotFive","abstract":"Swift 5.5
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV10fiveDotSixACvpZ":{"name":"fiveDotSix","abstract":"Swift 5.6
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV12fiveDotSevenACvpZ":{"name":"fiveDotSeven","abstract":"Swift 5.7
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV12fiveDotEightACvpZ":{"name":"fiveDotEight","abstract":"Swift 5.8
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV11fiveDotNineACvpZ":{"name":"fiveDotNine","abstract":"Swift 5.9
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV3sixACvpZ":{"name":"six","abstract":"Swift 6
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:13SwiftLintCore0A7VersionV7currentACvpZ":{"name":"current","abstract":"The current detected Swift compiler version, based on the currently accessible SourceKit version.
","parent_name":"SwiftVersion"},"Structs/SwiftLintSyntaxToken.html#/s:13SwiftLintCore0aB11SyntaxTokenV5value21SourceKittenFramework0dE0Vvp":{"name":"value","abstract":"The raw SyntaxToken
obtained by SourceKitten.
The syntax kind associated with is token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:13SwiftLintCore0aB11SyntaxTokenV5valueAC21SourceKittenFramework0dE0V_tcfc":{"name":"init(value:)","abstract":"Creates a SwiftLintSyntaxToken
from the raw SyntaxToken
obtained by SourceKitten.
The byte range in a source file for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:13SwiftLintCore0aB11SyntaxTokenV6offset21SourceKittenFramework9ByteCountVvp":{"name":"offset","abstract":"The starting byte offset in a source file for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:13SwiftLintCore0aB11SyntaxTokenV6length21SourceKittenFramework9ByteCountVvp":{"name":"length","abstract":"The length in bytes for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxMap.html#/s:13SwiftLintCore0aB9SyntaxMapV5value21SourceKittenFramework0dE0Vvp":{"name":"value","abstract":"The raw SyntaxMap
obtained by SourceKitten.
The SwiftLint-specific syntax tokens for this syntax map.
","parent_name":"SwiftLintSyntaxMap"},"Structs/SwiftLintSyntaxMap.html#/s:13SwiftLintCore0aB9SyntaxMapV5valueAC21SourceKittenFramework0dE0V_tcfc":{"name":"init(value:)","abstract":"Creates a SwiftLintSyntaxMap
from the raw SyntaxMap
obtained by SourceKitten.
Returns array of syntax tokens intersecting with byte range.
","parent_name":"SwiftLintSyntaxMap"},"Structs/SwiftLintSyntaxMap.html#/s:13SwiftLintCore0aB9SyntaxMapV5kinds11inByteRangeSay21SourceKittenFramework0D4KindOGAF0hI0V_tF":{"name":"kinds(inByteRange:)","abstract":"Returns the syntax kinds in the specified byte range.
","parent_name":"SwiftLintSyntaxMap"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV14ruleIdentifierSSvp":{"name":"ruleIdentifier","abstract":"The identifier of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV15ruleDescriptionSSvp":{"name":"ruleDescription","abstract":"The description of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV8ruleNameSSvp":{"name":"ruleName","abstract":"The name of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV8severityAA0E8SeverityOvp":{"name":"severity","abstract":"The severity of this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV8locationAA8LocationVvp":{"name":"location","abstract":"The location of this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV6reasonSSvp":{"name":"reason","abstract":"The justification for this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV11descriptionSSvp":{"name":"description","abstract":"A printable description for this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:13SwiftLintCore14StyleViolationV15ruleDescription8severity8location6reasonAcA04RuleG0V_AA0E8SeverityOAA8LocationVSSSgtcfc":{"name":"init(ruleDescription:severity:location:reason:)","abstract":"Creates a StyleViolation
by specifying its properties directly.
Returns the same violation, but with the severity
that is passed in
Returns the same violation, but with the location
that is passed in
The severity that should be assigned to the violation of this parameter’s value is met.
","parent_name":"RuleParameter"},"Structs/RuleParameter.html#/s:13SwiftLintCore13RuleParameterV5valuexvp":{"name":"value","abstract":"The value to configure the rule.
","parent_name":"RuleParameter"},"Structs/RuleParameter.html#/s:13SwiftLintCore13RuleParameterV8severity5valueACyxGAA17ViolationSeverityO_xtcfc":{"name":"init(severity:value:)","abstract":"Creates a RuleParameter
by specifying its properties directly.
The rules contained in this list.
","parent_name":"RuleList"},"Structs/RuleList.html#/s:13SwiftLintCore8RuleListV5rulesAcA0D0_pXpd_tcfc":{"name":"init(rules:)","abstract":"Creates a RuleList
by specifying all its rules.
Creates a RuleList
by specifying all its rules.
The rule’s unique identifier, to be used in configuration files and SwiftLint commands.","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV4nameSSvp":{"name":"name","abstract":"
The rule’s human-readable name. Should be short, descriptive and formatted in Title Case. May contain spaces.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV11descriptionSSvp":{"name":"description","abstract":"The rule’s verbose description. Should read as a sentence or short paragraph. Good things to include are an","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV4kindAA0D4KindOvp":{"name":"kind","abstract":"
The RuleKind
that best categorizes this rule.
Swift source examples that do not trigger a violation for this rule. Used for documentation purposes to inform","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV18triggeringExamplesSayAA7ExampleVGvp":{"name":"triggeringExamples","abstract":"
Swift source examples that do trigger one or more violations for this rule. Used for documentation purposes to","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV11correctionsSDyAA7ExampleVAFGvp":{"name":"corrections","abstract":"
Pairs of Swift source examples, where keys are examples that trigger violations for this rule, and the values","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV17deprecatedAliasesShySSGvp":{"name":"deprecatedAliases","abstract":"
Any previous iteration of the rule’s identifier that was previously shipped with SwiftLint.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV03minA7VersionAA0aG0Vvp":{"name":"minSwiftVersion","abstract":"The oldest version of the Swift compiler supported by this rule.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV18requiresFileOnDiskSbvp":{"name":"requiresFileOnDisk","abstract":"Whether or not this rule can only be executed on a file physically on-disk. Typically necessary for rules","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV07consoleE0SSvp":{"name":"consoleDescription","abstract":"
The console-printable string for this description.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV14allIdentifiersSaySSGvp":{"name":"allIdentifiers","abstract":"All identifiers that have been used to uniquely identify this rule in past and current SwiftLint versions.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:13SwiftLintCore15RuleDescriptionV10identifier4name11description4kind03minA7Version21nonTriggeringExamples010triggeringN011corrections17deprecatedAliases18requiresFileOnDiskACSS_S2SAA0D4KindOAA0aK0VSayAA7ExampleVGATSDyA2SGShySSGSbtcfc":{"name":"init(identifier:name:description:kind:minSwiftVersion:nonTriggeringExamples:triggeringExamples:corrections:deprecatedAliases:requiresFileOnDisk:)","abstract":"Creates a RuleDescription
by specifying all its properties directly.
Configuration with a warning severity.
","parent_name":"SeverityConfiguration"},"Structs/SeverityConfiguration.html#/s:13SwiftLintCore21SeverityConfigurationV7warningACyxGvpZ":{"name":"warning","abstract":"Configuration with an error severity.
","parent_name":"SeverityConfiguration"},"Structs/SeverityConfiguration.html#/s:13SwiftLintCore30SeverityBasedRuleConfigurationP08severityG0AA0dG0Vy6ParentQzGvp":{"name":"severityConfiguration","parent_name":"SeverityConfiguration"},"Structs/SeverityConfiguration.html#/s:13SwiftLintCore21SeverityConfigurationVyACyxGAA09ViolationD0Ocfc":{"name":"init(_:)","abstract":"Create a SeverityConfiguration
with the specified severity.
Severity configurations are special in that they shall not be nested when an option name is provided.","parent_name":"SeverityConfiguration"},"Structs/ConfigurationElement/DeprecationNotice.html#/s:13SwiftLintCore20ConfigurationElementV17DeprecationNoticeO18suggestAlternativeyAEyx_GSS_SStcAGmSQRzs8SendableRzAA012AcceptableBydE0RzlF":{"name":"suggestAlternative(ruleID:name:)","abstract":"
Warning suggesting an alternative option.
","parent_name":"DeprecationNotice"},"Structs/ConfigurationElement/DeprecationNotice.html":{"name":"DeprecationNotice","abstract":"A deprecation notice.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV12wrappedValuexvp":{"name":"wrappedValue","abstract":"Wrapped option value.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV14projectedValueACyxGvp":{"name":"projectedValue","abstract":"The wrapper itself providing access to all its data. This field can only be accessed by the","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV3keySSvp":{"name":"key","abstract":"
Name of this configuration entry.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV6inlineSbvp":{"name":"inline","abstract":"Whether this configuration element will be inlined into its description.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV12wrappedValue3key17deprecationNotice13postprocessorACyxGx_SSAC011DeprecationJ0Oyx_GSgyxzYbctcfc":{"name":"init(wrappedValue:key:deprecationNotice:postprocessor:)","abstract":"Default constructor.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV3keyACyqd__SgGSS_tcAERszSQRd__s8SendableRd__AA012AcceptableBydE0Rd__lufc":{"name":"init(key:)","abstract":"Constructor for optional values.
","parent_name":"ConfigurationElement"},"Structs/ConfigurationElement.html#/s:13SwiftLintCore20ConfigurationElementV12wrappedValue6inlineACyxGx_SbtcAA19InlinableOptionTypeRzrlufc":{"name":"init(wrappedValue:inline:)","abstract":"Constructor for an InlinableOptionType
without a key.
Constructor for an InlinableOptionType
with a name. The configuration will explicitly not be inlined.
An option serving as a marker for an empty configuration description.
","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationOption.html#/s:13SwiftLintCore12DocumentableP10hasContentSbvp":{"name":"hasContent","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationOption.html#/s:13SwiftLintCore12DocumentableP8markdownSSyF":{"name":"markdown()","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationOption.html#/s:13SwiftLintCore12DocumentableP8oneLinerSSyF":{"name":"oneLiner()","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationOption.html#/s:13SwiftLintCore12DocumentableP4yamlSSyF":{"name":"yaml()","parent_name":"RuleConfigurationOption"},"Structs/RuleConfigurationDescription.html#/s:13SwiftLintCore12DocumentableP10hasContentSbvp":{"name":"hasContent","parent_name":"RuleConfigurationDescription"},"Structs/RuleConfigurationDescription.html#/s:13SwiftLintCore12DocumentableP8oneLinerSSyF":{"name":"oneLiner()","parent_name":"RuleConfigurationDescription"},"Structs/RuleConfigurationDescription.html#/s:13SwiftLintCore12DocumentableP8markdownSSyF":{"name":"markdown()","parent_name":"RuleConfigurationDescription"},"Structs/RuleConfigurationDescription.html#/s:13SwiftLintCore12DocumentableP4yamlSSyF":{"name":"yaml()","parent_name":"RuleConfigurationDescription"},"Structs/Region.html#/s:13SwiftLintCore6RegionV5startAA8LocationVvp":{"name":"start","abstract":"The location describing the start of the region. All locations that are less than this value","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV3endAA8LocationVvp":{"name":"end","abstract":"
The location describing the end of the region. All locations that are greater than this value","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV23disabledRuleIdentifiersShyAA0F10IdentifierOGvp":{"name":"disabledRuleIdentifiers","abstract":"
All SwiftLint rule identifiers that are disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV5start3end23disabledRuleIdentifiersAcA8LocationV_AHShyAA0H10IdentifierOGtcfc":{"name":"init(start:end:disabledRuleIdentifiers:)","abstract":"Creates a Region by setting explicit values for all its properties.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV8containsySbAA8LocationVF":{"name":"contains(_:)","abstract":"Whether the specific location is contained in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV13isRuleEnabledySbxAA0F0RzlF":{"name":"isRuleEnabled(_:)","abstract":"Whether the specified rule is enabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV14isRuleDisabledySbxAA0F0RzlF":{"name":"isRuleDisabled(_:)","abstract":"Whether the specified rule is disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV16areRulesDisabled7ruleIDsSbSaySSG_tF":{"name":"areRulesDisabled(ruleIDs:)","abstract":"Whether the given rules are disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:13SwiftLintCore6RegionV26deprecatedAliasesDisabling4ruleShySSGx_tAA4RuleRzlF":{"name":"deprecatedAliasesDisabling(rule:)","abstract":"Returns the deprecated rule aliases that are disabling the specified rule in this region.","parent_name":"Region"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4fileSSSgvp":{"name":"file","abstract":"
The file path on disk for this location.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4lineSiSgvp":{"name":"line","abstract":"The line offset in the file for this location. 1-indexed.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV9characterSiSgvp":{"name":"character","abstract":"The character offset in the file for this location. 1-indexed.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV11descriptionSSvp":{"name":"description","abstract":"A lossless printable description of this location.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV12relativeFileSSSgvp":{"name":"relativeFile","abstract":"The file path for this location relative to the current working directory.
","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4file4line9characterACSSSg_SiSgAHtcfc":{"name":"init(file:line:character:)","abstract":"Creates a Location
by specifying its properties directly.
Creates a Location
based on a SwiftLintFile
and a byte-offset into the file.","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4file8positionAcA0aB4FileC_0A6Syntax16AbsolutePositionVtcfc":{"name":"init(file:position:)","abstract":"
Creates a Location
based on a SwiftLintFile
and a SwiftSyntax AbsolutePosition
into the file.","parent_name":"Location"},"Structs/Location.html#/s:13SwiftLintCore8LocationV4file15characterOffsetAcA0aB4FileC_Sitcfc":{"name":"init(file:characterOffset:)","abstract":"
Creates a Location
based on a SwiftLintFile
and a UTF8 character-offset into the file.","parent_name":"Location"},"Structs/Location.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"Location"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV4codeSSvp":{"name":"code","abstract":"
The contents of the example
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV13configurationSDySSs8Sendable_pGSgvp":{"name":"configuration","abstract":"The untyped configuration to apply to the rule, if deviating from the default configuration.","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV20testMultiByteOffsetsSbvp":{"name":"testMultiByteOffsets","abstract":"
Whether the example should be tested by prepending multibyte grapheme clusters
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV11testOnLinuxSbvp":{"name":"testOnLinux","abstract":"Whether the example should be tested on Linux
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV4files12StaticStringVvp":{"name":"file","abstract":"The path to the file where the example was created
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV4lineSuvp":{"name":"line","abstract":"The line in the file where the example was created
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV_13configuration20testMultiByteOffsets0F17WrappingInComment0fjK6String0F14DisableCommand0F7OnLinux4file4line24excludeFromDocumentationACSS_SDySSs8Sendable_pGSgS5bs06StaticM0VSuSbtcfc":{"name":"init(_:configuration:testMultiByteOffsets:testWrappingInComment:testWrappingInString:testDisableCommand:testOnLinux:file:line:excludeFromDocumentation:)","abstract":"Create a new Example with the specified code, file, and line.
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV4with4codeACSS_tF":{"name":"with(code:)","abstract":"Returns the same example, but with the code
that is passed in
Returns a copy of the Example with all instances of the “↓” character removed.
","parent_name":"Example"},"Structs/Example.html#/s:13SwiftLintCore7ExampleV7focusedACyF":{"name":"focused()","abstract":"Makes the current example focused. This is for debugging purposes only.
","parent_name":"Example"},"Structs/Example.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"Example"},"Structs/Example.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"Example"},"Structs/Example.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"Example"},"Structs/Correction.html#/s:13SwiftLintCore10CorrectionV15ruleDescriptionAA04RuleF0Vvp":{"name":"ruleDescription","abstract":"The description of the rule for which this correction was applied.
","parent_name":"Correction"},"Structs/Correction.html#/s:13SwiftLintCore10CorrectionV8locationAA8LocationVvp":{"name":"location","abstract":"The location of the original violation that was corrected.
","parent_name":"Correction"},"Structs/Correction.html#/s:13SwiftLintCore10CorrectionV18consoleDescriptionSSvp":{"name":"consoleDescription","abstract":"The console-printable description for this correction.
","parent_name":"Correction"},"Structs/Correction.html#/s:13SwiftLintCore10CorrectionV15ruleDescription8locationAcA04RuleF0V_AA8LocationVtcfc":{"name":"init(ruleDescription:location:)","abstract":"Memberwise initializer.
","parent_name":"Correction"},"Structs/Command/Modifier.html#/s:13SwiftLintCore7CommandV8ModifierO8previousyA2EmF":{"name":"previous","abstract":"The command should only apply to the line preceding its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:13SwiftLintCore7CommandV8ModifierO4thisyA2EmF":{"name":"this","abstract":"The command should only apply to the same line as its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:13SwiftLintCore7CommandV8ModifierO4nextyA2EmF":{"name":"next","abstract":"The command should only apply to the line following its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:13SwiftLintCore7CommandV8ModifierO7invalidyA2EmF":{"name":"invalid","abstract":"The modifier string was invalid.
","parent_name":"Modifier"},"Structs/Command/Action.html#/s:13SwiftLintCore7CommandV6ActionO6enableyA2EmF":{"name":"enable","abstract":"The rule(s) associated with this command should be enabled by the SwiftLint engine.
","parent_name":"Action"},"Structs/Command/Action.html#/s:13SwiftLintCore7CommandV6ActionO7disableyA2EmF":{"name":"disable","abstract":"The rule(s) associated with this command should be disabled by the SwiftLint engine.
","parent_name":"Action"},"Structs/Command/Action.html#/s:13SwiftLintCore7CommandV6ActionO7invalidyA2EmF":{"name":"invalid","abstract":"The action string was invalid.
","parent_name":"Action"},"Structs/Command/Action.html":{"name":"Action","abstract":"The action (verb) that SwiftLint should perform when interpreting this command.
","parent_name":"Command"},"Structs/Command/Modifier.html":{"name":"Modifier","abstract":"The modifier for a command, used to modify its scope.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV6actionAC6ActionOvp":{"name":"action","abstract":"The action (verb) that SwiftLint should perform when interpreting this command.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV15ruleIdentifiersShyAA14RuleIdentifierOGvp":{"name":"ruleIdentifiers","abstract":"The identifiers for the rules associated with this command.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV4lineSivp":{"name":"line","abstract":"The line in the source file where this command is defined.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV9characterSiSgvp":{"name":"character","abstract":"The character offset within the line in the source file where this command is defined.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV8modifierAC8ModifierOSgvp":{"name":"modifier","abstract":"This command’s modifier, if any.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV6action15ruleIdentifiers4line9character8modifier15trailingCommentA2C6ActionO_ShyAA14RuleIdentifierOGS2iSgAC8ModifierOSgSSSgtcfc":{"name":"init(action:ruleIdentifiers:line:character:modifier:trailingComment:)","abstract":"Creates a command based on the specified parameters.
","parent_name":"Command"},"Structs/Command.html#/s:13SwiftLintCore7CommandV12actionString4line9characterACSS_S2itcfc":{"name":"init(actionString:line:character:)","abstract":"Creates a command based on the specified parameters.
","parent_name":"Command"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32ChildOptionSeverityConfigurationV5errorACyxGvpZ":{"name":"error","abstract":"Configuration with a warning severity.
","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32ChildOptionSeverityConfigurationV7warningACyxGvpZ":{"name":"warning","abstract":"Configuration with an error severity.
","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32ChildOptionSeverityConfigurationV3offACyxGvpZ":{"name":"off","abstract":"Configuration disabling an option.
","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32ChildOptionSeverityConfigurationV8severityAA09ViolationF0OSgvp":{"name":"severity","abstract":"The ChildOptionSeverityConfiguration
mapped to a usually used ViolationSeverity
. It’s nil
if the option","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP5apply13configurationyyp_tKF":{"name":"apply(configuration:)","parent_name":"ChildOptionSeverityConfiguration"},"Structs/ChildOptionSeverityConfiguration.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"ChildOptionSeverityConfiguration"},"Structs/Baseline.html#/s:13SwiftLintCore8BaselineV10violationsSayAA14StyleViolationVGvp":{"name":"violations","abstract":"
The stored violations.
","parent_name":"Baseline"},"Structs/Baseline.html#/s:13SwiftLintCore8BaselineV8fromPathACSS_tKcfc":{"name":"init(fromPath:)","abstract":"Creates a Baseline
from a saved file.
Creates a Baseline
from a list of violations.
Writes a Baseline
to disk in JSON format.
Filters out violations that are present in the Baseline
.
Returns the violations that are present in another Baseline
, but not in this one.
Creates an empty Stack
.
The number of elements in this stack.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV4pushyyxF":{"name":"push(_:)","abstract":"Pushes (appends) an element onto the stack.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV3popxSgyF":{"name":"pop()","abstract":"Removes and returns the last element of the stack.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV4peekxSgyF":{"name":"peek()","abstract":"Returns the last element of the stack if the stack is not empty; otherwise, nil.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV8contains5whereS2bxXE_tF":{"name":"contains(where:)","abstract":"Check whether the sequence contains an element that satisfies the given predicate.
","parent_name":"Stack"},"Structs/Stack.html#/s:13SwiftLintCore5StackV10modifyLast2byyyxzXE_tF":{"name":"modifyLast(by:)","abstract":"Modify the last element.
","parent_name":"Stack"},"Structs/Stack.html#/s:ST12makeIterator0B0QzyF":{"name":"makeIterator()","parent_name":"Stack"},"Structs/Stack.html#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp":{"name":"debugDescription","parent_name":"Stack"},"Structs/Stack.html":{"name":"Stack","abstract":"A basic stack type implementing the LIFO principle - only the last inserted element can be accessed and removed.
"},"Structs/Baseline.html":{"name":"Baseline","abstract":"A set of violations that can be used to filter newly detected violations.
"},"Structs/ChildOptionSeverityConfiguration.html":{"name":"ChildOptionSeverityConfiguration","abstract":"A rule configuration that allows to disable (off
) an option of a rule or specify its severity level in which"},"Structs/Command.html":{"name":"Command","abstract":"
A SwiftLint-interpretable command to modify SwiftLint’s behavior embedded as comments in source code.
"},"Structs/Correction.html":{"name":"Correction","abstract":"A value describing a SwiftLint violation that was corrected.
"},"Structs/Example.html":{"name":"Example","abstract":"Captures code and context information for an example of a triggering or"},"Structs/Location.html":{"name":"Location","abstract":"
The placement of a segment of Swift in a collection of source files.
"},"Structs/Region.html":{"name":"Region","abstract":"A contiguous region of Swift source code.
"},"Structs/RuleConfigurationDescription.html":{"name":"RuleConfigurationDescription","abstract":"Description of a rule configuration.
"},"Structs/RuleConfigurationOption.html":{"name":"RuleConfigurationOption","abstract":"A single option of a RuleConfigurationDescription
.
A result builder creating configuration descriptions.
"},"Structs/ConfigurationElement.html":{"name":"ConfigurationElement","abstract":"A single parameter of a rule configuration.
"},"Structs/SeverityConfiguration.html":{"name":"SeverityConfiguration","abstract":"A rule configuration that allows specifying the desired severity level for violations.
"},"Structs/RuleDescription.html":{"name":"RuleDescription","abstract":"A detailed description for a SwiftLint rule. Used for both documentation and testing purposes.
"},"Structs/RuleList.html":{"name":"RuleList","abstract":"A list of available SwiftLint rules.
"},"Structs/RuleParameter.html":{"name":"RuleParameter","abstract":"A configuration parameter for rules.
"},"Structs/StyleViolation.html":{"name":"StyleViolation","abstract":"A value describing an instance of Swift source code that is considered invalid by a SwiftLint rule.
"},"Structs/SwiftLintSyntaxMap.html":{"name":"SwiftLintSyntaxMap","abstract":"Represents a Swift file’s syntax information.
"},"Structs/SwiftLintSyntaxToken.html":{"name":"SwiftLintSyntaxToken","abstract":"A SwiftLint-aware Swift syntax token.
"},"Structs/SwiftVersion.html":{"name":"SwiftVersion","abstract":"A value describing the version of the Swift compiler.
"},"Structs/ReasonedRuleViolation.html":{"name":"ReasonedRuleViolation","abstract":"A violation produced by ViolationsSyntaxVisitor
s.
A rule configuration used for defining custom rules in yaml.
"},"Structs/SeverityLevelsConfiguration.html":{"name":"SeverityLevelsConfiguration","abstract":"A rule configuration that allows specifying thresholds for warning
and error
severities.
Produce a ViolationsSyntaxVisitor
for the given file.
Produce a violation for the given file and absolute position.
","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxRule.html#/s:13SwiftLintCore0A10SyntaxRuleP10preprocess4file0aD0010SourceFileD0VSgAA0abI0C_tF":{"name":"preprocess(file:)","abstract":"Gives a chance for the rule to do some pre-processing on the syntax tree.","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxRule.html#/s:13SwiftLintCore4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxCorrectableRule.html#/s:13SwiftLintCore0A21SyntaxCorrectableRuleP12makeRewriter4fileAA010ViolationsdH0Cy17ConfigurationTypeQzGSgAA0aB4FileC_tF":{"name":"makeRewriter(file:)","abstract":"
Produce a ViolationsSyntaxRewriter
for the given file.
The configuration of a rule’s severity.
","parent_name":"SeverityBasedRuleConfiguration"},"Protocols/SeverityBasedRuleConfiguration.html#/s:13SwiftLintCore30SeverityBasedRuleConfigurationPAAE8severityAA09ViolationD0Ovp":{"name":"severity","abstract":"The severity of a rule.
","parent_name":"SeverityBasedRuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP6ParentQa":{"name":"Parent","abstract":"The type of the rule that’s using this configuration.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP20parameterDescriptionAA0deG0VSgvp":{"name":"parameterDescription","abstract":"A description for this configuration’s parameters. It can be built using the annotated result builder.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP5apply13configurationyyp_tKF":{"name":"apply(configuration:)","abstract":"Apply an untyped configuration to the current value.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationP8validateyyKF":{"name":"validate()","abstract":"Run a sanity check on the configuration, perform optional postprocessing steps and/or warn about potential","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:13SwiftLintCore17RuleConfigurationPAAE13supportedKeysShySSGvp":{"name":"supportedKeys","abstract":"
All keys supported by this configuration.
","parent_name":"RuleConfiguration"},"Protocols/AnalyzerRule.html#/s:13SwiftLintCore4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"AnalyzerRule"},"Protocols/SubstitutionCorrectableRule.html#/s:13SwiftLintCore27SubstitutionCorrectableRuleP15violationRanges2inSaySo8_NSRangeVGAA0aB4FileC_tF":{"name":"violationRanges(in:)","abstract":"Returns the NSString-based NSRange
s to be replaced in the specified file.
Returns the substitution to apply for the given range.
","parent_name":"SubstitutionCorrectableRule"},"Protocols/SubstitutionCorrectableRule.html#/s:13SwiftLintCore15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","parent_name":"SubstitutionCorrectableRule"},"Protocols/CorrectableRule.html#/s:13SwiftLintCore15CorrectableRuleP7correct4file17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_SaySSGtF":{"name":"correct(file:compilerArguments:)","abstract":"Attempts to correct the violations to this rule in the specified file.
","parent_name":"CorrectableRule"},"Protocols/CorrectableRule.html#/s:13SwiftLintCore15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","abstract":"Attempts to correct the violations to this rule in the specified file.
","parent_name":"CorrectableRule"},"Protocols/CorrectableRule.html#/s:13SwiftLintCore15CorrectableRuleP7correct4file5using17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_AA0E7StorageCSaySSGtF":{"name":"correct(file:using:compilerArguments:)","abstract":"Attempts to correct the violations to this rule in the specified file after collecting file info for all files","parent_name":"CorrectableRule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP17ConfigurationTypeQa":{"name":"ConfigurationType","abstract":"
The type of the configuration used to configure this rule.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP11descriptionAA0D11DescriptionVvpZ":{"name":"description","abstract":"A verbose description of many of this rule’s properties.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP13configuration17ConfigurationTypeQzvp":{"name":"configuration","abstract":"This rule’s configuration.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP06shouldB10EmptyFilesSbvp":{"name":"shouldLintEmptyFiles","abstract":"Whether this rule should be used on empty files. Defaults to false
.
A default initializer for rules. All rules need to be trivially initializable.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP13configurationxyp_tKcfc":{"name":"init(configuration:)","abstract":"Creates a rule by applying its configuration.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP30createConfigurationDescription16exclusiveOptionsAA0dfG0VShySSG_tF":{"name":"createConfigurationDescription(exclusiveOptions:)","abstract":"Create a description of how this rule has been configured to run.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP8validate4file17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_SaySSGtF":{"name":"validate(file:compilerArguments:)","abstract":"Executes the rule on a file and returns any violations to the rule’s expectations.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","abstract":"Executes the rule on a file and returns any violations to the rule’s expectations.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP9isEqualToySbAaB_pF":{"name":"isEqualTo(_:)","abstract":"Whether or not the specified rule is equivalent to the current rule.
","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP11collectInfo3for4into17compilerArgumentsyAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"collectInfo(for:into:compilerArguments:)","abstract":"Collects information for the specified file in a storage object, to be analyzed by a CollectedLinter
.
Executes the rule on a file after collecting file info for all files and returns any violations to the rule’s","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP13canBeDisabled9violation2bySbAA14StyleViolationV_AA0D10IdentifierOtF":{"name":"canBeDisabled(violation:by:)","abstract":"
Checks if a style violation can be disabled by a command specifying a rule ID. Only the rule can claim that for","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RuleP9isEnabled2in3forSbAA6RegionV_SStF":{"name":"isEnabled(in:for:)","abstract":"
Checks if a the rule is enabled in a given region. A specific rule ID can be provided in case a rule supports","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RulePAAE16cacheDescriptionSSvp":{"name":"cacheDescription","abstract":"
The cache description which will be used to determine if a previous","parent_name":"Rule"},"Protocols/Rule.html#/s:13SwiftLintCore4RulePAAE10identifierSSvpZ":{"name":"identifier","abstract":"
The rule’s unique identifier which is the same as Rule.description.identifier
.
The kind of information to collect for each file being linted for this rule.
","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore14CollectingRuleP11collectInfo3for17compilerArguments04FileG0QzAA0abK0C_SaySSGtF":{"name":"collectInfo(for:compilerArguments:)","abstract":"Collects information for the specified file, to be analyzed by a CollectedLinter
.
Collects information for the specified file, to be analyzed by a CollectedLinter
.
Executes the rule on a file after collecting file info for all files and returns any violations to the rule’s","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore14CollectingRuleP8validate4file13collectedInfoSayAA14StyleViolationVGAA0aB4FileC_SDyAK0lI0QzGtF":{"name":"validate(file:collectedInfo:)","abstract":"
Executes the rule on a file after collecting file info for all files and returns any violations to the rule’s","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore4RuleP11collectInfo3for4into17compilerArgumentsyAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"collectInfo(for:into:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore4RuleP8validate4file5using17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"validate(file:using:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:13SwiftLintCore4RuleP8validate4file17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_SaySSGtF":{"name":"validate(file:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CacheDescriptionProvider.html#/s:13SwiftLintCore24CacheDescriptionProviderP05cacheE0SSvp":{"name":"cacheDescription","abstract":"
The cache description which will be used to determine if a previous","parent_name":"CacheDescriptionProvider"},"Protocols/ASTRule.html#/s:13SwiftLintCore7ASTRuleP8KindTypeQa":{"name":"KindType","abstract":"
The kind of token being recursed over.
","parent_name":"ASTRule"},"Protocols/ASTRule.html#/s:13SwiftLintCore7ASTRuleP8validate4file4kind10dictionarySayAA14StyleViolationVGAA0aB4FileC_8KindTypeQzAA22SourceKittenDictionaryVtF":{"name":"validate(file:kind:dictionary:)","abstract":"Executes the rule on a file and a subset of its AST structure, returning any violations to the rule’s","parent_name":"ASTRule"},"Protocols/ASTRule.html#/s:13SwiftLintCore7ASTRuleP4kind4from8KindTypeQzSgAA22SourceKittenDictionaryV_tF":{"name":"kind(from:)","abstract":"
Get the kind
from the specified dictionary.
Executes the rule on a file and a subset of its AST structure, returning any violations to the rule’s","parent_name":"ASTRule"},"Protocols/VersionComparable.html#/s:13SwiftLintCore17VersionComparableP8rawValueSSvp":{"name":"rawValue","abstract":"
The version string.
","parent_name":"VersionComparable"},"Protocols/VersionComparable.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"VersionComparable"},"Protocols/VersionComparable.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"VersionComparable"},"Protocols/AcceptableByConfigurationElement.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","abstract":"Initializer taking a value from a configuration to create an element of Self
.
Make the object an option.
","parent_name":"AcceptableByConfigurationElement"},"Protocols/AcceptableByConfigurationElement.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP13asDescription4withAA04RulefI0VSS_tF":{"name":"asDescription(with:)","abstract":"Make the object a description.
","parent_name":"AcceptableByConfigurationElement"},"Protocols/AcceptableByConfigurationElement.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP5apply_6ruleIDyyp_SStKF":{"name":"apply(_:ruleID:)","abstract":"Update the object.
","parent_name":"AcceptableByConfigurationElement"},"Protocols/Documentable.html#/s:13SwiftLintCore12DocumentableP8markdownSSyF":{"name":"markdown()","abstract":"Convert an object to Markdown.
","parent_name":"Documentable"},"Protocols/Documentable.html#/s:13SwiftLintCore12DocumentableP8oneLinerSSyF":{"name":"oneLiner()","abstract":"Convert an object to a single line string.
","parent_name":"Documentable"},"Protocols/Documentable.html#/s:13SwiftLintCore12DocumentableP10hasContentSbvp":{"name":"hasContent","abstract":"Indicate if the item has some content that is useful to document.
","parent_name":"Documentable"},"Protocols/Documentable.html#/s:13SwiftLintCore12DocumentableP4yamlSSyF":{"name":"yaml()","abstract":"Convert an object to YAML as used in .swiftlint.yml
.
A type that can be converted into a human-readable representation.
"},"Protocols/AcceptableByConfigurationElement.html":{"name":"AcceptableByConfigurationElement","abstract":"Type of an object that can be used as a configuration element.
"},"Protocols.html#/s:13SwiftLintCore19InlinableOptionTypeP":{"name":"InlinableOptionType","abstract":"An option type that can appear inlined into its using configuration.
"},"Protocols/VersionComparable.html":{"name":"VersionComparable","abstract":"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"},"Protocols/CacheDescriptionProvider.html":{"name":"CacheDescriptionProvider","abstract":"
Interface providing access to a cache description.
"},"Protocols.html#/s:13SwiftLintCore17AnyCollectingRuleP":{"name":"AnyCollectingRule","abstract":"Type-erased protocol used to check whether a rule is collectable.
"},"Protocols/CollectingRule.html":{"name":"CollectingRule","abstract":"A rule that requires knowledge of all other files being linted.
"},"Protocols/Rule.html":{"name":"Rule","abstract":"An executable value that can identify issues (violations) in Swift source code.
"},"Protocols.html#/s:13SwiftLintCore9OptInRuleP":{"name":"OptInRule","abstract":"A rule that is not enabled by default. Rules conforming to this need to be explicitly enabled by users.
"},"Protocols/CorrectableRule.html":{"name":"CorrectableRule","abstract":"A rule that can correct violations.
"},"Protocols/SubstitutionCorrectableRule.html":{"name":"SubstitutionCorrectableRule","abstract":"A correctable rule that can apply its corrections by replacing the content of ranges in the offending file with"},"Protocols.html#/s:13SwiftLintCore17SourceKitFreeRuleP":{"name":"SourceKitFreeRule","abstract":"
A rule that does not need SourceKit to operate and can still operate even after SourceKit has crashed.
"},"Protocols/AnalyzerRule.html":{"name":"AnalyzerRule","abstract":"A rule that can operate on the post-typechecked AST using compiler arguments. Performs rules that are more like"},"Protocols/RuleConfiguration.html":{"name":"RuleConfiguration","abstract":"
A configuration value for a rule to allow users to modify its behavior.
"},"Protocols/SeverityBasedRuleConfiguration.html":{"name":"SeverityBasedRuleConfiguration","abstract":"A configuration for a rule that allows to configure at least the severity.
"},"Protocols/SwiftSyntaxCorrectableRule.html":{"name":"SwiftSyntaxCorrectableRule","abstract":"A SwiftLint CorrectableRule that performs its corrections using a SwiftSyntax SyntaxRewriter
.
A SwiftLint Rule backed by SwiftSyntax that does not use SourceKit requests.
"},"Extensions/Double.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Double"},"Extensions/Double.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Double"},"Extensions/Int.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Int"},"Extensions/Int.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Int"},"Extensions/Set.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Set"},"Extensions/Set.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Set"},"Extensions/String.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"String"},"Extensions/String.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"String"},"Extensions/Bool.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Bool"},"Extensions/Bool.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Bool"},"Extensions/Optional.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Optional"},"Extensions/Optional.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Optional"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE26skipWrappingInCommentTestsSayACGyF":{"name":"skipWrappingInCommentTests()","abstract":"Make these examples skip wrapping in comment tests.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE25skipWrappingInStringTestsSayACGyF":{"name":"skipWrappingInStringTests()","abstract":"Make these examples skip wrapping in string tests.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE24skipMultiByteOffsetTestsSayACGyF":{"name":"skipMultiByteOffsetTests()","abstract":"Make these examples skip multi-byte offset tests.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE23skipDisableCommandTestsSayACGyF":{"name":"skipDisableCommandTests()","abstract":"Make these examples skip disable command tests.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA7ExampleVRszlE23removingViolationMarkerSayACGyF":{"name":"removingViolationMarker()","abstract":"Remove all violation markers from the examples.
","parent_name":"Array"},"Extensions/Array.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP8asOptionAA0I4TypeOyF":{"name":"asOption()","parent_name":"Array"},"Extensions/Array.html#/s:13SwiftLintCore32AcceptableByConfigurationElementP7fromAny7contextxyp_SStKcfc":{"name":"init(fromAny:context:)","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA0aB11SyntaxTokenVRszlE5kindsSay21SourceKittenFramework0D4KindOGvp":{"name":"kinds","abstract":"The kinds for these tokens.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA21ReasonedRuleViolationVRszlE6appendyy0A6Syntax16AbsolutePositionVF":{"name":"append(_:)","abstract":"Add a violation at the specified position using the default description and severity.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA21ReasonedRuleViolationVRszlE6append2at10correctiony0A6Syntax16AbsolutePositionV_AC0F10CorrectionVSgtF":{"name":"append(at:correction:)","abstract":"Add a violation and the correction at the specified position using the default description and severity.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCoreAA21ReasonedRuleViolationVRszlE6append10contentsOfySay0A6Syntax16AbsolutePositionVG_tF":{"name":"append(contentsOf:)","abstract":"Add violations for the specified positions using the default description and severity.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCore0A6Syntax04DeclD8Protocol_pXpRszlE3allSayAbC_pXpGvpZ":{"name":"all","abstract":"All visitable declaration syntax types.
","parent_name":"Array"},"Extensions/Array.html#/s:Sa13SwiftLintCore0A6Syntax04DeclD8Protocol_pXpRszlE9allExceptySayAbC_pXpGAbC_pXpd_tFZ":{"name":"allExcept(_:)","abstract":"All declarations except for the specified ones.
","parent_name":"Array"},"Extensions/Array.html":{"name":"Array"},"Extensions/Optional.html":{"name":"Optional"},"Extensions/Bool.html":{"name":"Bool"},"Extensions/String.html":{"name":"String"},"Extensions/Set.html":{"name":"Set"},"Extensions/Int.html":{"name":"Int"},"Extensions/Double.html":{"name":"Double"},"Enums/IdentifierDeclaration.html#/s:13SwiftLintCore21IdentifierDeclarationO9parameteryAC0A6Syntax05TokenG0V_tcACmF":{"name":"parameter(name:)","abstract":"Parameter declaration with a name token.
","parent_name":"IdentifierDeclaration"},"Enums/IdentifierDeclaration.html#/s:13SwiftLintCore21IdentifierDeclarationO13localVariableyAC0A6Syntax05TokenH0V_tcACmF":{"name":"localVariable(name:)","abstract":"Local variable declaration with a name token.
","parent_name":"IdentifierDeclaration"},"Enums/IdentifierDeclaration.html#/s:13SwiftLintCore21IdentifierDeclarationO16implicitVariableyACSS_tcACmF":{"name":"implicitVariable(name:)","abstract":"A variable that is implicitly added by the compiler (e.g. error
in catch
clauses).
A variable hidden from scope because its name is a wildcard _
.
Special case that marks a type boundary at which name lookup stops.
","parent_name":"IdentifierDeclaration"},"Enums/IdentifierDeclaration.html#/s:13SwiftLintCore21IdentifierDeclarationO8declares2id18disregardBackticksSbSS_SbtF":{"name":"declares(id:disregardBackticks:)","abstract":"Check whether self declares a variable given by name.
","parent_name":"IdentifierDeclaration"},"Enums/ViolationSeverity.html#/s:13SwiftLintCore17ViolationSeverityO7warningyA2CmF":{"name":"warning","abstract":"Non-fatal. If using SwiftLint as an Xcode build phase, Xcode will mark the build as having succeeded.
","parent_name":"ViolationSeverity"},"Enums/ViolationSeverity.html#/s:13SwiftLintCore17ViolationSeverityO5erroryA2CmF":{"name":"error","abstract":"Fatal. If using SwiftLint as an Xcode build phase, Xcode will mark the build as having failed.
","parent_name":"ViolationSeverity"},"Enums/ViolationSeverity.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"ViolationSeverity"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO4callyA2CmF":{"name":"call","abstract":"A call to a named function or closure.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO8argumentyA2CmF":{"name":"argument","abstract":"An argument value for a function or closure.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO5arrayyA2CmF":{"name":"array","abstract":"An Array expression.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO10dictionaryyA2CmF":{"name":"dictionary","abstract":"A Dictionary expression.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO13objectLiteralyA2CmF":{"name":"objectLiteral","abstract":"An object literal expression. https://developer.apple.com/swift/blog/?id=33
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO7closureyA2CmF":{"name":"closure","abstract":"A closure expression. https://docs.swift.org/swift-book/LanguageGuide/Closures.html
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:13SwiftLintCore0A14ExpressionKindO5tupleyA2CmF":{"name":"tuple","abstract":"A tuple expression. https://docs.swift.org/swift-book/ReferenceManual/Types.html#ID448
","parent_name":"SwiftExpressionKind"},"Enums/RuleListError.html#/s:13SwiftLintCore13RuleListErrorO24duplicatedConfigurationsyAcA0D0_pXp_tcACmF":{"name":"duplicatedConfigurations(rule:)","abstract":"The rule list contains more than one configuration for the specified rule.
","parent_name":"RuleListError"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO4lintyA2CmF":{"name":"lint","abstract":"Describes rules that validate Swift source conventions.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO9idiomaticyA2CmF":{"name":"idiomatic","abstract":"Describes rules that validate common practices in the Swift community.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO5styleyA2CmF":{"name":"style","abstract":"Describes rules that validate stylistic choices.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO7metricsyA2CmF":{"name":"metrics","abstract":"Describes rules that validate magnitudes or measurements of Swift source.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:13SwiftLintCore8RuleKindO11performanceyA2CmF":{"name":"performance","abstract":"Describes rules that validate that code patterns with poor performance are avoided.
","parent_name":"RuleKind"},"Enums/RuleIdentifier.html#/s:13SwiftLintCore14RuleIdentifierO3allyA2CmF":{"name":"all","abstract":"Special identifier that should be treated as referring to ‘all’ SwiftLint rules. One helpful usecase is in","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:13SwiftLintCore14RuleIdentifierO6singleyACSS_tcACmF":{"name":"single(identifier:)","abstract":"
Represents a single SwiftLint rule with the specified identifier.
","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:13SwiftLintCore14RuleIdentifierO20stringRepresentationSSvp":{"name":"stringRepresentation","abstract":"The spelling of the string for this identifier.
","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:13SwiftLintCore14RuleIdentifierOyACSScfc":{"name":"init(_:)","abstract":"Creates a RuleIdentifier
by its string representation.
An irrelevant option. It will be ignored in documentation serialization.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO4flagyACSbcACmF":{"name":"flag(_:)","abstract":"A boolean flag.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO6stringyACSScACmF":{"name":"string(_:)","abstract":"A string option.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO6symbolyACSScACmF":{"name":"symbol(_:)","abstract":"Like a string option but without quotes in the serialized output.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO7integeryACSicACmF":{"name":"integer(_:)","abstract":"An integer option.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO5floatyACSdcACmF":{"name":"float(_:)","abstract":"A floating point number option.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO8severityyAcA17ViolationSeverityOcACmF":{"name":"severity(_:)","abstract":"Special option for a ViolationSeverity
.
A list of options.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO6nestedyAcA28RuleConfigurationDescriptionVcACmF":{"name":"nested(_:)","abstract":"An option which is another set of configuration options to be nested in the serialized output.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore12DocumentableP10hasContentSbvp":{"name":"hasContent","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore12DocumentableP8markdownSSyF":{"name":"markdown()","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore12DocumentableP8oneLinerSSyF":{"name":"oneLiner()","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore12DocumentableP4yamlSSyF":{"name":"yaml()","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO2egoiyAA017RuleConfigurationD0VSS_ACtFZ":{"name":"=>(_:_:)","abstract":"Operator enabling an easy way to create a configuration option.
","parent_name":"OptionType"},"Enums/OptionType.html#/s:13SwiftLintCore10OptionTypeO4nestyAcA28RuleConfigurationDescriptionVyXEFZ":{"name":"nest(_:)","abstract":"Create an option defined by nested configuration description.
","parent_name":"OptionType"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO20invalidConfigurationyACSS_SSSgtcACmF":{"name":"invalidConfiguration(ruleID:message:)","abstract":"The configuration didn’t match internal expectations.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO29deprecatedConfigurationOptionyACSS_S2SSgtcACmF":{"name":"deprecatedConfigurationOption(ruleID:key:alternative:)","abstract":"Issued when an option is deprecated. Suggests an alternative optionally.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO14nothingAppliedyACSS_tcACmF":{"name":"nothingApplied(ruleID:)","abstract":"Used in configuration parsing when no changes have been applied. Use only internally!
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO18listedMultipleTimeyACSS_SitcACmF":{"name":"listedMultipleTime(ruleID:times:)","abstract":"Rule is listed multiple times in the configuration.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO17renamedIdentifieryACSS_SStcACmF":{"name":"renamedIdentifier(old:new:)","abstract":"An identifier old
has been renamed to new
.
Some configuration keys are invalid.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO25inconsistentConfigurationyACSS_SStcACmF":{"name":"inconsistentConfiguration(ruleID:message:)","abstract":"The configuration is inconsistent, that is options are mutually exclusive or one drives other values","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO14invalidRuleIDsyACShySSGcACmF":{"name":"invalidRuleIDs(_:)","abstract":"
Used rule IDs are invalid.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO25ruleNotPresentInOnlyRulesyACSS_tcACmF":{"name":"ruleNotPresentInOnlyRules(ruleID:)","abstract":"Found a rule configuration for a rule that is not present in only_rules
.
Found a rule configuration for a rule that is disabled.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO33ruleDisabledInParentConfigurationyACSS_tcACmF":{"name":"ruleDisabledInParentConfiguration(ruleID:)","abstract":"Found a rule configuration for a rule that is disabled in the parent configuration.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO019ruleNotEnabledInOptH5RulesyACSS_tcACmF":{"name":"ruleNotEnabledInOptInRules(ruleID:)","abstract":"Found a rule configuration for a rule that is not enabled in opt_in_rules
.
Found a rule configuration for a rule that is not enabled in parent only_rules
.
A generic warning specified by a string.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO12genericErroryACSScACmF":{"name":"genericError(_:)","abstract":"A generic error specified by a string.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO14ruleDeprecatedyACSS_tcACmF":{"name":"ruleDeprecated(ruleID:)","abstract":"A deprecation warning for a rule.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO19initialFileNotFoundyACSS_tcACmF":{"name":"initialFileNotFound(path:)","abstract":"The initial configuration file was not found.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO12fileNotFoundyACSS_tcACmF":{"name":"fileNotFound(path:)","abstract":"A file at specified path was not found.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO15fileNotReadableyACSSSg_SStcACmF":{"name":"fileNotReadable(path:ruleID:)","abstract":"The file at path
is not readable or cannot be opened.
The file at path
is not writable.
The file at path
cannot be indexed by a specific rule.
No arguments were provided to compile a file at path
within a specific rule.
Cursor information cannot be extracted from a specific location.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO11yamlParsingyACSScACmF":{"name":"yamlParsing(_:)","abstract":"An error that occurred when parsing YAML.
","parent_name":"Issue"},"Enums/Issue.html#/s:13SwiftLintCore5IssueO19baselineNotReadableyACSS_tcACmF":{"name":"baselineNotReadable(path:)","abstract":"The baseline file at path
is not readable or cannot be opened.
Print the issue to the console.
","parent_name":"Issue"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO7privateyA2CmF":{"name":"private","abstract":"Accessible by the declaration’s immediate lexical scope.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO11fileprivateyA2CmF":{"name":"fileprivate","abstract":"Accessible by the declaration’s same file.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO8internalyA2CmF":{"name":"internal","abstract":"Accessible by the declaration’s same module, or modules importing it with the @testable
attribute.
Accessible by all the modules defined in the same Swift package.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO6publicyA2CmF":{"name":"public","abstract":"Accessible by the declaration’s same program.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO4openyA2CmF":{"name":"open","abstract":"Accessible and customizable (via subclassing or overrides) by the declaration’s same program.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO11descriptionACSgSS_tcfc":{"name":"init(description:)","abstract":"Initializes an access control level by its Swift source keyword value.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:13SwiftLintCore18AccessControlLevelO9isPrivateSbvp":{"name":"isPrivate","abstract":"Returns true if is private
or fileprivate
The accessibility of a Swift source declaration.
"},"Enums/Issue.html":{"name":"Issue","abstract":"All possible SwiftLint issues which are printed as warnings by default.
"},"Enums/OptionType.html":{"name":"OptionType","abstract":"Type of an option.
"},"Enums/RuleIdentifier.html":{"name":"RuleIdentifier","abstract":"An identifier representing a SwiftLint rule, or all rules.
"},"Enums/RuleKind.html":{"name":"RuleKind","abstract":"All the possible rule kinds (categories).
"},"Enums/RuleListError.html":{"name":"RuleListError","abstract":"All possible rule list configuration errors.
"},"Enums/SwiftExpressionKind.html":{"name":"SwiftExpressionKind","abstract":"The kind of expression for a contiguous set of Swift source tokens.
"},"Enums/ViolationSeverity.html":{"name":"ViolationSeverity","abstract":"The magnitude of a StyleViolation
.
An identifier declaration.
"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC13configurationxvp":{"name":"configuration","abstract":"A rule’s configuration.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC4fileAA0aB4FileCvp":{"name":"file","abstract":"The file from which the traversed syntax tree stems from.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC17locationConverter0aE0014SourceLocationH0Cvp":{"name":"locationConverter","abstract":"A source location converter associated with the syntax tree being traversed.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC13configuration4fileACyxGx_AA0aB4FileCtcfc":{"name":"init(configuration:file:)","abstract":"Initializer for a ViolationsSyntaxVisitor
.
Positions in a source file where violations should be reported.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC21skippableDeclarationsSay0aE004DeclE8Protocol_pXpGvp":{"name":"skippableDeclarations","abstract":"List of declaration types that shall be skipped while traversing the AST.
","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE09ActorDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE09ClassDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE08EnumDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE013ExtensionDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE012FunctionDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE015InitializerDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE012ProtocolDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE010StructDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE013SubscriptDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:13SwiftLintCore23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE012VariableDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC5Scopea":{"name":"Scope","abstract":"A type that remembers the declared identifiers (in order) up to the current position in the code.
","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC5scopeAA5StackVySayAA21IdentifierDeclarationOGGvp":{"name":"scope","abstract":"The hierarchical stack of identifiers declared up to the current position in the code.
","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC13configuration4file5scopeACyxGx_AA0aB4FileCAA5StackVySayAA21IdentifierDeclarationOGGtcfc":{"name":"init(configuration:file:scope:)","abstract":"Initializer.
","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC18hasSeenDeclaration3forSbSS_tF":{"name":"hasSeenDeclaration(for:)","abstract":"Indicate whether a given identifier is in scope.
","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC5visity0A6Syntax0iG12ContinueKindOAE017CodeBlockItemListI0VF":{"name":"visit(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC9visitPostyy0A6Syntax017CodeBlockItemListJ0VF":{"name":"visitPost(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC9visitPostyy0A6Syntax012VariableDeclJ0VF":{"name":"visitPost(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC9visitPostyy0A6Syntax09GuardStmtJ0VF":{"name":"visitPost(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC5visity0A6Syntax0iG12ContinueKindOAE011MemberBlockI0VF":{"name":"visit(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/DeclaredIdentifiersTrackingVisitor.html#/s:13SwiftLintCore34DeclaredIdentifiersTrackingVisitorC9visitPostyy0A6Syntax011MemberBlockJ0VF":{"name":"visitPost(_:)","parent_name":"DeclaredIdentifiersTrackingVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC13configuration4fileACyxGx_AA0aB4FileCtcfc":{"name":"init(configuration:file:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax012AccessorDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09ActorDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax011CatchClauseI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09ClassDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax011ClosureExprI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09DeferStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax06DoStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax08EnumDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax013ExtensionDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax012FunctionDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax07ForStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09GuardStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax06IfExprI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax015InitializerDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax014PatternBindingI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax019PrecedenceGroupDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax012ProtocolDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax010RepeatStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax010StructDeclI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax010SwitchExprI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC9visitPostyy0A6Syntax09WhileStmtI0VF":{"name":"visitPost(_:)","parent_name":"CodeBlockVisitor"},"Classes/CodeBlockVisitor.html#/s:13SwiftLintCore16CodeBlockVisitorC17collectViolations3foryqd__Sg_t0A6Syntax06BracedJ0Rd__lF":{"name":"collectViolations(for:)","abstract":"Collects violations for the given braced item. Intended to be specialized by subclasses.
","parent_name":"CodeBlockVisitor"},"Classes/BodyLengthRuleVisitor/Kind.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC4KindO7closureyAEyx_GAGmAA0F0RzlF":{"name":"closure","abstract":"Closure code blocks.
","parent_name":"Kind"},"Classes/BodyLengthRuleVisitor/Kind.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC4KindO8functionyAEyx_GAGmAA0F0RzlF":{"name":"function","abstract":"Function body blocks.
","parent_name":"Kind"},"Classes/BodyLengthRuleVisitor/Kind.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC4KindO4typeyAEyx_GAGmAA0F0RzlF":{"name":"type","abstract":"Type (class, enum, …) member blocks.
","parent_name":"Kind"},"Classes/BodyLengthRuleVisitor/Kind.html":{"name":"Kind","abstract":"The code block types to check.
","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC4kind4file13configurationACyxGAC4KindOyx_G_AA0aB4FileCAA27SeverityLevelsConfigurationVyxGtcfc":{"name":"init(kind:file:configuration:)","abstract":"Initializer.
","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax08EnumDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax09ClassDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax010StructDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax09ActorDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax011ClosureExprJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax012FunctionDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/BodyLengthRuleVisitor.html#/s:13SwiftLintCore21BodyLengthRuleVisitorC9visitPostyy0A6Syntax015InitializerDeclJ0VF":{"name":"visitPost(_:)","parent_name":"BodyLengthRuleVisitor"},"Classes/CodeIndentingRewriter/IndentationStyle.html#/s:13SwiftLintCore21CodeIndentingRewriterC16IndentationStyleO12indentSpacesyAESicAEmF":{"name":"indentSpaces(_:)","abstract":"Indentation with a number of spaces.
","parent_name":"IndentationStyle"},"Classes/CodeIndentingRewriter/IndentationStyle.html#/s:13SwiftLintCore21CodeIndentingRewriterC16IndentationStyleO14unindentSpacesyAESicAEmF":{"name":"unindentSpaces(_:)","abstract":"Reverse indentation of a number of spaces.
","parent_name":"IndentationStyle"},"Classes/CodeIndentingRewriter/IndentationStyle.html#/s:13SwiftLintCore21CodeIndentingRewriterC16IndentationStyleO10indentTabsyAESicAEmF":{"name":"indentTabs(_:)","abstract":"Indentation with a number of tabs
","parent_name":"IndentationStyle"},"Classes/CodeIndentingRewriter/IndentationStyle.html#/s:13SwiftLintCore21CodeIndentingRewriterC16IndentationStyleO12unindentTabsyAESicAEmF":{"name":"unindentTabs(_:)","abstract":"Reverse indentation of a number of tabs.
","parent_name":"IndentationStyle"},"Classes/CodeIndentingRewriter/IndentationStyle.html":{"name":"IndentationStyle","abstract":"Style defining whether the rewriter shall indent or unindent and whether it shall use tabs or spaces and","parent_name":"CodeIndentingRewriter"},"Classes/CodeIndentingRewriter.html#/s:13SwiftLintCore21CodeIndentingRewriterC5styleA2C16IndentationStyleO_tcfc":{"name":"init(style:)","abstract":"
Initializer accepting an indentation style.
","parent_name":"CodeIndentingRewriter"},"Classes/CodeIndentingRewriter.html#/s:13SwiftLintCore21CodeIndentingRewriterC5visity0A6Syntax05TokenH0VAGF":{"name":"visit(_:)","parent_name":"CodeIndentingRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC13configurationxvp":{"name":"configuration","abstract":"A rule’s configuration.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC4fileAA0aB4FileCvp":{"name":"file","abstract":"The file from which the traversed syntax tree stems from.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC17locationConverter0aE0014SourceLocationH0Cvp":{"name":"locationConverter","abstract":"A converter of positions in the traversed source file.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC15disabledRegionsSay0aE011SourceRangeVGvp":{"name":"disabledRegions","abstract":"The regions in the traversed file that are disabled by a command.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC19correctionPositionsSay0aE016AbsolutePositionVGvp":{"name":"correctionPositions","abstract":"Positions in a source file where corrections were applied.
","parent_name":"ViolationsSyntaxRewriter"},"Classes/ViolationsSyntaxRewriter.html#/s:13SwiftLintCore24ViolationsSyntaxRewriterC13configuration4fileACyxGx_AA0aB4FileCtcfc":{"name":"init(configuration:file:)","abstract":"Initializer for a ViolationsSyntaxRewriter
.
The underlying SourceKitten file.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC2id10Foundation4UUIDVvp":{"name":"id","abstract":"The associated unique identifier for this file.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC06isTestD0Sbvp":{"name":"isTestFile","abstract":"Whether or not this is a file generated for testing purposes.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC9isVirtualSbvp":{"name":"isVirtual","abstract":"A file is virtual if it is not backed by a filesystem path.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC4file06isTestD00F7VirtualAC21SourceKittenFramework0D0C_S2btcfc":{"name":"init(file:isTestFile:isVirtual:)","abstract":"Creates a SwiftLintFile
with a SourceKitten File
.
Creates a SwiftLintFile
by specifying its path on disk.","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC20pathDeferringReadingACSS_tcfc":{"name":"init(pathDeferringReading:)","abstract":"
Creates a SwiftLintFile
by specifying its path on disk. Unlike the SwiftLintFile(path:)
initializer, this","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC8contents06isTestD0ACSS_Sbtcfc":{"name":"init(contents:isTestFile:)","abstract":"
Creates a SwiftLintFile
that is not backed by a file on disk by specifying its contents.
The path on disk for this file.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC8contentsSSvp":{"name":"contents","abstract":"The file’s contents.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC10stringView21SourceKittenFramework06StringF0Vvp":{"name":"stringView","abstract":"A string view into the contents of this file optimized for string manipulation operations.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:13SwiftLintCore0aB4FileC5linesSay21SourceKittenFramework4LineVGvp":{"name":"lines","abstract":"The parsed lines for this file’s contents.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"SwiftLintFile"},"Classes/RuleStorage.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RuleStorage"},"Classes/RuleStorage.html#/s:13SwiftLintCore11RuleStorageCACycfc":{"name":"init()","abstract":"Creates a RuleStorage
with no initial stored data.
Shared rule registry instance.
","parent_name":"RuleRegistry"},"Classes/RuleRegistry.html#/s:13SwiftLintCore12RuleRegistryC4listAA0D4ListVvp":{"name":"list","abstract":"Rule list associated with this registry. Lazily created, and","parent_name":"RuleRegistry"},"Classes/RuleRegistry.html#/s:13SwiftLintCore12RuleRegistryC8register5rulesySayAA0D0_pXpG_tF":{"name":"register(rules:)","abstract":"
Register rules.
","parent_name":"RuleRegistry"},"Classes/RuleRegistry.html#/s:13SwiftLintCore12RuleRegistryC4rule5forIDAA0D0_pXpSgSS_tF":{"name":"rule(forID:)","abstract":"Look up a rule for a given ID.
","parent_name":"RuleRegistry"},"Classes/RuleRegistry.html":{"name":"RuleRegistry","abstract":"Container to register and look up SwiftLint rules.
"},"Classes/RuleStorage.html":{"name":"RuleStorage","abstract":"A storage mechanism for aggregating the results of CollectingRule
s.
A unit of Swift source code, either on disk or in memory.
"},"Classes/ViolationsSyntaxRewriter.html":{"name":"ViolationsSyntaxRewriter","abstract":"A SwiftSyntax SyntaxRewriter
that produces absolute positions where corrections were applied.
Rewriter that indents or unindents a syntax piece including comments and nested"},"Classes/BodyLengthRuleVisitor.html":{"name":"BodyLengthRuleVisitor","abstract":"
Visitor that collection violations of code block lengths.
"},"Classes/CodeBlockVisitor.html":{"name":"CodeBlockVisitor","abstract":"A visitor that collects style violations for all available code blocks.
"},"Classes/DeclaredIdentifiersTrackingVisitor.html":{"name":"DeclaredIdentifiersTrackingVisitor","abstract":"A specialized ViolationsSyntaxVisitor
that tracks declared identifiers per scope while traversing the AST.
A SwiftSyntax SyntaxVisitor
that produces absolute positions where violations should be reported.
The following guides are available globally.
"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally.
"},"Enums.html":{"name":"Enumerations","abstract":"The following enumerations are available globally.
"},"Extensions.html":{"name":"Extensions","abstract":"The following extensions are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally.
"},"Structs.html":{"name":"Structures","abstract":"The following structures are available globally.
"},"Macros.html":{"name":"Macros","abstract":"The following macros are available globally.
"}} \ No newline at end of file