diff --git a/Classes.html b/Classes.html index 9be755af2..11319b8fa 100644 --- a/Classes.html +++ b/Classes.html @@ -105,6 +105,9 @@
+
+
+ ViolationsSyntaxVisitor
+
+ A SwiftSyntax SyntaxVisitor that produces absolute positions where violations should be reported.
Swift
+open class ViolationsSyntaxVisitor : SyntaxVisitor
+
+ @@ -50,7 +50,7 @@
public protocol ViolationsSyntaxVisitor : SyntaxVisitor
+ open class ViolationsSyntaxVisitor : SyntaxVisitor
A SwiftSyntax SyntaxVisitor that produces absolute positions where violations should be reported.
-
-
- violationPositions
+
+
+ visit(_:)
Positions in a source file where violations should be reported.
- +Swift
-var violationPositions: [AbsolutePosition] { get }
+ override open func visit(_ node: ActorDeclSyntax) -> SyntaxVisitorContinueKind
+
+
+ visit(_:)
+
+ Swift
+override open func visit(_ node: ClassDeclSyntax) -> SyntaxVisitorContinueKind
+
+
+
+
+ visit(_:)
+
+ Swift
+override open func visit(_ node: EnumDeclSyntax) -> SyntaxVisitorContinueKind
+
+
+
+
+ visit(_:)
+
+ Swift
+override open func visit(_ node: ExtensionDeclSyntax) -> SyntaxVisitorContinueKind
+
+
+
+
+ visit(_:)
+
+ Swift
+override open func visit(_ node: FunctionDeclSyntax) -> SyntaxVisitorContinueKind
+
+
+
+
+ visit(_:)
+
+ Swift
+override open func visit(_ node: ProtocolDeclSyntax) -> SyntaxVisitorContinueKind
+
+
+
+
+ visit(_:)
+
+ Swift
+override open func visit(_ node: StructDeclSyntax) -> SyntaxVisitorContinueKind
+
+
-
-
- ViolationsSyntaxVisitor
-
- A SwiftSyntax SyntaxVisitor that produces absolute positions where violations should be reported.
Swift
-public protocol ViolationsSyntaxVisitor : SyntaxVisitor
-
-
-
+
- makeVisitor(file:)
+ makeVisitor(file:)
Produce a ViolationsSyntaxVisitor for the given file.
Produce a ViolationsSyntaxVisitor for the given file.
Swift
-func makeVisitor(file: SwiftLintFile) -> ViolationsSyntaxVisitor?
+ func makeVisitor(file: SwiftLintFile) -> ViolationsSyntaxVisitor?
A ViolationsSyntaxVisitor for the given file.
A ViolationsSyntaxVisitor for the given file.
+
+
+ ViolationsSyntaxVisitor
+
+ A SwiftSyntax SyntaxVisitor that produces absolute positions where violations should be reported.
Swift
+open class ViolationsSyntaxVisitor : SyntaxVisitor
+
+ @@ -50,7 +50,7 @@
public protocol ViolationsSyntaxVisitor : SyntaxVisitor
+ open class ViolationsSyntaxVisitor : SyntaxVisitor
A SwiftSyntax SyntaxVisitor that produces absolute positions where violations should be reported.
-
-
- violationPositions
+
+
+ visit(_:)
Positions in a source file where violations should be reported.
- +Swift
-var violationPositions: [AbsolutePosition] { get }
+ override open func visit(_ node: ActorDeclSyntax) -> SyntaxVisitorContinueKind
+
+
+ visit(_:)
+
+ Swift
+override open func visit(_ node: ClassDeclSyntax) -> SyntaxVisitorContinueKind
+
+
+
+
+ visit(_:)
+
+ Swift
+override open func visit(_ node: EnumDeclSyntax) -> SyntaxVisitorContinueKind
+
+
+
+
+ visit(_:)
+
+ Swift
+override open func visit(_ node: ExtensionDeclSyntax) -> SyntaxVisitorContinueKind
+
+
+
+
+ visit(_:)
+
+ Swift
+override open func visit(_ node: FunctionDeclSyntax) -> SyntaxVisitorContinueKind
+
+
+
+
+ visit(_:)
+
+ Swift
+override open func visit(_ node: ProtocolDeclSyntax) -> SyntaxVisitorContinueKind
+
+
+
+
+ visit(_:)
+
+ Swift
+override open func visit(_ node: StructDeclSyntax) -> SyntaxVisitorContinueKind
+
+
-
-
- ViolationsSyntaxVisitor
-
- A SwiftSyntax SyntaxVisitor that produces absolute positions where violations should be reported.
Swift
-public protocol ViolationsSyntaxVisitor : SyntaxVisitor
-
-
-
+
- makeVisitor(file:)
+ makeVisitor(file:)
Produce a ViolationsSyntaxVisitor for the given file.
Produce a ViolationsSyntaxVisitor for the given file.
Swift
-func makeVisitor(file: SwiftLintFile) -> ViolationsSyntaxVisitor?
+ func makeVisitor(file: SwiftLintFile) -> ViolationsSyntaxVisitor?
A ViolationsSyntaxVisitor for the given file.
A ViolationsSyntaxVisitor for the given file.
Parses the input YAML string as an untyped dictionary.
","parent_name":"YamlParser"},"Structs/Version.html#/s:18SwiftLintFramework7VersionV5valueSSvp":{"name":"value","abstract":"The string value for this version.
","parent_name":"Version"},"Structs/Version.html#/s:18SwiftLintFramework7VersionV7currentACvpZ":{"name":"current","abstract":"The current SwiftLint version.
","parent_name":"Version"},"Structs/SwiftVersion.html#/s:SY8RawValueQa":{"name":"RawValue","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:SY8rawValue03RawB0Qzvp":{"name":"rawValue","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:SY8rawValuexSg03RawB0Qz_tcfc":{"name":"init(rawValue:)","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV4fiveACvpZ":{"name":"five","abstract":"Swift 5.0.x - https://swift.org/download/#swift-50
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV10fiveDotOneACvpZ":{"name":"fiveDotOne","abstract":"Swift 5.1.x - https://swift.org/download/#swift-51
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV10fiveDotTwoACvpZ":{"name":"fiveDotTwo","abstract":"Swift 5.2.x - https://swift.org/download/#swift-52
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV12fiveDotThreeACvpZ":{"name":"fiveDotThree","abstract":"Swift 5.3.x - https://swift.org/download/#swift-53
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV11fiveDotFourACvpZ":{"name":"fiveDotFour","abstract":"Swift 5.4.x - https://swift.org/download/#swift-54
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV11fiveDotFiveACvpZ":{"name":"fiveDotFive","abstract":"Swift 5.5.x - https://swift.org/download/#swift-55
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV10fiveDotSixACvpZ":{"name":"fiveDotSix","abstract":"Swift 5.6.x - https://swift.org/download/#swift-56
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV12fiveDotSevenACvpZ":{"name":"fiveDotSeven","abstract":"Swift 5.7.x - https://swift.org/download/#swift-57
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV7currentACvpZ":{"name":"current","abstract":"The current detected Swift compiler version, based on the currently accessible SourceKit version.
","parent_name":"SwiftVersion"},"Structs/SwiftLintSyntaxToken.html#/s:18SwiftLintFramework0aB11SyntaxTokenV5value012SourceKittenC00dE0Vvp":{"name":"value","abstract":"The raw SyntaxToken obtained by SourceKitten.
The syntax kind associated with is token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:18SwiftLintFramework0aB11SyntaxTokenV5valueAC012SourceKittenC00dE0V_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:18SwiftLintFramework0aB11SyntaxTokenV6offset012SourceKittenC09ByteCountVvp":{"name":"offset","abstract":"The starting byte offset in a source file for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:18SwiftLintFramework0aB11SyntaxTokenV6length012SourceKittenC09ByteCountVvp":{"name":"length","abstract":"The length in bytes for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxMap.html#/s:18SwiftLintFramework0aB9SyntaxMapV5value012SourceKittenC00dE0Vvp":{"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:18SwiftLintFramework0aB9SyntaxMapV5valueAC012SourceKittenC00dE0V_tcfc":{"name":"init(value:)","abstract":"Creates a SwiftLintSyntaxMap from the raw SyntaxMap obtained by SourceKitten.
The identifier of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV15ruleDescriptionSSvp":{"name":"ruleDescription","abstract":"The description of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV8ruleNameSSvp":{"name":"ruleName","abstract":"The name of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV8severityAA0E8SeverityOvp":{"name":"severity","abstract":"The severity of this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV8locationAA8LocationVvp":{"name":"location","abstract":"The location of this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV6reasonSSvp":{"name":"reason","abstract":"The justification for this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV11descriptionSSvp":{"name":"description","abstract":"A printable description for this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV15ruleDescription8severity8location6reasonAcA04RuleG0V_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:18SwiftLintFramework13RuleParameterV5valuexvp":{"name":"value","abstract":"The value to configure the rule.
","parent_name":"RuleParameter"},"Structs/RuleParameter.html#/s:18SwiftLintFramework13RuleParameterV8severity5valueACyxGAA17ViolationSeverityO_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:18SwiftLintFramework8RuleListV5rulesAcA0D0_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:18SwiftLintFramework15RuleDescriptionV4nameSSvp":{"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:18SwiftLintFramework15RuleDescriptionV11descriptionSSvp":{"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:18SwiftLintFramework15RuleDescriptionV4kindAA0D4KindOvp":{"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:18SwiftLintFramework15RuleDescriptionV18triggeringExamplesSayAA7ExampleVGvp":{"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:18SwiftLintFramework15RuleDescriptionV11correctionsSDyAA7ExampleVAFGvp":{"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:18SwiftLintFramework15RuleDescriptionV17deprecatedAliasesShySSGvp":{"name":"deprecatedAliases","abstract":"
Any previous iteration of the rule’s identifier that was previously shipped with SwiftLint.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:18SwiftLintFramework15RuleDescriptionV03minA7VersionAA0aG0Vvp":{"name":"minSwiftVersion","abstract":"The oldest version of the Swift compiler supported by this rule.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:18SwiftLintFramework15RuleDescriptionV18requiresFileOnDiskSbvp":{"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:18SwiftLintFramework15RuleDescriptionV07consoleE0SSvp":{"name":"consoleDescription","abstract":"
The console-printable string for this description.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:18SwiftLintFramework15RuleDescriptionV14allIdentifiersSaySSGvp":{"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:18SwiftLintFramework15RuleDescriptionV10identifier4name11description4kind03minA7Version21nonTriggeringExamples010triggeringN011corrections17deprecatedAliases18requiresFileOnDiskACSS_S2SAA0D4KindOAA0aK0VSayAA7ExampleVGATSDyA2SGShySSGSbtcfc":{"name":"init(identifier:name:description:kind:minSwiftVersion:nonTriggeringExamples:triggeringExamples:corrections:deprecatedAliases:requiresFileOnDisk:)","abstract":"Creates a RuleDescription by specifying all its properties directly.
The location describing the start of the region. All locations that are less than this value","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV3endAA8LocationVvp":{"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:18SwiftLintFramework6RegionV23disabledRuleIdentifiersShyAA0F10IdentifierOGvp":{"name":"disabledRuleIdentifiers","abstract":"
All SwiftLint rule identifiers that are disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV5start3end23disabledRuleIdentifiersAcA8LocationV_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:18SwiftLintFramework6RegionV8containsySbAA8LocationVF":{"name":"contains(_:)","abstract":"Whether the specific location is contained in this region.
","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV13isRuleEnabledySbAA0F0_pF":{"name":"isRuleEnabled(_:)","abstract":"Whether the specified rule is enabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV14isRuleDisabledySbAA0F0_pF":{"name":"isRuleDisabled(_:)","abstract":"Whether the specified rule is disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV26deprecatedAliasesDisabling4ruleShySSGAA4Rule_p_tF":{"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:18SwiftLintFramework8LocationV4fileSSSgvp":{"name":"file","abstract":"
The file path on disk for this location.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV4lineSiSgvp":{"name":"line","abstract":"The line offset in the file for this location. 1-indexed.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV9characterSiSgvp":{"name":"character","abstract":"The character offset in the file for this location. 1-indexed.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV11descriptionSSvp":{"name":"description","abstract":"A lossless printable description of this location.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV12relativeFileSSSgvp":{"name":"relativeFile","abstract":"The file path for this location relative to the current working directory.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV4file4line9characterACSSSg_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:18SwiftLintFramework8LocationV4file8positionAcA0aB4FileC_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:18SwiftLintFramework8LocationV4file15characterOffsetAcA0aB4FileC_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/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV4fileAA0aB4FileCvp":{"name":"file","abstract":"
The file to lint with this linter.
","parent_name":"CollectedLinter"},"Structs/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV15styleViolations5usingSayAA14StyleViolationVGAA11RuleStorageC_tF":{"name":"styleViolations(using:)","abstract":"Computes or retrieves style violations.
","parent_name":"CollectedLinter"},"Structs/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV27styleViolationsAndRuleTimes5usingSayAA14StyleViolationVG_SaySS2id_Sd4timetGtAA0I7StorageC_tF":{"name":"styleViolationsAndRuleTimes(using:)","abstract":"Computes or retrieves style violations and the time spent executing each rule.
","parent_name":"CollectedLinter"},"Structs/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV7correct5usingSayAA10CorrectionVGAA11RuleStorageC_tF":{"name":"correct(using:)","abstract":"Applies corrections for all rules to this file, returning performed corrections.
","parent_name":"CollectedLinter"},"Structs/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV6format7useTabs11indentWidthySb_SitF":{"name":"format(useTabs:indentWidth:)","abstract":"Formats the file associated with this linter.
","parent_name":"CollectedLinter"},"Structs/Linter.html#/s:18SwiftLintFramework6LinterV4fileAA0aB4FileCvp":{"name":"file","abstract":"The file to lint with this linter.
","parent_name":"Linter"},"Structs/Linter.html#/s:18SwiftLintFramework6LinterV12isCollectingSbvp":{"name":"isCollecting","abstract":"Whether or not this linter will be used to collect information from several files.
","parent_name":"Linter"},"Structs/Linter.html#/s:18SwiftLintFramework6LinterV4file13configuration5cache17compilerArgumentsAcA0aB4FileC_AA13ConfigurationVAA0D5CacheCSgSaySSGtcfc":{"name":"init(file:configuration:cache:compilerArguments:)","abstract":"Creates a Linter by specifying its properties directly.
Returns a linter capable of checking for violations after running each rule’s collection step.
","parent_name":"Linter"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV4codeSSvp":{"name":"code","abstract":"The contents of the example
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV13configurationypSgvp":{"name":"configuration","abstract":"The untyped configuration to apply to the rule, if deviating from the default configuration.","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV20testMultiByteOffsetsSbvp":{"name":"testMultiByteOffsets","abstract":"
Whether the example should be tested by prepending multibyte grapheme clusters
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV11testOnLinuxSbvp":{"name":"testOnLinux","abstract":"Whether the example should be tested on Linux
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV4files12StaticStringVvp":{"name":"file","abstract":"The path to the file where the example was created
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV4lineSuvp":{"name":"line","abstract":"The line in the file where the example was created
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV_13configuration20testMultiByteOffsets0F17WrappingInComment0fjK6String0F14DisableCommand0F7OnLinux4file4line24excludeFromDocumentationACSS_ypSgS5bs06StaticM0VSuSbtcfc":{"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:18SwiftLintFramework7ExampleV4with4codeACSS_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: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:18SwiftLintFramework10CorrectionV15ruleDescriptionAA04RuleF0Vvp":{"name":"ruleDescription","abstract":"The description of the rule for which this correction was applied.
","parent_name":"Correction"},"Structs/Correction.html#/s:18SwiftLintFramework10CorrectionV8locationAA8LocationVvp":{"name":"location","abstract":"The location of the original violation that was corrected.
","parent_name":"Correction"},"Structs/Correction.html#/s:18SwiftLintFramework10CorrectionV18consoleDescriptionSSvp":{"name":"consoleDescription","abstract":"The console-printable description for this correction.
","parent_name":"Correction"},"Structs/Command/Modifier.html#/s:18SwiftLintFramework7CommandV8ModifierO8previousyA2EmF":{"name":"previous","abstract":"The command should only apply to the line preceding its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:18SwiftLintFramework7CommandV8ModifierO4thisyA2EmF":{"name":"this","abstract":"The command should only apply to the same line as its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:18SwiftLintFramework7CommandV8ModifierO4nextyA2EmF":{"name":"next","abstract":"The command should only apply to the line following its definition.
","parent_name":"Modifier"},"Structs/Command/Action.html#/s:18SwiftLintFramework7CommandV6ActionO6enableyA2EmF":{"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:18SwiftLintFramework7CommandV6ActionO7disableyA2EmF":{"name":"disable","abstract":"The rule(s) associated with this command should be disabled by the SwiftLint engine.
","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:18SwiftLintFramework7CommandV6action15ruleIdentifiers4line9character8modifier15trailingCommentA2C6ActionO_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:18SwiftLintFramework7CommandV12actionString4line9characterACSgSS_S2itcfc":{"name":"init(actionString:line:character:)","abstract":"Creates a command based on the specified parameters.
","parent_name":"Command"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV5valueSDySS0deC00D16KitRepresentable_pGvp":{"name":"value","abstract":"The underlying SourceKitten dictionary.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV12substructureSayACGvp":{"name":"substructure","abstract":"The cached substructure for this dictionary. Empty if there is no substructure.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV14expressionKindAA0a10ExpressionH0OSgvp":{"name":"expressionKind","abstract":"The kind of Swift expression represented by this dictionary, if it is an expression.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV15declarationKind0deC00a11DeclarationH0OSgvp":{"name":"declarationKind","abstract":"The kind of Swift declaration represented by this dictionary, if it is a declaration.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV13statementKind0deC009StatementH0OSgvp":{"name":"statementKind","abstract":"The kind of Swift statement represented by this dictionary, if it is a statement.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV13accessibilityAA18AccessControlLevelOSgvp":{"name":"accessibility","abstract":"The accessibility level for this dictionary, if it is a declaration.
","parent_name":"SourceKittenDictionary"},"Structs/Configuration/RulesMode.html#/s:18SwiftLintFramework13ConfigurationV9RulesModeO7defaultyAEShySSG_AGtcAEmF":{"name":"default(disabled:optIn:)","abstract":"The default rules mode, which will enable all rules that aren’t defined as being opt-in","parent_name":"RulesMode"},"Structs/Configuration/RulesMode.html#/s:18SwiftLintFramework13ConfigurationV9RulesModeO4onlyyAEShySSGcAEmF":{"name":"only(_:)","abstract":"
Only enable the rules explicitly listed.
","parent_name":"RulesMode"},"Structs/Configuration/RulesMode.html#/s:18SwiftLintFramework13ConfigurationV9RulesModeO10allEnabledyA2EmF":{"name":"allEnabled","abstract":"Enable all available rules.
","parent_name":"RulesMode"},"Structs/Configuration/IndentationStyle.html#/s:18SwiftLintFramework13ConfigurationV16IndentationStyleO4tabsyA2EmF":{"name":"tabs","abstract":"Swift source code should be indented using tabs.
","parent_name":"IndentationStyle"},"Structs/Configuration/IndentationStyle.html#/s:18SwiftLintFramework13ConfigurationV16IndentationStyleO6spacesyAESi_tcAEmF":{"name":"spaces(count:)","abstract":"Swift source code should be indented using spaces with count spaces per indentation level.
The default indentation style if none is explicitly provided.
","parent_name":"IndentationStyle"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV7defaultACvpZ":{"name":"default","abstract":"The default Configuration resulting from an empty configuration file.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV15defaultFileNameSSvpZ":{"name":"defaultFileName","abstract":"The default file name to look for user-defined configurations.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13includedPathsSaySSGvp":{"name":"includedPaths","abstract":"The paths that should be included when linting
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13excludedPathsSaySSGvp":{"name":"excludedPaths","abstract":"The paths that should be excluded when linting
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV11indentationAC16IndentationStyleOvp":{"name":"indentation","abstract":"The style to use when indenting Swift source code.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV16warningThresholdSiSgvp":{"name":"warningThreshold","abstract":"The threshold for the number of warnings to tolerate before treating the lint as having failed.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV8reporterSSvp":{"name":"reporter","abstract":"The identifier for the Reporter to use to report style violations.
The location of the persisted cache to use with this configuration.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV22allowZeroLintableFilesSbvp":{"name":"allowZeroLintableFiles","abstract":"Allow or disallow SwiftLint to exit successfully when passed only ignored or unlintable files.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV013basedOnCustomD5FilesSbvp":{"name":"basedOnCustomConfigurationFiles","abstract":"This value is true iff the --config parameter was used to specify (a) configuration file(s)","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV5rulesSayAA4Rule_pGvp":{"name":"rules","abstract":"
All rules enabled in this configuration
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13rootDirectorySSvp":{"name":"rootDirectory","abstract":"The root directory is the directory that included & excluded paths relate to.","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV9rulesModeAC05RulesF0Ovp":{"name":"rulesMode","abstract":"
The rules mode used for this configuration.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV18configurationFiles14enableAllRules9cachePath27ignoreParentAndChildConfigs20mockedNetworkResults25useDefaultConfigOnFailureACSaySSG_SbSSSgSbSDyS2SGSbSgtcfc":{"name":"init(configurationFiles:enableAllRules:cachePath:ignoreParentAndChildConfigs:mockedNetworkResults:useDefaultConfigOnFailure:)","abstract":"Creates a Configuration with convenience parameters.
Returns a copy of the current Configuration with its computedCacheDescription property set to the value of","parent_name":"Configuration"},"Structs/Configuration/IndentationStyle.html":{"name":"IndentationStyle","abstract":"
The style of indentation used in a Swift project.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13lintableFiles6inPath12forceExclude15excludeByPrefixSayAA0aB4FileCGSS_S2btF":{"name":"lintableFiles(inPath:forceExclude:excludeByPrefix:)","abstract":"Returns the files that can be linted by SwiftLint in the specified parent path.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV19filterExcludedPaths11fileManager2inSaySSGAA012LintableFileI0_p_AGdtF":{"name":"filterExcludedPaths(fileManager:in:)","abstract":"Returns an array of file paths after removing the excluded paths as defined by this configuration.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV27filterExcludedPathsByPrefix2inSaySSGAFd_tF":{"name":"filterExcludedPathsByPrefix(in:)","abstract":"Returns the file paths that are excluded by this configuration using filtering by absolute path prefix.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13configuration3forAcA0aB4FileC_tF":{"name":"configuration(for:)","abstract":"Returns a new configuration that applies to the specified file by merging the current configuration with any","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV4dict8ruleList14enableAllRules9cachePathACSDySSypG_AA04RuleG0VSbSSSgtKcfc":{"name":"init(dict:ruleList:enableAllRules:cachePath:)","abstract":"
Creates a Configuration value based on the specified parameters.
","parent_name":"Configuration"},"Structs/Configuration/RulesMode.html":{"name":"RulesMode","abstract":"Represents how a Configuration object can be configured with regards to rules.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"Configuration"},"Structs/Configuration.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"Configuration"},"Structs/Configuration.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"Configuration"},"Structs/RuleListDocumentation.html#/s:18SwiftLintFramework21RuleListDocumentationVyAcA0dE0Vcfc":{"name":"init(_:)","abstract":"Creates a RuleListDocumentation instance from a RuleList.
","parent_name":"RuleListDocumentation"},"Structs/RuleListDocumentation.html#/s:18SwiftLintFramework21RuleListDocumentationV5write2toy10Foundation3URLV_tKF":{"name":"write(to:)","abstract":"Write the rule list documentation as markdown files to the specified directory.
","parent_name":"RuleListDocumentation"},"Structs/RuleListDocumentation.html":{"name":"RuleListDocumentation","abstract":"User-facing documentation for a SwiftLint RuleList.
"},"Structs/Configuration.html":{"name":"Configuration","abstract":"The configuration struct for SwiftLint. User-defined in the .swiftlint.yml file, drives the behavior of SwiftLint.
A collection of keys and values as parsed out of SourceKit, with many conveniences for accessing SwiftLint-specific"},"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/Linter.html":{"name":"Linter","abstract":"
Represents a file that can be linted for style violations and corrections after being collected.
"},"Structs/CollectedLinter.html":{"name":"CollectedLinter","abstract":"Represents a file that can compute style violations and corrections for a list of rules.
"},"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/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/Version.html":{"name":"Version","abstract":"A type describing the SwiftLint version.
"},"Structs/YamlParser.html":{"name":"YamlParser","abstract":"An interface for parsing YAML.
"},"Structs/CodeClimateReporter.html":{"name":"CodeClimateReporter","abstract":"Reports violations as a JSON array in Code Climate format.
"},"Structs/GitLabJUnitReporter.html":{"name":"GitLabJUnitReporter","abstract":"Reports violations as JUnit XML supported by GitLab.
"},"Structs/SonarQubeReporter.html":{"name":"SonarQubeReporter","abstract":"Reports violations in SonarQube import format.
"},"Structs/XcodeReporter.html":{"name":"XcodeReporter","abstract":"Reports violations in the format Xcode uses to display in the IDE. (default)
"},"Protocols/ViolationsSyntaxVisitor.html#/s:18SwiftLintFramework23ViolationsSyntaxVisitorP18violationPositionsSay0aE016AbsolutePositionVGvp":{"name":"violationPositions","abstract":"Positions in a source file where violations should be reported.
","parent_name":"ViolationsSyntaxVisitor"},"Protocols/SwiftSyntaxRule.html#/s:18SwiftLintFramework0A10SyntaxRuleP11makeVisitor4fileAA010ViolationsdG0_pSgAA0aB4FileC_tF":{"name":"makeVisitor(file:)","abstract":"Produce a ViolationsSyntaxVisitor for the given file.
Produce a violation for the given file and absolute position.
","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxRule.html#/s:18SwiftLintFramework0A10SyntaxRulePAAE15disabledRegions4fileSay0aD011SourceRangeVGAA0aB4FileC_tF":{"name":"disabledRegions(file:)","abstract":"Returns the source ranges in the specified file where this rule is disabled.
","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxRule.html#/s:18SwiftLintFramework4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"SwiftSyntaxRule"},"Protocols/ViolationsSyntaxRewriter.html#/s:18SwiftLintFramework24ViolationsSyntaxRewriterP19correctionPositionsSay0aE016AbsolutePositionVGvp":{"name":"correctionPositions","abstract":"Positions in a source file where corrections were applied.
","parent_name":"ViolationsSyntaxRewriter"},"Protocols/SwiftSyntaxCorrectableRule.html#/s:18SwiftLintFramework0A21SyntaxCorrectableRuleP12makeRewriter4fileAA010ViolationsdH0_pSgAA0aB4FileC_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:18SwiftLintFramework30SeverityBasedRuleConfigurationPAAE8severityAA09ViolationD0Ovp":{"name":"severity","abstract":"The severity of a rule.
","parent_name":"SeverityBasedRuleConfiguration"},"Protocols/RuleConfiguration.html#/s:18SwiftLintFramework17RuleConfigurationP18consoleDescriptionSSvp":{"name":"consoleDescription","abstract":"A human-readable description for this configuration and its applied values.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:18SwiftLintFramework17RuleConfigurationP5apply13configurationyyp_tKF":{"name":"apply(configuration:)","abstract":"Apply an untyped configuration to the current value.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:18SwiftLintFramework17RuleConfigurationP9isEqualToySbAaB_pF":{"name":"isEqualTo(_:)","abstract":"Whether the specified configuration is equivalent to the current value.
","parent_name":"RuleConfiguration"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework25CollectingCorrectableRuleP7correct4file13collectedInfo17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_SDyAL0nJ0QzGSaySSGtF":{"name":"correct(file:collectedInfo:compilerArguments:)","abstract":"Attempts to correct the violations to this rule in the specified file after collecting file info for all files","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework25CollectingCorrectableRuleP7correct4file13collectedInfoSayAA10CorrectionVGAA0aB4FileC_SDyAK0lJ0QzGtF":{"name":"correct(file:collectedInfo:)","abstract":"
Attempts to correct the violations to this rule in the specified file after collecting file info for all files","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4file5using17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_AA0E7StorageCSaySSGtF":{"name":"correct(file:using:compilerArguments:)","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4file17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_SaySSGtF":{"name":"correct(file:compilerArguments:)","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework14CollectingRuleP8FileInfoQa":{"name":"FileInfo","abstract":"
The kind of information to collect for each file being linted for this rule.
","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework14CollectingRuleP11collectInfo3for17compilerArguments04FileG0QzAA0abK0C_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:18SwiftLintFramework14CollectingRuleP8validate4file13collectedInfoSayAA14StyleViolationVGAA0aB4FileC_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:18SwiftLintFramework4RuleP11collectInfo3for4into17compilerArgumentsyAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"collectInfo(for:into:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework4RuleP8validate4file5using17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"validate(file:using:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework4RuleP8validate4file17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_SaySSGtF":{"name":"validate(file:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/AnalyzerRule.html#/s:18SwiftLintFramework4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"AnalyzerRule"},"Protocols/SubstitutionCorrectableASTRule.html#/s:18SwiftLintFramework30SubstitutionCorrectableASTRuleP15violationRanges2in4kind10dictionarySaySo8_NSRangeVGAA0aB4FileC_8KindTypeQzAA22SourceKittenDictionaryVtF":{"name":"violationRanges(in:kind:dictionary:)","abstract":"
Returns the NSString-based NSRanges to be replaced in the specified file.
Returns the NSString-based NSRanges to be replaced in the specified file.
Returns the substitution to apply for the given range.
","parent_name":"SubstitutionCorrectableRule"},"Protocols/SubstitutionCorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","parent_name":"SubstitutionCorrectableRule"},"Protocols/CorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4file17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_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:18SwiftLintFramework15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","abstract":"Attempts to correct the violations to this rule in the specified file.
","parent_name":"CorrectableRule"},"Protocols/CorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4file5using17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_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/ConfigurationProviderRule.html#/s:18SwiftLintFramework25ConfigurationProviderRuleP0D4TypeQa":{"name":"ConfigurationType","abstract":"
The type of configuration used to configure this rule.
","parent_name":"ConfigurationProviderRule"},"Protocols/ConfigurationProviderRule.html#/s:18SwiftLintFramework25ConfigurationProviderRuleP13configuration0D4TypeQzvp":{"name":"configuration","abstract":"This rule’s configuration.
","parent_name":"ConfigurationProviderRule"},"Protocols/ConfigurationProviderRule.html#/s:18SwiftLintFramework4RuleP13configurationxyp_tKcfc":{"name":"init(configuration:)","parent_name":"ConfigurationProviderRule"},"Protocols/ConfigurationProviderRule.html#/s:18SwiftLintFramework4RuleP9isEqualToySbAaB_pF":{"name":"isEqualTo(_:)","parent_name":"ConfigurationProviderRule"},"Protocols/ConfigurationProviderRule.html#/s:18SwiftLintFramework4RuleP24configurationDescriptionSSvp":{"name":"configurationDescription","parent_name":"ConfigurationProviderRule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP11descriptionAA0D11DescriptionVvpZ":{"name":"description","abstract":"A verbose description of many of this rule’s properties.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP24configurationDescriptionSSvp":{"name":"configurationDescription","abstract":"A description of how this rule has been configured to run.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RulePxycfc":{"name":"init()","abstract":"A default initializer for rules. All rules need to be trivially initializable.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP13configurationxyp_tKcfc":{"name":"init(configuration:)","abstract":"Creates a rule by applying its configuration.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP8validate4file17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_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:18SwiftLintFramework4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_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:18SwiftLintFramework4RuleP9isEqualToySbAaB_pF":{"name":"isEqualTo(_:)","abstract":"Whether or not the specified rule is equivalent to the current rule.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP11collectInfo3for4into17compilerArgumentsyAA0aB4FileC_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/Reporter.html#/s:18SwiftLintFramework8ReporterP10identifierSSvpZ":{"name":"identifier","abstract":"
The unique identifier for this reporter.
","parent_name":"Reporter"},"Protocols/Reporter.html#/s:18SwiftLintFramework8ReporterP10isRealtimeSbvpZ":{"name":"isRealtime","abstract":"Whether or not this reporter can output incrementally as violations are found or if all violations must be","parent_name":"Reporter"},"Protocols/Reporter.html#/s:18SwiftLintFramework8ReporterP14generateReportySSSayAA14StyleViolationVGFZ":{"name":"generateReport(_:)","abstract":"
Return a string with the report for the specified violations.
","parent_name":"Reporter"},"Protocols/ASTRule.html#/s:18SwiftLintFramework7ASTRuleP8KindTypeQa":{"name":"KindType","abstract":"The kind of token being recursed over.
","parent_name":"ASTRule"},"Protocols/ASTRule.html#/s:18SwiftLintFramework7ASTRuleP8validate4file4kind10dictionarySayAA14StyleViolationVGAA0aB4FileC_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:18SwiftLintFramework7ASTRuleP4kind4from8KindTypeQzSgAA22SourceKittenDictionaryV_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/LintableFileManager.html#/s:18SwiftLintFramework19LintableFileManagerP07filesToB06inPath13rootDirectorySaySSGSS_SSSgtF":{"name":"filesToLint(inPath:rootDirectory:)","abstract":"
Returns all files that can be linted in the specified path. If the path is relative, it will be appended to the","parent_name":"LintableFileManager"},"Protocols/LintableFileManager.html#/s:18SwiftLintFramework19LintableFileManagerP16modificationDate03forE6AtPath10Foundation0H0VSgSS_tF":{"name":"modificationDate(forFileAtPath:)","abstract":"
Returns the date when the file at the specified path was last modified. Returns nil if the file cannot be","parent_name":"LintableFileManager"},"Protocols/LintableFileManager.html":{"name":"LintableFileManager","abstract":"
An interface for enumerating files that can be linted by SwiftLint.
"},"Protocols/ASTRule.html":{"name":"ASTRule","abstract":"A rule that leverages the Swift source’s pre-typechecked Abstract Syntax Tree to recurse into the source’s"},"Protocols/Reporter.html":{"name":"Reporter","abstract":"
An interface for reporting violations as strings.
"},"Protocols/Rule.html":{"name":"Rule","abstract":"An executable value that can identify issues (violations) in Swift source code.
"},"Protocols.html#/s:18SwiftLintFramework9OptInRuleP":{"name":"OptInRule","abstract":"A rule that is not enabled by default. Rules conforming to this need to be explicitly enabled by users.
"},"Protocols/ConfigurationProviderRule.html":{"name":"ConfigurationProviderRule","abstract":"A rule that is user-configurable.
"},"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/SubstitutionCorrectableASTRule.html":{"name":"SubstitutionCorrectableASTRule","abstract":"
A SubstitutionCorrectableRule that is also an ASTRule.
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.html#/s:18SwiftLintFramework17AnyCollectingRuleP":{"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/CollectingCorrectableRule.html":{"name":"CollectingCorrectableRule","abstract":"A CollectingRule that is also a CorrectableRule.
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 SwiftSyntax SyntaxRewriter that produces absolute positions where corrections were applied.
A SwiftLint Rule backed by SwiftSyntax that does not use SourceKit requests.
"},"Protocols/ViolationsSyntaxVisitor.html":{"name":"ViolationsSyntaxVisitor","abstract":"A SwiftSyntax SyntaxVisitor that produces absolute positions where violations should be reported.
A thread-safe version of Swift’s standard print().
A thread-safe, newline-terminated version of fputs(..., stderr).
A thread-safe, newline-terminated version of fatalError(...) that doesn’t leak"},"Functions.html#/s:18SwiftLintFramework12reporterFrom10identifierAA8Reporter_pXpSS_tF":{"name":"reporterFrom(identifier:)","abstract":"
Returns the reporter with the specified identifier. Traps if the specified identifier doesn’t correspond to any"},"Extensions/String.html#/s:SS18SwiftLintFrameworkE24absolutePathStandardizedSSyF":{"name":"absolutePathStandardized()","abstract":"
Returns a new string, converting the path to a canonical absolute path.
","parent_name":"String"},"Extensions/String.html#/s:SS18SwiftLintFrameworkE16countOccurrences2ofSiSJ_tF":{"name":"countOccurrences(of:)","abstract":"Count the number of occurrences of the given character in self
If self is a path, this method can be used to get a path expression relative to a root directory
","parent_name":"String"},"Extensions/FileManager.html#/s:18SwiftLintFramework19LintableFileManagerP07filesToB06inPath13rootDirectorySaySSGSS_SSSgtF":{"name":"filesToLint(inPath:rootDirectory:)","parent_name":"FileManager"},"Extensions/FileManager.html#/s:18SwiftLintFramework19LintableFileManagerP16modificationDate03forE6AtPath10Foundation0H0VSgSS_tF":{"name":"modificationDate(forFileAtPath:)","parent_name":"FileManager"},"Extensions/FileManager.html":{"name":"FileManager"},"Extensions/String.html":{"name":"String"},"Enums/ViolationSeverity.html#/s:18SwiftLintFramework17ViolationSeverityO7warningyA2CmF":{"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:18SwiftLintFramework17ViolationSeverityO5erroryA2CmF":{"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/RuleListError.html#/s:18SwiftLintFramework13RuleListErrorO24duplicatedConfigurationsyAcA0D0_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:18SwiftLintFramework8RuleKindO4lintyA2CmF":{"name":"lint","abstract":"Describes rules that validate Swift source conventions.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:18SwiftLintFramework8RuleKindO9idiomaticyA2CmF":{"name":"idiomatic","abstract":"Describes rules that validate common practices in the Swift community.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:18SwiftLintFramework8RuleKindO5styleyA2CmF":{"name":"style","abstract":"Describes rules that validate stylistic choices.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:18SwiftLintFramework8RuleKindO7metricsyA2CmF":{"name":"metrics","abstract":"Describes rules that validate magnitudes or measurements of Swift source.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:18SwiftLintFramework8RuleKindO11performanceyA2CmF":{"name":"performance","abstract":"Describes rules that validate that code patterns with poor performance are avoided.
","parent_name":"RuleKind"},"Enums/RuleIdentifier.html#/s:18SwiftLintFramework14RuleIdentifierO3allyA2CmF":{"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:18SwiftLintFramework14RuleIdentifierO6singleyACSS_tcACmF":{"name":"single(identifier:)","abstract":"
Represents a single SwiftLint rule with the specified identifier.
","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:18SwiftLintFramework14RuleIdentifierO20stringRepresentationSSvp":{"name":"stringRepresentation","abstract":"The spelling of the string for this idenfitier.
","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:18SwiftLintFramework14RuleIdentifierOyACSScfc":{"name":"init(_:)","abstract":"Creates a RuleIdentifier by its string representation.
The configuration didn’t match internal expectations.
","parent_name":"ConfigurationError"},"Enums/ConfigurationError.html#/s:18SwiftLintFramework18ConfigurationErrorO28ambiguousMatchKindParametersyA2CmF":{"name":"ambiguousMatchKindParameters","abstract":"The configuration had both match_kind and excluded_match_kind parameters.
A generic configuration error specified by a string.
","parent_name":"ConfigurationError"},"Enums/ConfigurationError.html#/s:18SwiftLintFramework18ConfigurationErrorO19initialFileNotFoundyACSS_tcACmF":{"name":"initialFileNotFound(path:)","abstract":"The initial configuration file was not found.
","parent_name":"ConfigurationError"},"Enums/AccessControlLevel.html#/s:18SwiftLintFramework18AccessControlLevelO7privateyA2CmF":{"name":"private","abstract":"Accessible by the declaration’s immediate lexical scope.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:18SwiftLintFramework18AccessControlLevelO11fileprivateyA2CmF":{"name":"fileprivate","abstract":"Accessible by the declaration’s same file.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:18SwiftLintFramework18AccessControlLevelO8internalyA2CmF":{"name":"internal","abstract":"Accessible by the declaration’s same module, or modules importing it with the @testable attribute.
Accessible by the declaration’s same program.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:18SwiftLintFramework18AccessControlLevelO4openyA2CmF":{"name":"open","abstract":"Accessible and customizable (via subclassing or overrides) by the declaration’s same program.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"AccessControlLevel"},"Enums/ExecutableInfo.html#/buildID":{"name":"buildID","abstract":"A stable identifier for this executable. Uses the Mach-O header UUID on macOS. Nil on Linux.
","parent_name":"ExecutableInfo"},"Enums/ExecutableInfo.html#/s:18SwiftLintFramework14ExecutableInfoO7buildIDSSSgvpZ":{"name":"buildID","abstract":"A stable identifier for this executable. Uses the Mach-O header UUID on macOS. Nil on Linux.
","parent_name":"ExecutableInfo"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO4callyA2CmF":{"name":"call","abstract":"A call to a named function or closure.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO8argumentyA2CmF":{"name":"argument","abstract":"An argument value for a function or closure.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO5arrayyA2CmF":{"name":"array","abstract":"An Array expression.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO10dictionaryyA2CmF":{"name":"dictionary","abstract":"A Dictionary expression.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO13objectLiteralyA2CmF":{"name":"objectLiteral","abstract":"An object literal expression. https://developer.apple.com/swift/blog/?id=33
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO7closureyA2CmF":{"name":"closure","abstract":"A closure expression. https://docs.swift.org/swift-book/LanguageGuide/Closures.html
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO5tupleyA2CmF":{"name":"tuple","abstract":"A tuple expression. https://docs.swift.org/swift-book/ReferenceManual/Types.html#ID448
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html":{"name":"SwiftExpressionKind","abstract":"The kind of expression for a contiguous set of Swift source tokens.
"},"Enums/ExecutableInfo.html":{"name":"ExecutableInfo","abstract":"Information about this executable.
"},"Enums/AccessControlLevel.html":{"name":"AccessControlLevel","abstract":"The accessibility of a Swift source declaration.
"},"Enums/ConfigurationError.html":{"name":"ConfigurationError","abstract":"All possible configuration errors.
"},"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/ViolationSeverity.html":{"name":"ViolationSeverity","abstract":"The magnitude of a StyleViolation.
The rule list containing all available rules built into SwiftLint.
"},"Classes/RuleStorage.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RuleStorage"},"Classes/RuleStorage.html#/s:18SwiftLintFramework11RuleStorageCACycfc":{"name":"init()","abstract":"Creates a RuleStorage with no initial stored data.
Creates a LinterCache by specifying a SwiftLint configuration and a file manager.
Persists the cache to disk.
","parent_name":"LinterCache"},"Classes/SwiftLintFile.html#/s:18SwiftLintFramework0aB4FileC4fileAC012SourceKittenC00D0C_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:18SwiftLintFramework0aB4FileC20pathDeferringReadingACSS_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:18SwiftLintFramework0aB4FileC8contentsACSS_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:18SwiftLintFramework0aB4FileC8contentsSSvp":{"name":"contents","abstract":"The file’s contents.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:18SwiftLintFramework0aB4FileC10stringView012SourceKittenC006StringF0Vvp":{"name":"stringView","abstract":"A string view into the contents of this file optimized for string manipulation operations.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:18SwiftLintFramework0aB4FileC5linesSay012SourceKittenC04LineVGvp":{"name":"lines","abstract":"The parsed lines for this file’s contents.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:18SwiftLintFramework0aB4FileC15invalidateCacheyyF":{"name":"invalidateCache()","abstract":"Invalidates all cached data for this file.
","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/SwiftLintFile.html":{"name":"SwiftLintFile","abstract":"A unit of Swift source code, either on disk or in memory.
"},"Classes/LinterCache.html":{"name":"LinterCache","abstract":"A persisted cache for storing and retrieving linter results.
"},"Classes/RuleStorage.html":{"name":"RuleStorage","abstract":"A storage mechanism for aggregating the results of CollectingRules.
Reports violations as a newline-separated string of comma-separated values (CSV).
"},"Structs/CheckstyleReporter.html":{"name":"CheckstyleReporter","abstract":"Reports violations as XML conforming to the Checkstyle specification, as defined here:"},"Structs/EmojiReporter.html":{"name":"EmojiReporter","abstract":"
Reports violations in the format that’s both fun and easy to read.
"},"Structs/GitHubActionsLoggingReporter.html":{"name":"GitHubActionsLoggingReporter","abstract":"Reports violations in the format GitHub-hosted virtual machine for Actions can recognize as messages.
"},"Structs/HTMLReporter.html":{"name":"HTMLReporter","abstract":"Reports violations as HTML.
"},"Structs/JSONReporter.html":{"name":"JSONReporter","abstract":"Reports violations as a JSON array.
"},"Structs/JUnitReporter.html":{"name":"JUnitReporter","abstract":"Reports violations as JUnit XML.
"},"Structs/MarkdownReporter.html":{"name":"MarkdownReporter","abstract":"Reports violations as markdown formated (with tables).
"},"rule-directory.html":{"name":"Rule Directory"},"Rules.html":{"name":"Rules"},"Reporters.html":{"name":"Reporters"},"Guides.html":{"name":"Guides","abstract":"The following guides are available globally.
"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally.
"},"Global%20Variables.html":{"name":"Global Variables","abstract":"The following global variables 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.
"},"Functions.html":{"name":"Functions","abstract":"The following functions 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.
"}} \ No newline at end of file +{"Structs/XcodeReporter.html#/s:18SwiftLintFramework8ReporterP10identifierSSvpZ":{"name":"identifier","parent_name":"XcodeReporter"},"Structs/XcodeReporter.html#/s:18SwiftLintFramework8ReporterP10isRealtimeSbvpZ":{"name":"isRealtime","parent_name":"XcodeReporter"},"Structs/XcodeReporter.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"XcodeReporter"},"Structs/XcodeReporter.html#/s:18SwiftLintFramework8ReporterP14generateReportySSSayAA14StyleViolationVGFZ":{"name":"generateReport(_:)","parent_name":"XcodeReporter"},"Structs/SonarQubeReporter.html#/s:18SwiftLintFramework8ReporterP10identifierSSvpZ":{"name":"identifier","parent_name":"SonarQubeReporter"},"Structs/SonarQubeReporter.html#/s:18SwiftLintFramework8ReporterP10isRealtimeSbvpZ":{"name":"isRealtime","parent_name":"SonarQubeReporter"},"Structs/SonarQubeReporter.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"SonarQubeReporter"},"Structs/SonarQubeReporter.html#/s:18SwiftLintFramework8ReporterP14generateReportySSSayAA14StyleViolationVGFZ":{"name":"generateReport(_:)","parent_name":"SonarQubeReporter"},"Structs/GitLabJUnitReporter.html#/s:18SwiftLintFramework8ReporterP10identifierSSvpZ":{"name":"identifier","parent_name":"GitLabJUnitReporter"},"Structs/GitLabJUnitReporter.html#/s:18SwiftLintFramework8ReporterP10isRealtimeSbvpZ":{"name":"isRealtime","parent_name":"GitLabJUnitReporter"},"Structs/GitLabJUnitReporter.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"GitLabJUnitReporter"},"Structs/GitLabJUnitReporter.html#/s:18SwiftLintFramework8ReporterP14generateReportySSSayAA14StyleViolationVGFZ":{"name":"generateReport(_:)","parent_name":"GitLabJUnitReporter"},"Structs/CodeClimateReporter.html#/s:18SwiftLintFramework8ReporterP10identifierSSvpZ":{"name":"identifier","parent_name":"CodeClimateReporter"},"Structs/CodeClimateReporter.html#/s:18SwiftLintFramework8ReporterP10isRealtimeSbvpZ":{"name":"isRealtime","parent_name":"CodeClimateReporter"},"Structs/CodeClimateReporter.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"CodeClimateReporter"},"Structs/CodeClimateReporter.html#/s:18SwiftLintFramework8ReporterP14generateReportySSSayAA14StyleViolationVGFZ":{"name":"generateReport(_:)","parent_name":"CodeClimateReporter"},"Structs/YamlParser.html#/s:18SwiftLintFramework10YamlParserV5parse_3envSDySSypGSS_SDyS2SGtKFZ":{"name":"parse(_:env:)","abstract":"Parses the input YAML string as an untyped dictionary.
","parent_name":"YamlParser"},"Structs/Version.html#/s:18SwiftLintFramework7VersionV5valueSSvp":{"name":"value","abstract":"The string value for this version.
","parent_name":"Version"},"Structs/Version.html#/s:18SwiftLintFramework7VersionV7currentACvpZ":{"name":"current","abstract":"The current SwiftLint version.
","parent_name":"Version"},"Structs/SwiftVersion.html#/s:SY8RawValueQa":{"name":"RawValue","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:SY8rawValue03RawB0Qzvp":{"name":"rawValue","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:SY8rawValuexSg03RawB0Qz_tcfc":{"name":"init(rawValue:)","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV4fiveACvpZ":{"name":"five","abstract":"Swift 5.0.x - https://swift.org/download/#swift-50
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV10fiveDotOneACvpZ":{"name":"fiveDotOne","abstract":"Swift 5.1.x - https://swift.org/download/#swift-51
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV10fiveDotTwoACvpZ":{"name":"fiveDotTwo","abstract":"Swift 5.2.x - https://swift.org/download/#swift-52
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV12fiveDotThreeACvpZ":{"name":"fiveDotThree","abstract":"Swift 5.3.x - https://swift.org/download/#swift-53
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV11fiveDotFourACvpZ":{"name":"fiveDotFour","abstract":"Swift 5.4.x - https://swift.org/download/#swift-54
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV11fiveDotFiveACvpZ":{"name":"fiveDotFive","abstract":"Swift 5.5.x - https://swift.org/download/#swift-55
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV10fiveDotSixACvpZ":{"name":"fiveDotSix","abstract":"Swift 5.6.x - https://swift.org/download/#swift-56
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV12fiveDotSevenACvpZ":{"name":"fiveDotSeven","abstract":"Swift 5.7.x - https://swift.org/download/#swift-57
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV7currentACvpZ":{"name":"current","abstract":"The current detected Swift compiler version, based on the currently accessible SourceKit version.
","parent_name":"SwiftVersion"},"Structs/SwiftLintSyntaxToken.html#/s:18SwiftLintFramework0aB11SyntaxTokenV5value012SourceKittenC00dE0Vvp":{"name":"value","abstract":"The raw SyntaxToken obtained by SourceKitten.
The syntax kind associated with is token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:18SwiftLintFramework0aB11SyntaxTokenV5valueAC012SourceKittenC00dE0V_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:18SwiftLintFramework0aB11SyntaxTokenV6offset012SourceKittenC09ByteCountVvp":{"name":"offset","abstract":"The starting byte offset in a source file for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:18SwiftLintFramework0aB11SyntaxTokenV6length012SourceKittenC09ByteCountVvp":{"name":"length","abstract":"The length in bytes for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxMap.html#/s:18SwiftLintFramework0aB9SyntaxMapV5value012SourceKittenC00dE0Vvp":{"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:18SwiftLintFramework0aB9SyntaxMapV5valueAC012SourceKittenC00dE0V_tcfc":{"name":"init(value:)","abstract":"Creates a SwiftLintSyntaxMap from the raw SyntaxMap obtained by SourceKitten.
The identifier of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV15ruleDescriptionSSvp":{"name":"ruleDescription","abstract":"The description of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV8ruleNameSSvp":{"name":"ruleName","abstract":"The name of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV8severityAA0E8SeverityOvp":{"name":"severity","abstract":"The severity of this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV8locationAA8LocationVvp":{"name":"location","abstract":"The location of this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV6reasonSSvp":{"name":"reason","abstract":"The justification for this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV11descriptionSSvp":{"name":"description","abstract":"A printable description for this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV15ruleDescription8severity8location6reasonAcA04RuleG0V_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:18SwiftLintFramework13RuleParameterV5valuexvp":{"name":"value","abstract":"The value to configure the rule.
","parent_name":"RuleParameter"},"Structs/RuleParameter.html#/s:18SwiftLintFramework13RuleParameterV8severity5valueACyxGAA17ViolationSeverityO_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:18SwiftLintFramework8RuleListV5rulesAcA0D0_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:18SwiftLintFramework15RuleDescriptionV4nameSSvp":{"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:18SwiftLintFramework15RuleDescriptionV11descriptionSSvp":{"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:18SwiftLintFramework15RuleDescriptionV4kindAA0D4KindOvp":{"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:18SwiftLintFramework15RuleDescriptionV18triggeringExamplesSayAA7ExampleVGvp":{"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:18SwiftLintFramework15RuleDescriptionV11correctionsSDyAA7ExampleVAFGvp":{"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:18SwiftLintFramework15RuleDescriptionV17deprecatedAliasesShySSGvp":{"name":"deprecatedAliases","abstract":"
Any previous iteration of the rule’s identifier that was previously shipped with SwiftLint.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:18SwiftLintFramework15RuleDescriptionV03minA7VersionAA0aG0Vvp":{"name":"minSwiftVersion","abstract":"The oldest version of the Swift compiler supported by this rule.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:18SwiftLintFramework15RuleDescriptionV18requiresFileOnDiskSbvp":{"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:18SwiftLintFramework15RuleDescriptionV07consoleE0SSvp":{"name":"consoleDescription","abstract":"
The console-printable string for this description.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:18SwiftLintFramework15RuleDescriptionV14allIdentifiersSaySSGvp":{"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:18SwiftLintFramework15RuleDescriptionV10identifier4name11description4kind03minA7Version21nonTriggeringExamples010triggeringN011corrections17deprecatedAliases18requiresFileOnDiskACSS_S2SAA0D4KindOAA0aK0VSayAA7ExampleVGATSDyA2SGShySSGSbtcfc":{"name":"init(identifier:name:description:kind:minSwiftVersion:nonTriggeringExamples:triggeringExamples:corrections:deprecatedAliases:requiresFileOnDisk:)","abstract":"Creates a RuleDescription by specifying all its properties directly.
The location describing the start of the region. All locations that are less than this value","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV3endAA8LocationVvp":{"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:18SwiftLintFramework6RegionV23disabledRuleIdentifiersShyAA0F10IdentifierOGvp":{"name":"disabledRuleIdentifiers","abstract":"
All SwiftLint rule identifiers that are disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV5start3end23disabledRuleIdentifiersAcA8LocationV_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:18SwiftLintFramework6RegionV8containsySbAA8LocationVF":{"name":"contains(_:)","abstract":"Whether the specific location is contained in this region.
","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV13isRuleEnabledySbAA0F0_pF":{"name":"isRuleEnabled(_:)","abstract":"Whether the specified rule is enabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV14isRuleDisabledySbAA0F0_pF":{"name":"isRuleDisabled(_:)","abstract":"Whether the specified rule is disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV26deprecatedAliasesDisabling4ruleShySSGAA4Rule_p_tF":{"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:18SwiftLintFramework8LocationV4fileSSSgvp":{"name":"file","abstract":"
The file path on disk for this location.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV4lineSiSgvp":{"name":"line","abstract":"The line offset in the file for this location. 1-indexed.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV9characterSiSgvp":{"name":"character","abstract":"The character offset in the file for this location. 1-indexed.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV11descriptionSSvp":{"name":"description","abstract":"A lossless printable description of this location.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV12relativeFileSSSgvp":{"name":"relativeFile","abstract":"The file path for this location relative to the current working directory.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV4file4line9characterACSSSg_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:18SwiftLintFramework8LocationV4file8positionAcA0aB4FileC_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:18SwiftLintFramework8LocationV4file15characterOffsetAcA0aB4FileC_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/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV4fileAA0aB4FileCvp":{"name":"file","abstract":"
The file to lint with this linter.
","parent_name":"CollectedLinter"},"Structs/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV15styleViolations5usingSayAA14StyleViolationVGAA11RuleStorageC_tF":{"name":"styleViolations(using:)","abstract":"Computes or retrieves style violations.
","parent_name":"CollectedLinter"},"Structs/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV27styleViolationsAndRuleTimes5usingSayAA14StyleViolationVG_SaySS2id_Sd4timetGtAA0I7StorageC_tF":{"name":"styleViolationsAndRuleTimes(using:)","abstract":"Computes or retrieves style violations and the time spent executing each rule.
","parent_name":"CollectedLinter"},"Structs/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV7correct5usingSayAA10CorrectionVGAA11RuleStorageC_tF":{"name":"correct(using:)","abstract":"Applies corrections for all rules to this file, returning performed corrections.
","parent_name":"CollectedLinter"},"Structs/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV6format7useTabs11indentWidthySb_SitF":{"name":"format(useTabs:indentWidth:)","abstract":"Formats the file associated with this linter.
","parent_name":"CollectedLinter"},"Structs/Linter.html#/s:18SwiftLintFramework6LinterV4fileAA0aB4FileCvp":{"name":"file","abstract":"The file to lint with this linter.
","parent_name":"Linter"},"Structs/Linter.html#/s:18SwiftLintFramework6LinterV12isCollectingSbvp":{"name":"isCollecting","abstract":"Whether or not this linter will be used to collect information from several files.
","parent_name":"Linter"},"Structs/Linter.html#/s:18SwiftLintFramework6LinterV4file13configuration5cache17compilerArgumentsAcA0aB4FileC_AA13ConfigurationVAA0D5CacheCSgSaySSGtcfc":{"name":"init(file:configuration:cache:compilerArguments:)","abstract":"Creates a Linter by specifying its properties directly.
Returns a linter capable of checking for violations after running each rule’s collection step.
","parent_name":"Linter"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV4codeSSvp":{"name":"code","abstract":"The contents of the example
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV13configurationypSgvp":{"name":"configuration","abstract":"The untyped configuration to apply to the rule, if deviating from the default configuration.","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV20testMultiByteOffsetsSbvp":{"name":"testMultiByteOffsets","abstract":"
Whether the example should be tested by prepending multibyte grapheme clusters
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV11testOnLinuxSbvp":{"name":"testOnLinux","abstract":"Whether the example should be tested on Linux
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV4files12StaticStringVvp":{"name":"file","abstract":"The path to the file where the example was created
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV4lineSuvp":{"name":"line","abstract":"The line in the file where the example was created
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV_13configuration20testMultiByteOffsets0F17WrappingInComment0fjK6String0F14DisableCommand0F7OnLinux4file4line24excludeFromDocumentationACSS_ypSgS5bs06StaticM0VSuSbtcfc":{"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:18SwiftLintFramework7ExampleV4with4codeACSS_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: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:18SwiftLintFramework10CorrectionV15ruleDescriptionAA04RuleF0Vvp":{"name":"ruleDescription","abstract":"The description of the rule for which this correction was applied.
","parent_name":"Correction"},"Structs/Correction.html#/s:18SwiftLintFramework10CorrectionV8locationAA8LocationVvp":{"name":"location","abstract":"The location of the original violation that was corrected.
","parent_name":"Correction"},"Structs/Correction.html#/s:18SwiftLintFramework10CorrectionV18consoleDescriptionSSvp":{"name":"consoleDescription","abstract":"The console-printable description for this correction.
","parent_name":"Correction"},"Structs/Command/Modifier.html#/s:18SwiftLintFramework7CommandV8ModifierO8previousyA2EmF":{"name":"previous","abstract":"The command should only apply to the line preceding its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:18SwiftLintFramework7CommandV8ModifierO4thisyA2EmF":{"name":"this","abstract":"The command should only apply to the same line as its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:18SwiftLintFramework7CommandV8ModifierO4nextyA2EmF":{"name":"next","abstract":"The command should only apply to the line following its definition.
","parent_name":"Modifier"},"Structs/Command/Action.html#/s:18SwiftLintFramework7CommandV6ActionO6enableyA2EmF":{"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:18SwiftLintFramework7CommandV6ActionO7disableyA2EmF":{"name":"disable","abstract":"The rule(s) associated with this command should be disabled by the SwiftLint engine.
","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:18SwiftLintFramework7CommandV6action15ruleIdentifiers4line9character8modifier15trailingCommentA2C6ActionO_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:18SwiftLintFramework7CommandV12actionString4line9characterACSgSS_S2itcfc":{"name":"init(actionString:line:character:)","abstract":"Creates a command based on the specified parameters.
","parent_name":"Command"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV5valueSDySS0deC00D16KitRepresentable_pGvp":{"name":"value","abstract":"The underlying SourceKitten dictionary.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV12substructureSayACGvp":{"name":"substructure","abstract":"The cached substructure for this dictionary. Empty if there is no substructure.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV14expressionKindAA0a10ExpressionH0OSgvp":{"name":"expressionKind","abstract":"The kind of Swift expression represented by this dictionary, if it is an expression.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV15declarationKind0deC00a11DeclarationH0OSgvp":{"name":"declarationKind","abstract":"The kind of Swift declaration represented by this dictionary, if it is a declaration.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV13statementKind0deC009StatementH0OSgvp":{"name":"statementKind","abstract":"The kind of Swift statement represented by this dictionary, if it is a statement.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV13accessibilityAA18AccessControlLevelOSgvp":{"name":"accessibility","abstract":"The accessibility level for this dictionary, if it is a declaration.
","parent_name":"SourceKittenDictionary"},"Structs/Configuration/RulesMode.html#/s:18SwiftLintFramework13ConfigurationV9RulesModeO7defaultyAEShySSG_AGtcAEmF":{"name":"default(disabled:optIn:)","abstract":"The default rules mode, which will enable all rules that aren’t defined as being opt-in","parent_name":"RulesMode"},"Structs/Configuration/RulesMode.html#/s:18SwiftLintFramework13ConfigurationV9RulesModeO4onlyyAEShySSGcAEmF":{"name":"only(_:)","abstract":"
Only enable the rules explicitly listed.
","parent_name":"RulesMode"},"Structs/Configuration/RulesMode.html#/s:18SwiftLintFramework13ConfigurationV9RulesModeO10allEnabledyA2EmF":{"name":"allEnabled","abstract":"Enable all available rules.
","parent_name":"RulesMode"},"Structs/Configuration/IndentationStyle.html#/s:18SwiftLintFramework13ConfigurationV16IndentationStyleO4tabsyA2EmF":{"name":"tabs","abstract":"Swift source code should be indented using tabs.
","parent_name":"IndentationStyle"},"Structs/Configuration/IndentationStyle.html#/s:18SwiftLintFramework13ConfigurationV16IndentationStyleO6spacesyAESi_tcAEmF":{"name":"spaces(count:)","abstract":"Swift source code should be indented using spaces with count spaces per indentation level.
The default indentation style if none is explicitly provided.
","parent_name":"IndentationStyle"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV7defaultACvpZ":{"name":"default","abstract":"The default Configuration resulting from an empty configuration file.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV15defaultFileNameSSvpZ":{"name":"defaultFileName","abstract":"The default file name to look for user-defined configurations.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13includedPathsSaySSGvp":{"name":"includedPaths","abstract":"The paths that should be included when linting
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13excludedPathsSaySSGvp":{"name":"excludedPaths","abstract":"The paths that should be excluded when linting
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV11indentationAC16IndentationStyleOvp":{"name":"indentation","abstract":"The style to use when indenting Swift source code.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV16warningThresholdSiSgvp":{"name":"warningThreshold","abstract":"The threshold for the number of warnings to tolerate before treating the lint as having failed.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV8reporterSSvp":{"name":"reporter","abstract":"The identifier for the Reporter to use to report style violations.
The location of the persisted cache to use with this configuration.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV22allowZeroLintableFilesSbvp":{"name":"allowZeroLintableFiles","abstract":"Allow or disallow SwiftLint to exit successfully when passed only ignored or unlintable files.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV013basedOnCustomD5FilesSbvp":{"name":"basedOnCustomConfigurationFiles","abstract":"This value is true iff the --config parameter was used to specify (a) configuration file(s)","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV5rulesSayAA4Rule_pGvp":{"name":"rules","abstract":"
All rules enabled in this configuration
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13rootDirectorySSvp":{"name":"rootDirectory","abstract":"The root directory is the directory that included & excluded paths relate to.","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV9rulesModeAC05RulesF0Ovp":{"name":"rulesMode","abstract":"
The rules mode used for this configuration.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV18configurationFiles14enableAllRules9cachePath27ignoreParentAndChildConfigs20mockedNetworkResults25useDefaultConfigOnFailureACSaySSG_SbSSSgSbSDyS2SGSbSgtcfc":{"name":"init(configurationFiles:enableAllRules:cachePath:ignoreParentAndChildConfigs:mockedNetworkResults:useDefaultConfigOnFailure:)","abstract":"Creates a Configuration with convenience parameters.
Returns a copy of the current Configuration with its computedCacheDescription property set to the value of","parent_name":"Configuration"},"Structs/Configuration/IndentationStyle.html":{"name":"IndentationStyle","abstract":"
The style of indentation used in a Swift project.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13lintableFiles6inPath12forceExclude15excludeByPrefixSayAA0aB4FileCGSS_S2btF":{"name":"lintableFiles(inPath:forceExclude:excludeByPrefix:)","abstract":"Returns the files that can be linted by SwiftLint in the specified parent path.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV19filterExcludedPaths11fileManager2inSaySSGAA012LintableFileI0_p_AGdtF":{"name":"filterExcludedPaths(fileManager:in:)","abstract":"Returns an array of file paths after removing the excluded paths as defined by this configuration.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV27filterExcludedPathsByPrefix2inSaySSGAFd_tF":{"name":"filterExcludedPathsByPrefix(in:)","abstract":"Returns the file paths that are excluded by this configuration using filtering by absolute path prefix.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13configuration3forAcA0aB4FileC_tF":{"name":"configuration(for:)","abstract":"Returns a new configuration that applies to the specified file by merging the current configuration with any","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV4dict8ruleList14enableAllRules9cachePathACSDySSypG_AA04RuleG0VSbSSSgtKcfc":{"name":"init(dict:ruleList:enableAllRules:cachePath:)","abstract":"
Creates a Configuration value based on the specified parameters.
","parent_name":"Configuration"},"Structs/Configuration/RulesMode.html":{"name":"RulesMode","abstract":"Represents how a Configuration object can be configured with regards to rules.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"Configuration"},"Structs/Configuration.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"Configuration"},"Structs/Configuration.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"Configuration"},"Structs/RuleListDocumentation.html#/s:18SwiftLintFramework21RuleListDocumentationVyAcA0dE0Vcfc":{"name":"init(_:)","abstract":"Creates a RuleListDocumentation instance from a RuleList.
","parent_name":"RuleListDocumentation"},"Structs/RuleListDocumentation.html#/s:18SwiftLintFramework21RuleListDocumentationV5write2toy10Foundation3URLV_tKF":{"name":"write(to:)","abstract":"Write the rule list documentation as markdown files to the specified directory.
","parent_name":"RuleListDocumentation"},"Structs/RuleListDocumentation.html":{"name":"RuleListDocumentation","abstract":"User-facing documentation for a SwiftLint RuleList.
"},"Structs/Configuration.html":{"name":"Configuration","abstract":"The configuration struct for SwiftLint. User-defined in the .swiftlint.yml file, drives the behavior of SwiftLint.
A collection of keys and values as parsed out of SourceKit, with many conveniences for accessing SwiftLint-specific"},"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/Linter.html":{"name":"Linter","abstract":"
Represents a file that can be linted for style violations and corrections after being collected.
"},"Structs/CollectedLinter.html":{"name":"CollectedLinter","abstract":"Represents a file that can compute style violations and corrections for a list of rules.
"},"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/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/Version.html":{"name":"Version","abstract":"A type describing the SwiftLint version.
"},"Structs/YamlParser.html":{"name":"YamlParser","abstract":"An interface for parsing YAML.
"},"Structs/CodeClimateReporter.html":{"name":"CodeClimateReporter","abstract":"Reports violations as a JSON array in Code Climate format.
"},"Structs/GitLabJUnitReporter.html":{"name":"GitLabJUnitReporter","abstract":"Reports violations as JUnit XML supported by GitLab.
"},"Structs/SonarQubeReporter.html":{"name":"SonarQubeReporter","abstract":"Reports violations in SonarQube import format.
"},"Structs/XcodeReporter.html":{"name":"XcodeReporter","abstract":"Reports violations in the format Xcode uses to display in the IDE. (default)
"},"Protocols/SwiftSyntaxRule.html#/s:18SwiftLintFramework0A10SyntaxRuleP11makeVisitor4fileAA010ViolationsdG0CSgAA0aB4FileC_tF":{"name":"makeVisitor(file:)","abstract":"Produce a ViolationsSyntaxVisitor for the given file.
Produce a violation for the given file and absolute position.
","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxRule.html#/s:18SwiftLintFramework0A10SyntaxRulePAAE15disabledRegions4fileSay0aD011SourceRangeVGAA0aB4FileC_tF":{"name":"disabledRegions(file:)","abstract":"Returns the source ranges in the specified file where this rule is disabled.
","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxRule.html#/s:18SwiftLintFramework4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"SwiftSyntaxRule"},"Protocols/ViolationsSyntaxRewriter.html#/s:18SwiftLintFramework24ViolationsSyntaxRewriterP19correctionPositionsSay0aE016AbsolutePositionVGvp":{"name":"correctionPositions","abstract":"Positions in a source file where corrections were applied.
","parent_name":"ViolationsSyntaxRewriter"},"Protocols/SwiftSyntaxCorrectableRule.html#/s:18SwiftLintFramework0A21SyntaxCorrectableRuleP12makeRewriter4fileAA010ViolationsdH0_pSgAA0aB4FileC_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:18SwiftLintFramework30SeverityBasedRuleConfigurationPAAE8severityAA09ViolationD0Ovp":{"name":"severity","abstract":"The severity of a rule.
","parent_name":"SeverityBasedRuleConfiguration"},"Protocols/RuleConfiguration.html#/s:18SwiftLintFramework17RuleConfigurationP18consoleDescriptionSSvp":{"name":"consoleDescription","abstract":"A human-readable description for this configuration and its applied values.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:18SwiftLintFramework17RuleConfigurationP5apply13configurationyyp_tKF":{"name":"apply(configuration:)","abstract":"Apply an untyped configuration to the current value.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:18SwiftLintFramework17RuleConfigurationP9isEqualToySbAaB_pF":{"name":"isEqualTo(_:)","abstract":"Whether the specified configuration is equivalent to the current value.
","parent_name":"RuleConfiguration"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework25CollectingCorrectableRuleP7correct4file13collectedInfo17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_SDyAL0nJ0QzGSaySSGtF":{"name":"correct(file:collectedInfo:compilerArguments:)","abstract":"Attempts to correct the violations to this rule in the specified file after collecting file info for all files","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework25CollectingCorrectableRuleP7correct4file13collectedInfoSayAA10CorrectionVGAA0aB4FileC_SDyAK0lJ0QzGtF":{"name":"correct(file:collectedInfo:)","abstract":"
Attempts to correct the violations to this rule in the specified file after collecting file info for all files","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4file5using17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_AA0E7StorageCSaySSGtF":{"name":"correct(file:using:compilerArguments:)","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4file17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_SaySSGtF":{"name":"correct(file:compilerArguments:)","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework14CollectingRuleP8FileInfoQa":{"name":"FileInfo","abstract":"
The kind of information to collect for each file being linted for this rule.
","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework14CollectingRuleP11collectInfo3for17compilerArguments04FileG0QzAA0abK0C_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:18SwiftLintFramework14CollectingRuleP8validate4file13collectedInfoSayAA14StyleViolationVGAA0aB4FileC_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:18SwiftLintFramework4RuleP11collectInfo3for4into17compilerArgumentsyAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"collectInfo(for:into:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework4RuleP8validate4file5using17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"validate(file:using:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework4RuleP8validate4file17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_SaySSGtF":{"name":"validate(file:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/AnalyzerRule.html#/s:18SwiftLintFramework4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"AnalyzerRule"},"Protocols/SubstitutionCorrectableASTRule.html#/s:18SwiftLintFramework30SubstitutionCorrectableASTRuleP15violationRanges2in4kind10dictionarySaySo8_NSRangeVGAA0aB4FileC_8KindTypeQzAA22SourceKittenDictionaryVtF":{"name":"violationRanges(in:kind:dictionary:)","abstract":"
Returns the NSString-based NSRanges to be replaced in the specified file.
Returns the NSString-based NSRanges to be replaced in the specified file.
Returns the substitution to apply for the given range.
","parent_name":"SubstitutionCorrectableRule"},"Protocols/SubstitutionCorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","parent_name":"SubstitutionCorrectableRule"},"Protocols/CorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4file17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_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:18SwiftLintFramework15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","abstract":"Attempts to correct the violations to this rule in the specified file.
","parent_name":"CorrectableRule"},"Protocols/CorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4file5using17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_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/ConfigurationProviderRule.html#/s:18SwiftLintFramework25ConfigurationProviderRuleP0D4TypeQa":{"name":"ConfigurationType","abstract":"
The type of configuration used to configure this rule.
","parent_name":"ConfigurationProviderRule"},"Protocols/ConfigurationProviderRule.html#/s:18SwiftLintFramework25ConfigurationProviderRuleP13configuration0D4TypeQzvp":{"name":"configuration","abstract":"This rule’s configuration.
","parent_name":"ConfigurationProviderRule"},"Protocols/ConfigurationProviderRule.html#/s:18SwiftLintFramework4RuleP13configurationxyp_tKcfc":{"name":"init(configuration:)","parent_name":"ConfigurationProviderRule"},"Protocols/ConfigurationProviderRule.html#/s:18SwiftLintFramework4RuleP9isEqualToySbAaB_pF":{"name":"isEqualTo(_:)","parent_name":"ConfigurationProviderRule"},"Protocols/ConfigurationProviderRule.html#/s:18SwiftLintFramework4RuleP24configurationDescriptionSSvp":{"name":"configurationDescription","parent_name":"ConfigurationProviderRule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP11descriptionAA0D11DescriptionVvpZ":{"name":"description","abstract":"A verbose description of many of this rule’s properties.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP24configurationDescriptionSSvp":{"name":"configurationDescription","abstract":"A description of how this rule has been configured to run.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RulePxycfc":{"name":"init()","abstract":"A default initializer for rules. All rules need to be trivially initializable.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP13configurationxyp_tKcfc":{"name":"init(configuration:)","abstract":"Creates a rule by applying its configuration.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP8validate4file17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_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:18SwiftLintFramework4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_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:18SwiftLintFramework4RuleP9isEqualToySbAaB_pF":{"name":"isEqualTo(_:)","abstract":"Whether or not the specified rule is equivalent to the current rule.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP11collectInfo3for4into17compilerArgumentsyAA0aB4FileC_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/Reporter.html#/s:18SwiftLintFramework8ReporterP10identifierSSvpZ":{"name":"identifier","abstract":"
The unique identifier for this reporter.
","parent_name":"Reporter"},"Protocols/Reporter.html#/s:18SwiftLintFramework8ReporterP10isRealtimeSbvpZ":{"name":"isRealtime","abstract":"Whether or not this reporter can output incrementally as violations are found or if all violations must be","parent_name":"Reporter"},"Protocols/Reporter.html#/s:18SwiftLintFramework8ReporterP14generateReportySSSayAA14StyleViolationVGFZ":{"name":"generateReport(_:)","abstract":"
Return a string with the report for the specified violations.
","parent_name":"Reporter"},"Protocols/ASTRule.html#/s:18SwiftLintFramework7ASTRuleP8KindTypeQa":{"name":"KindType","abstract":"The kind of token being recursed over.
","parent_name":"ASTRule"},"Protocols/ASTRule.html#/s:18SwiftLintFramework7ASTRuleP8validate4file4kind10dictionarySayAA14StyleViolationVGAA0aB4FileC_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:18SwiftLintFramework7ASTRuleP4kind4from8KindTypeQzSgAA22SourceKittenDictionaryV_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/LintableFileManager.html#/s:18SwiftLintFramework19LintableFileManagerP07filesToB06inPath13rootDirectorySaySSGSS_SSSgtF":{"name":"filesToLint(inPath:rootDirectory:)","abstract":"
Returns all files that can be linted in the specified path. If the path is relative, it will be appended to the","parent_name":"LintableFileManager"},"Protocols/LintableFileManager.html#/s:18SwiftLintFramework19LintableFileManagerP16modificationDate03forE6AtPath10Foundation0H0VSgSS_tF":{"name":"modificationDate(forFileAtPath:)","abstract":"
Returns the date when the file at the specified path was last modified. Returns nil if the file cannot be","parent_name":"LintableFileManager"},"Protocols/LintableFileManager.html":{"name":"LintableFileManager","abstract":"
An interface for enumerating files that can be linted by SwiftLint.
"},"Protocols/ASTRule.html":{"name":"ASTRule","abstract":"A rule that leverages the Swift source’s pre-typechecked Abstract Syntax Tree to recurse into the source’s"},"Protocols/Reporter.html":{"name":"Reporter","abstract":"
An interface for reporting violations as strings.
"},"Protocols/Rule.html":{"name":"Rule","abstract":"An executable value that can identify issues (violations) in Swift source code.
"},"Protocols.html#/s:18SwiftLintFramework9OptInRuleP":{"name":"OptInRule","abstract":"A rule that is not enabled by default. Rules conforming to this need to be explicitly enabled by users.
"},"Protocols/ConfigurationProviderRule.html":{"name":"ConfigurationProviderRule","abstract":"A rule that is user-configurable.
"},"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/SubstitutionCorrectableASTRule.html":{"name":"SubstitutionCorrectableASTRule","abstract":"
A SubstitutionCorrectableRule that is also an ASTRule.
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.html#/s:18SwiftLintFramework17AnyCollectingRuleP":{"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/CollectingCorrectableRule.html":{"name":"CollectingCorrectableRule","abstract":"A CollectingRule that is also a CorrectableRule.
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 SwiftSyntax SyntaxRewriter that produces absolute positions where corrections were applied.
A SwiftLint Rule backed by SwiftSyntax that does not use SourceKit requests.
"},"Functions.html#/s:18SwiftLintFramework11queuedPrintyyxlF":{"name":"queuedPrint(_:)","abstract":"A thread-safe version of Swift’s standard print().
A thread-safe, newline-terminated version of fputs(..., stderr).
A thread-safe, newline-terminated version of fatalError(...) that doesn’t leak"},"Functions.html#/s:18SwiftLintFramework12reporterFrom10identifierAA8Reporter_pXpSS_tF":{"name":"reporterFrom(identifier:)","abstract":"
Returns the reporter with the specified identifier. Traps if the specified identifier doesn’t correspond to any"},"Extensions/String.html#/s:SS18SwiftLintFrameworkE24absolutePathStandardizedSSyF":{"name":"absolutePathStandardized()","abstract":"
Returns a new string, converting the path to a canonical absolute path.
","parent_name":"String"},"Extensions/String.html#/s:SS18SwiftLintFrameworkE16countOccurrences2ofSiSJ_tF":{"name":"countOccurrences(of:)","abstract":"Count the number of occurrences of the given character in self
If self is a path, this method can be used to get a path expression relative to a root directory
","parent_name":"String"},"Extensions/FileManager.html#/s:18SwiftLintFramework19LintableFileManagerP07filesToB06inPath13rootDirectorySaySSGSS_SSSgtF":{"name":"filesToLint(inPath:rootDirectory:)","parent_name":"FileManager"},"Extensions/FileManager.html#/s:18SwiftLintFramework19LintableFileManagerP16modificationDate03forE6AtPath10Foundation0H0VSgSS_tF":{"name":"modificationDate(forFileAtPath:)","parent_name":"FileManager"},"Extensions/FileManager.html":{"name":"FileManager"},"Extensions/String.html":{"name":"String"},"Enums/ViolationSeverity.html#/s:18SwiftLintFramework17ViolationSeverityO7warningyA2CmF":{"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:18SwiftLintFramework17ViolationSeverityO5erroryA2CmF":{"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/RuleListError.html#/s:18SwiftLintFramework13RuleListErrorO24duplicatedConfigurationsyAcA0D0_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:18SwiftLintFramework8RuleKindO4lintyA2CmF":{"name":"lint","abstract":"Describes rules that validate Swift source conventions.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:18SwiftLintFramework8RuleKindO9idiomaticyA2CmF":{"name":"idiomatic","abstract":"Describes rules that validate common practices in the Swift community.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:18SwiftLintFramework8RuleKindO5styleyA2CmF":{"name":"style","abstract":"Describes rules that validate stylistic choices.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:18SwiftLintFramework8RuleKindO7metricsyA2CmF":{"name":"metrics","abstract":"Describes rules that validate magnitudes or measurements of Swift source.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:18SwiftLintFramework8RuleKindO11performanceyA2CmF":{"name":"performance","abstract":"Describes rules that validate that code patterns with poor performance are avoided.
","parent_name":"RuleKind"},"Enums/RuleIdentifier.html#/s:18SwiftLintFramework14RuleIdentifierO3allyA2CmF":{"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:18SwiftLintFramework14RuleIdentifierO6singleyACSS_tcACmF":{"name":"single(identifier:)","abstract":"
Represents a single SwiftLint rule with the specified identifier.
","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:18SwiftLintFramework14RuleIdentifierO20stringRepresentationSSvp":{"name":"stringRepresentation","abstract":"The spelling of the string for this idenfitier.
","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:18SwiftLintFramework14RuleIdentifierOyACSScfc":{"name":"init(_:)","abstract":"Creates a RuleIdentifier by its string representation.
The configuration didn’t match internal expectations.
","parent_name":"ConfigurationError"},"Enums/ConfigurationError.html#/s:18SwiftLintFramework18ConfigurationErrorO28ambiguousMatchKindParametersyA2CmF":{"name":"ambiguousMatchKindParameters","abstract":"The configuration had both match_kind and excluded_match_kind parameters.
A generic configuration error specified by a string.
","parent_name":"ConfigurationError"},"Enums/ConfigurationError.html#/s:18SwiftLintFramework18ConfigurationErrorO19initialFileNotFoundyACSS_tcACmF":{"name":"initialFileNotFound(path:)","abstract":"The initial configuration file was not found.
","parent_name":"ConfigurationError"},"Enums/AccessControlLevel.html#/s:18SwiftLintFramework18AccessControlLevelO7privateyA2CmF":{"name":"private","abstract":"Accessible by the declaration’s immediate lexical scope.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:18SwiftLintFramework18AccessControlLevelO11fileprivateyA2CmF":{"name":"fileprivate","abstract":"Accessible by the declaration’s same file.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:18SwiftLintFramework18AccessControlLevelO8internalyA2CmF":{"name":"internal","abstract":"Accessible by the declaration’s same module, or modules importing it with the @testable attribute.
Accessible by the declaration’s same program.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:18SwiftLintFramework18AccessControlLevelO4openyA2CmF":{"name":"open","abstract":"Accessible and customizable (via subclassing or overrides) by the declaration’s same program.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"AccessControlLevel"},"Enums/ExecutableInfo.html#/buildID":{"name":"buildID","abstract":"A stable identifier for this executable. Uses the Mach-O header UUID on macOS. Nil on Linux.
","parent_name":"ExecutableInfo"},"Enums/ExecutableInfo.html#/s:18SwiftLintFramework14ExecutableInfoO7buildIDSSSgvpZ":{"name":"buildID","abstract":"A stable identifier for this executable. Uses the Mach-O header UUID on macOS. Nil on Linux.
","parent_name":"ExecutableInfo"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO4callyA2CmF":{"name":"call","abstract":"A call to a named function or closure.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO8argumentyA2CmF":{"name":"argument","abstract":"An argument value for a function or closure.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO5arrayyA2CmF":{"name":"array","abstract":"An Array expression.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO10dictionaryyA2CmF":{"name":"dictionary","abstract":"A Dictionary expression.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO13objectLiteralyA2CmF":{"name":"objectLiteral","abstract":"An object literal expression. https://developer.apple.com/swift/blog/?id=33
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO7closureyA2CmF":{"name":"closure","abstract":"A closure expression. https://docs.swift.org/swift-book/LanguageGuide/Closures.html
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO5tupleyA2CmF":{"name":"tuple","abstract":"A tuple expression. https://docs.swift.org/swift-book/ReferenceManual/Types.html#ID448
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html":{"name":"SwiftExpressionKind","abstract":"The kind of expression for a contiguous set of Swift source tokens.
"},"Enums/ExecutableInfo.html":{"name":"ExecutableInfo","abstract":"Information about this executable.
"},"Enums/AccessControlLevel.html":{"name":"AccessControlLevel","abstract":"The accessibility of a Swift source declaration.
"},"Enums/ConfigurationError.html":{"name":"ConfigurationError","abstract":"All possible configuration errors.
"},"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/ViolationSeverity.html":{"name":"ViolationSeverity","abstract":"The magnitude of a StyleViolation.
The rule list containing all available rules built into SwiftLint.
"},"Classes/ViolationsSyntaxVisitor.html#/s:18SwiftLintFramework23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE09ActorDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:18SwiftLintFramework23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE09ClassDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:18SwiftLintFramework23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE08EnumDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:18SwiftLintFramework23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE013ExtensionDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:18SwiftLintFramework23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE012FunctionDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:18SwiftLintFramework23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE012ProtocolDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:18SwiftLintFramework23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE010StructDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/RuleStorage.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RuleStorage"},"Classes/RuleStorage.html#/s:18SwiftLintFramework11RuleStorageCACycfc":{"name":"init()","abstract":"Creates a RuleStorage with no initial stored data.
Creates a LinterCache by specifying a SwiftLint configuration and a file manager.
Persists the cache to disk.
","parent_name":"LinterCache"},"Classes/SwiftLintFile.html#/s:18SwiftLintFramework0aB4FileC4fileAC012SourceKittenC00D0C_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:18SwiftLintFramework0aB4FileC20pathDeferringReadingACSS_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:18SwiftLintFramework0aB4FileC8contentsACSS_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:18SwiftLintFramework0aB4FileC8contentsSSvp":{"name":"contents","abstract":"The file’s contents.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:18SwiftLintFramework0aB4FileC10stringView012SourceKittenC006StringF0Vvp":{"name":"stringView","abstract":"A string view into the contents of this file optimized for string manipulation operations.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:18SwiftLintFramework0aB4FileC5linesSay012SourceKittenC04LineVGvp":{"name":"lines","abstract":"The parsed lines for this file’s contents.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:18SwiftLintFramework0aB4FileC15invalidateCacheyyF":{"name":"invalidateCache()","abstract":"Invalidates all cached data for this file.
","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/SwiftLintFile.html":{"name":"SwiftLintFile","abstract":"A unit of Swift source code, either on disk or in memory.
"},"Classes/LinterCache.html":{"name":"LinterCache","abstract":"A persisted cache for storing and retrieving linter results.
"},"Classes/RuleStorage.html":{"name":"RuleStorage","abstract":"A storage mechanism for aggregating the results of CollectingRules.
A SwiftSyntax SyntaxVisitor that produces absolute positions where violations should be reported.
Reports violations as a newline-separated string of comma-separated values (CSV).
"},"Structs/CheckstyleReporter.html":{"name":"CheckstyleReporter","abstract":"Reports violations as XML conforming to the Checkstyle specification, as defined here:"},"Structs/EmojiReporter.html":{"name":"EmojiReporter","abstract":"
Reports violations in the format that’s both fun and easy to read.
"},"Structs/GitHubActionsLoggingReporter.html":{"name":"GitHubActionsLoggingReporter","abstract":"Reports violations in the format GitHub-hosted virtual machine for Actions can recognize as messages.
"},"Structs/HTMLReporter.html":{"name":"HTMLReporter","abstract":"Reports violations as HTML.
"},"Structs/JSONReporter.html":{"name":"JSONReporter","abstract":"Reports violations as a JSON array.
"},"Structs/JUnitReporter.html":{"name":"JUnitReporter","abstract":"Reports violations as JUnit XML.
"},"Structs/MarkdownReporter.html":{"name":"MarkdownReporter","abstract":"Reports violations as markdown formated (with tables).
"},"rule-directory.html":{"name":"Rule Directory"},"Rules.html":{"name":"Rules"},"Reporters.html":{"name":"Reporters"},"Guides.html":{"name":"Guides","abstract":"The following guides are available globally.
"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally.
"},"Global%20Variables.html":{"name":"Global Variables","abstract":"The following global variables 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.
"},"Functions.html":{"name":"Functions","abstract":"The following functions 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.
"}} \ No newline at end of file diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/self_binding.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/self_binding.html index 6918ca1e7..8a7be9e1b 100644 --- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/self_binding.html +++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/self_binding.html @@ -104,6 +104,9 @@print([foo {
- var sum = 0
- for i in 1...5 { sum += i }
- return sum
-
-}, foo {
- var mul = 1
- for i in 1...5 { mul *= i }
- return mul
-}])
-
-do {
- print("x is 5")
-}
-
do {
print("x is 5")
}
@@ -378,16 +363,31 @@
1
])
+print([foo {
+ var sum = 0
+ for i in 1...5 { sum += i }
+ return sum
+
+}, foo {
+ var mul = 1
+ for i in 1...5 { mul *= i }
+ return mul
+}])
+
+func foo() {
+ run(5) { x in
+ print(x)
+ }
+}
+
[
1,
2,
3
]
-func foo() {
- run(5) { x in
- print(x)
- }
+do {
+ print("x is 5")
}
[1, 2].map { $0 }.filter { true }
@@ -421,23 +421,6 @@
print("x is 5")
↓
-}
-
-print([foo {
- var sum = 0
- for i in 1...5 { sum += i }
- return sum
-
-}, foo {
- var mul = 1
- for i in 1...5 { mul *= i }
- return mul
-↓
-}])
-
-do {
- print("x is 5")
-↓
}
do {
@@ -457,6 +440,25 @@
↓
])
+print([foo {
+ var sum = 0
+ for i in 1...5 { sum += i }
+ return sum
+
+}, foo {
+ var mul = 1
+ for i in 1...5 { mul *= i }
+ return mul
+↓
+}])
+
+func foo() {
+ run(5) { x in
+ print(x)
+ }
+↓
+}
+
[
1,
2,
@@ -464,10 +466,8 @@
↓
]
-func foo() {
- run(5) { x in
- print(x)
- }
+do {
+ print("x is 5")
↓
}
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/vertical_whitespace_opening_braces.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/vertical_whitespace_opening_braces.html
index 0a4559f0a..da4dc54c1 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/vertical_whitespace_opening_braces.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/vertical_whitespace_opening_braces.html
@@ -104,6 +104,9 @@
SwiftLintFile
+
+ ViolationsSyntaxVisitor
+
Parses the input YAML string as an untyped dictionary.
","parent_name":"YamlParser"},"Structs/Version.html#/s:18SwiftLintFramework7VersionV5valueSSvp":{"name":"value","abstract":"The string value for this version.
","parent_name":"Version"},"Structs/Version.html#/s:18SwiftLintFramework7VersionV7currentACvpZ":{"name":"current","abstract":"The current SwiftLint version.
","parent_name":"Version"},"Structs/SwiftVersion.html#/s:SY8RawValueQa":{"name":"RawValue","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:SY8rawValue03RawB0Qzvp":{"name":"rawValue","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:SY8rawValuexSg03RawB0Qz_tcfc":{"name":"init(rawValue:)","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV4fiveACvpZ":{"name":"five","abstract":"Swift 5.0.x - https://swift.org/download/#swift-50
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV10fiveDotOneACvpZ":{"name":"fiveDotOne","abstract":"Swift 5.1.x - https://swift.org/download/#swift-51
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV10fiveDotTwoACvpZ":{"name":"fiveDotTwo","abstract":"Swift 5.2.x - https://swift.org/download/#swift-52
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV12fiveDotThreeACvpZ":{"name":"fiveDotThree","abstract":"Swift 5.3.x - https://swift.org/download/#swift-53
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV11fiveDotFourACvpZ":{"name":"fiveDotFour","abstract":"Swift 5.4.x - https://swift.org/download/#swift-54
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV11fiveDotFiveACvpZ":{"name":"fiveDotFive","abstract":"Swift 5.5.x - https://swift.org/download/#swift-55
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV10fiveDotSixACvpZ":{"name":"fiveDotSix","abstract":"Swift 5.6.x - https://swift.org/download/#swift-56
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV12fiveDotSevenACvpZ":{"name":"fiveDotSeven","abstract":"Swift 5.7.x - https://swift.org/download/#swift-57
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV7currentACvpZ":{"name":"current","abstract":"The current detected Swift compiler version, based on the currently accessible SourceKit version.
","parent_name":"SwiftVersion"},"Structs/SwiftLintSyntaxToken.html#/s:18SwiftLintFramework0aB11SyntaxTokenV5value012SourceKittenC00dE0Vvp":{"name":"value","abstract":"The raw SyntaxToken obtained by SourceKitten.
The syntax kind associated with is token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:18SwiftLintFramework0aB11SyntaxTokenV5valueAC012SourceKittenC00dE0V_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:18SwiftLintFramework0aB11SyntaxTokenV6offset012SourceKittenC09ByteCountVvp":{"name":"offset","abstract":"The starting byte offset in a source file for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:18SwiftLintFramework0aB11SyntaxTokenV6length012SourceKittenC09ByteCountVvp":{"name":"length","abstract":"The length in bytes for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxMap.html#/s:18SwiftLintFramework0aB9SyntaxMapV5value012SourceKittenC00dE0Vvp":{"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:18SwiftLintFramework0aB9SyntaxMapV5valueAC012SourceKittenC00dE0V_tcfc":{"name":"init(value:)","abstract":"Creates a SwiftLintSyntaxMap from the raw SyntaxMap obtained by SourceKitten.
The identifier of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV15ruleDescriptionSSvp":{"name":"ruleDescription","abstract":"The description of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV8ruleNameSSvp":{"name":"ruleName","abstract":"The name of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV8severityAA0E8SeverityOvp":{"name":"severity","abstract":"The severity of this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV8locationAA8LocationVvp":{"name":"location","abstract":"The location of this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV6reasonSSvp":{"name":"reason","abstract":"The justification for this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV11descriptionSSvp":{"name":"description","abstract":"A printable description for this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV15ruleDescription8severity8location6reasonAcA04RuleG0V_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:18SwiftLintFramework13RuleParameterV5valuexvp":{"name":"value","abstract":"The value to configure the rule.
","parent_name":"RuleParameter"},"Structs/RuleParameter.html#/s:18SwiftLintFramework13RuleParameterV8severity5valueACyxGAA17ViolationSeverityO_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:18SwiftLintFramework8RuleListV5rulesAcA0D0_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:18SwiftLintFramework15RuleDescriptionV4nameSSvp":{"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:18SwiftLintFramework15RuleDescriptionV11descriptionSSvp":{"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:18SwiftLintFramework15RuleDescriptionV4kindAA0D4KindOvp":{"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:18SwiftLintFramework15RuleDescriptionV18triggeringExamplesSayAA7ExampleVGvp":{"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:18SwiftLintFramework15RuleDescriptionV11correctionsSDyAA7ExampleVAFGvp":{"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:18SwiftLintFramework15RuleDescriptionV17deprecatedAliasesShySSGvp":{"name":"deprecatedAliases","abstract":"
Any previous iteration of the rule’s identifier that was previously shipped with SwiftLint.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:18SwiftLintFramework15RuleDescriptionV03minA7VersionAA0aG0Vvp":{"name":"minSwiftVersion","abstract":"The oldest version of the Swift compiler supported by this rule.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:18SwiftLintFramework15RuleDescriptionV18requiresFileOnDiskSbvp":{"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:18SwiftLintFramework15RuleDescriptionV07consoleE0SSvp":{"name":"consoleDescription","abstract":"
The console-printable string for this description.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:18SwiftLintFramework15RuleDescriptionV14allIdentifiersSaySSGvp":{"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:18SwiftLintFramework15RuleDescriptionV10identifier4name11description4kind03minA7Version21nonTriggeringExamples010triggeringN011corrections17deprecatedAliases18requiresFileOnDiskACSS_S2SAA0D4KindOAA0aK0VSayAA7ExampleVGATSDyA2SGShySSGSbtcfc":{"name":"init(identifier:name:description:kind:minSwiftVersion:nonTriggeringExamples:triggeringExamples:corrections:deprecatedAliases:requiresFileOnDisk:)","abstract":"Creates a RuleDescription by specifying all its properties directly.
The location describing the start of the region. All locations that are less than this value","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV3endAA8LocationVvp":{"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:18SwiftLintFramework6RegionV23disabledRuleIdentifiersShyAA0F10IdentifierOGvp":{"name":"disabledRuleIdentifiers","abstract":"
All SwiftLint rule identifiers that are disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV5start3end23disabledRuleIdentifiersAcA8LocationV_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:18SwiftLintFramework6RegionV8containsySbAA8LocationVF":{"name":"contains(_:)","abstract":"Whether the specific location is contained in this region.
","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV13isRuleEnabledySbAA0F0_pF":{"name":"isRuleEnabled(_:)","abstract":"Whether the specified rule is enabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV14isRuleDisabledySbAA0F0_pF":{"name":"isRuleDisabled(_:)","abstract":"Whether the specified rule is disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV26deprecatedAliasesDisabling4ruleShySSGAA4Rule_p_tF":{"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:18SwiftLintFramework8LocationV4fileSSSgvp":{"name":"file","abstract":"
The file path on disk for this location.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV4lineSiSgvp":{"name":"line","abstract":"The line offset in the file for this location. 1-indexed.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV9characterSiSgvp":{"name":"character","abstract":"The character offset in the file for this location. 1-indexed.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV11descriptionSSvp":{"name":"description","abstract":"A lossless printable description of this location.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV12relativeFileSSSgvp":{"name":"relativeFile","abstract":"The file path for this location relative to the current working directory.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV4file4line9characterACSSSg_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:18SwiftLintFramework8LocationV4file8positionAcA0aB4FileC_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:18SwiftLintFramework8LocationV4file15characterOffsetAcA0aB4FileC_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/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV4fileAA0aB4FileCvp":{"name":"file","abstract":"
The file to lint with this linter.
","parent_name":"CollectedLinter"},"Structs/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV15styleViolations5usingSayAA14StyleViolationVGAA11RuleStorageC_tF":{"name":"styleViolations(using:)","abstract":"Computes or retrieves style violations.
","parent_name":"CollectedLinter"},"Structs/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV27styleViolationsAndRuleTimes5usingSayAA14StyleViolationVG_SaySS2id_Sd4timetGtAA0I7StorageC_tF":{"name":"styleViolationsAndRuleTimes(using:)","abstract":"Computes or retrieves style violations and the time spent executing each rule.
","parent_name":"CollectedLinter"},"Structs/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV7correct5usingSayAA10CorrectionVGAA11RuleStorageC_tF":{"name":"correct(using:)","abstract":"Applies corrections for all rules to this file, returning performed corrections.
","parent_name":"CollectedLinter"},"Structs/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV6format7useTabs11indentWidthySb_SitF":{"name":"format(useTabs:indentWidth:)","abstract":"Formats the file associated with this linter.
","parent_name":"CollectedLinter"},"Structs/Linter.html#/s:18SwiftLintFramework6LinterV4fileAA0aB4FileCvp":{"name":"file","abstract":"The file to lint with this linter.
","parent_name":"Linter"},"Structs/Linter.html#/s:18SwiftLintFramework6LinterV12isCollectingSbvp":{"name":"isCollecting","abstract":"Whether or not this linter will be used to collect information from several files.
","parent_name":"Linter"},"Structs/Linter.html#/s:18SwiftLintFramework6LinterV4file13configuration5cache17compilerArgumentsAcA0aB4FileC_AA13ConfigurationVAA0D5CacheCSgSaySSGtcfc":{"name":"init(file:configuration:cache:compilerArguments:)","abstract":"Creates a Linter by specifying its properties directly.
Returns a linter capable of checking for violations after running each rule’s collection step.
","parent_name":"Linter"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV4codeSSvp":{"name":"code","abstract":"The contents of the example
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV13configurationypSgvp":{"name":"configuration","abstract":"The untyped configuration to apply to the rule, if deviating from the default configuration.","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV20testMultiByteOffsetsSbvp":{"name":"testMultiByteOffsets","abstract":"
Whether the example should be tested by prepending multibyte grapheme clusters
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV11testOnLinuxSbvp":{"name":"testOnLinux","abstract":"Whether the example should be tested on Linux
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV4files12StaticStringVvp":{"name":"file","abstract":"The path to the file where the example was created
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV4lineSuvp":{"name":"line","abstract":"The line in the file where the example was created
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV_13configuration20testMultiByteOffsets0F17WrappingInComment0fjK6String0F14DisableCommand0F7OnLinux4file4line24excludeFromDocumentationACSS_ypSgS5bs06StaticM0VSuSbtcfc":{"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:18SwiftLintFramework7ExampleV4with4codeACSS_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: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:18SwiftLintFramework10CorrectionV15ruleDescriptionAA04RuleF0Vvp":{"name":"ruleDescription","abstract":"The description of the rule for which this correction was applied.
","parent_name":"Correction"},"Structs/Correction.html#/s:18SwiftLintFramework10CorrectionV8locationAA8LocationVvp":{"name":"location","abstract":"The location of the original violation that was corrected.
","parent_name":"Correction"},"Structs/Correction.html#/s:18SwiftLintFramework10CorrectionV18consoleDescriptionSSvp":{"name":"consoleDescription","abstract":"The console-printable description for this correction.
","parent_name":"Correction"},"Structs/Command/Modifier.html#/s:18SwiftLintFramework7CommandV8ModifierO8previousyA2EmF":{"name":"previous","abstract":"The command should only apply to the line preceding its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:18SwiftLintFramework7CommandV8ModifierO4thisyA2EmF":{"name":"this","abstract":"The command should only apply to the same line as its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:18SwiftLintFramework7CommandV8ModifierO4nextyA2EmF":{"name":"next","abstract":"The command should only apply to the line following its definition.
","parent_name":"Modifier"},"Structs/Command/Action.html#/s:18SwiftLintFramework7CommandV6ActionO6enableyA2EmF":{"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:18SwiftLintFramework7CommandV6ActionO7disableyA2EmF":{"name":"disable","abstract":"The rule(s) associated with this command should be disabled by the SwiftLint engine.
","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:18SwiftLintFramework7CommandV6action15ruleIdentifiers4line9character8modifier15trailingCommentA2C6ActionO_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:18SwiftLintFramework7CommandV12actionString4line9characterACSgSS_S2itcfc":{"name":"init(actionString:line:character:)","abstract":"Creates a command based on the specified parameters.
","parent_name":"Command"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV5valueSDySS0deC00D16KitRepresentable_pGvp":{"name":"value","abstract":"The underlying SourceKitten dictionary.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV12substructureSayACGvp":{"name":"substructure","abstract":"The cached substructure for this dictionary. Empty if there is no substructure.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV14expressionKindAA0a10ExpressionH0OSgvp":{"name":"expressionKind","abstract":"The kind of Swift expression represented by this dictionary, if it is an expression.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV15declarationKind0deC00a11DeclarationH0OSgvp":{"name":"declarationKind","abstract":"The kind of Swift declaration represented by this dictionary, if it is a declaration.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV13statementKind0deC009StatementH0OSgvp":{"name":"statementKind","abstract":"The kind of Swift statement represented by this dictionary, if it is a statement.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV13accessibilityAA18AccessControlLevelOSgvp":{"name":"accessibility","abstract":"The accessibility level for this dictionary, if it is a declaration.
","parent_name":"SourceKittenDictionary"},"Structs/Configuration/RulesMode.html#/s:18SwiftLintFramework13ConfigurationV9RulesModeO7defaultyAEShySSG_AGtcAEmF":{"name":"default(disabled:optIn:)","abstract":"The default rules mode, which will enable all rules that aren’t defined as being opt-in","parent_name":"RulesMode"},"Structs/Configuration/RulesMode.html#/s:18SwiftLintFramework13ConfigurationV9RulesModeO4onlyyAEShySSGcAEmF":{"name":"only(_:)","abstract":"
Only enable the rules explicitly listed.
","parent_name":"RulesMode"},"Structs/Configuration/RulesMode.html#/s:18SwiftLintFramework13ConfigurationV9RulesModeO10allEnabledyA2EmF":{"name":"allEnabled","abstract":"Enable all available rules.
","parent_name":"RulesMode"},"Structs/Configuration/IndentationStyle.html#/s:18SwiftLintFramework13ConfigurationV16IndentationStyleO4tabsyA2EmF":{"name":"tabs","abstract":"Swift source code should be indented using tabs.
","parent_name":"IndentationStyle"},"Structs/Configuration/IndentationStyle.html#/s:18SwiftLintFramework13ConfigurationV16IndentationStyleO6spacesyAESi_tcAEmF":{"name":"spaces(count:)","abstract":"Swift source code should be indented using spaces with count spaces per indentation level.
The default indentation style if none is explicitly provided.
","parent_name":"IndentationStyle"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV7defaultACvpZ":{"name":"default","abstract":"The default Configuration resulting from an empty configuration file.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV15defaultFileNameSSvpZ":{"name":"defaultFileName","abstract":"The default file name to look for user-defined configurations.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13includedPathsSaySSGvp":{"name":"includedPaths","abstract":"The paths that should be included when linting
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13excludedPathsSaySSGvp":{"name":"excludedPaths","abstract":"The paths that should be excluded when linting
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV11indentationAC16IndentationStyleOvp":{"name":"indentation","abstract":"The style to use when indenting Swift source code.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV16warningThresholdSiSgvp":{"name":"warningThreshold","abstract":"The threshold for the number of warnings to tolerate before treating the lint as having failed.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV8reporterSSvp":{"name":"reporter","abstract":"The identifier for the Reporter to use to report style violations.
The location of the persisted cache to use with this configuration.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV22allowZeroLintableFilesSbvp":{"name":"allowZeroLintableFiles","abstract":"Allow or disallow SwiftLint to exit successfully when passed only ignored or unlintable files.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV013basedOnCustomD5FilesSbvp":{"name":"basedOnCustomConfigurationFiles","abstract":"This value is true iff the --config parameter was used to specify (a) configuration file(s)","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV5rulesSayAA4Rule_pGvp":{"name":"rules","abstract":"
All rules enabled in this configuration
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13rootDirectorySSvp":{"name":"rootDirectory","abstract":"The root directory is the directory that included & excluded paths relate to.","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV9rulesModeAC05RulesF0Ovp":{"name":"rulesMode","abstract":"
The rules mode used for this configuration.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV18configurationFiles14enableAllRules9cachePath27ignoreParentAndChildConfigs20mockedNetworkResults25useDefaultConfigOnFailureACSaySSG_SbSSSgSbSDyS2SGSbSgtcfc":{"name":"init(configurationFiles:enableAllRules:cachePath:ignoreParentAndChildConfigs:mockedNetworkResults:useDefaultConfigOnFailure:)","abstract":"Creates a Configuration with convenience parameters.
Returns a copy of the current Configuration with its computedCacheDescription property set to the value of","parent_name":"Configuration"},"Structs/Configuration/IndentationStyle.html":{"name":"IndentationStyle","abstract":"
The style of indentation used in a Swift project.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13lintableFiles6inPath12forceExclude15excludeByPrefixSayAA0aB4FileCGSS_S2btF":{"name":"lintableFiles(inPath:forceExclude:excludeByPrefix:)","abstract":"Returns the files that can be linted by SwiftLint in the specified parent path.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV19filterExcludedPaths11fileManager2inSaySSGAA012LintableFileI0_p_AGdtF":{"name":"filterExcludedPaths(fileManager:in:)","abstract":"Returns an array of file paths after removing the excluded paths as defined by this configuration.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV27filterExcludedPathsByPrefix2inSaySSGAFd_tF":{"name":"filterExcludedPathsByPrefix(in:)","abstract":"Returns the file paths that are excluded by this configuration using filtering by absolute path prefix.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13configuration3forAcA0aB4FileC_tF":{"name":"configuration(for:)","abstract":"Returns a new configuration that applies to the specified file by merging the current configuration with any","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV4dict8ruleList14enableAllRules9cachePathACSDySSypG_AA04RuleG0VSbSSSgtKcfc":{"name":"init(dict:ruleList:enableAllRules:cachePath:)","abstract":"
Creates a Configuration value based on the specified parameters.
","parent_name":"Configuration"},"Structs/Configuration/RulesMode.html":{"name":"RulesMode","abstract":"Represents how a Configuration object can be configured with regards to rules.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"Configuration"},"Structs/Configuration.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"Configuration"},"Structs/Configuration.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"Configuration"},"Structs/RuleListDocumentation.html#/s:18SwiftLintFramework21RuleListDocumentationVyAcA0dE0Vcfc":{"name":"init(_:)","abstract":"Creates a RuleListDocumentation instance from a RuleList.
","parent_name":"RuleListDocumentation"},"Structs/RuleListDocumentation.html#/s:18SwiftLintFramework21RuleListDocumentationV5write2toy10Foundation3URLV_tKF":{"name":"write(to:)","abstract":"Write the rule list documentation as markdown files to the specified directory.
","parent_name":"RuleListDocumentation"},"Structs/RuleListDocumentation.html":{"name":"RuleListDocumentation","abstract":"User-facing documentation for a SwiftLint RuleList.
"},"Structs/Configuration.html":{"name":"Configuration","abstract":"The configuration struct for SwiftLint. User-defined in the .swiftlint.yml file, drives the behavior of SwiftLint.
A collection of keys and values as parsed out of SourceKit, with many conveniences for accessing SwiftLint-specific"},"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/Linter.html":{"name":"Linter","abstract":"
Represents a file that can be linted for style violations and corrections after being collected.
"},"Structs/CollectedLinter.html":{"name":"CollectedLinter","abstract":"Represents a file that can compute style violations and corrections for a list of rules.
"},"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/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/Version.html":{"name":"Version","abstract":"A type describing the SwiftLint version.
"},"Structs/YamlParser.html":{"name":"YamlParser","abstract":"An interface for parsing YAML.
"},"Structs/CodeClimateReporter.html":{"name":"CodeClimateReporter","abstract":"Reports violations as a JSON array in Code Climate format.
"},"Structs/GitLabJUnitReporter.html":{"name":"GitLabJUnitReporter","abstract":"Reports violations as JUnit XML supported by GitLab.
"},"Structs/SonarQubeReporter.html":{"name":"SonarQubeReporter","abstract":"Reports violations in SonarQube import format.
"},"Structs/XcodeReporter.html":{"name":"XcodeReporter","abstract":"Reports violations in the format Xcode uses to display in the IDE. (default)
"},"Protocols/ViolationsSyntaxVisitor.html#/s:18SwiftLintFramework23ViolationsSyntaxVisitorP18violationPositionsSay0aE016AbsolutePositionVGvp":{"name":"violationPositions","abstract":"Positions in a source file where violations should be reported.
","parent_name":"ViolationsSyntaxVisitor"},"Protocols/SwiftSyntaxRule.html#/s:18SwiftLintFramework0A10SyntaxRuleP11makeVisitor4fileAA010ViolationsdG0_pSgAA0aB4FileC_tF":{"name":"makeVisitor(file:)","abstract":"Produce a ViolationsSyntaxVisitor for the given file.
Produce a violation for the given file and absolute position.
","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxRule.html#/s:18SwiftLintFramework0A10SyntaxRulePAAE15disabledRegions4fileSay0aD011SourceRangeVGAA0aB4FileC_tF":{"name":"disabledRegions(file:)","abstract":"Returns the source ranges in the specified file where this rule is disabled.
","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxRule.html#/s:18SwiftLintFramework4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"SwiftSyntaxRule"},"Protocols/ViolationsSyntaxRewriter.html#/s:18SwiftLintFramework24ViolationsSyntaxRewriterP19correctionPositionsSay0aE016AbsolutePositionVGvp":{"name":"correctionPositions","abstract":"Positions in a source file where corrections were applied.
","parent_name":"ViolationsSyntaxRewriter"},"Protocols/SwiftSyntaxCorrectableRule.html#/s:18SwiftLintFramework0A21SyntaxCorrectableRuleP12makeRewriter4fileAA010ViolationsdH0_pSgAA0aB4FileC_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:18SwiftLintFramework30SeverityBasedRuleConfigurationPAAE8severityAA09ViolationD0Ovp":{"name":"severity","abstract":"The severity of a rule.
","parent_name":"SeverityBasedRuleConfiguration"},"Protocols/RuleConfiguration.html#/s:18SwiftLintFramework17RuleConfigurationP18consoleDescriptionSSvp":{"name":"consoleDescription","abstract":"A human-readable description for this configuration and its applied values.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:18SwiftLintFramework17RuleConfigurationP5apply13configurationyyp_tKF":{"name":"apply(configuration:)","abstract":"Apply an untyped configuration to the current value.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:18SwiftLintFramework17RuleConfigurationP9isEqualToySbAaB_pF":{"name":"isEqualTo(_:)","abstract":"Whether the specified configuration is equivalent to the current value.
","parent_name":"RuleConfiguration"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework25CollectingCorrectableRuleP7correct4file13collectedInfo17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_SDyAL0nJ0QzGSaySSGtF":{"name":"correct(file:collectedInfo:compilerArguments:)","abstract":"Attempts to correct the violations to this rule in the specified file after collecting file info for all files","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework25CollectingCorrectableRuleP7correct4file13collectedInfoSayAA10CorrectionVGAA0aB4FileC_SDyAK0lJ0QzGtF":{"name":"correct(file:collectedInfo:)","abstract":"
Attempts to correct the violations to this rule in the specified file after collecting file info for all files","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4file5using17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_AA0E7StorageCSaySSGtF":{"name":"correct(file:using:compilerArguments:)","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4file17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_SaySSGtF":{"name":"correct(file:compilerArguments:)","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework14CollectingRuleP8FileInfoQa":{"name":"FileInfo","abstract":"
The kind of information to collect for each file being linted for this rule.
","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework14CollectingRuleP11collectInfo3for17compilerArguments04FileG0QzAA0abK0C_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:18SwiftLintFramework14CollectingRuleP8validate4file13collectedInfoSayAA14StyleViolationVGAA0aB4FileC_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:18SwiftLintFramework4RuleP11collectInfo3for4into17compilerArgumentsyAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"collectInfo(for:into:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework4RuleP8validate4file5using17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"validate(file:using:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework4RuleP8validate4file17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_SaySSGtF":{"name":"validate(file:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/AnalyzerRule.html#/s:18SwiftLintFramework4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"AnalyzerRule"},"Protocols/SubstitutionCorrectableASTRule.html#/s:18SwiftLintFramework30SubstitutionCorrectableASTRuleP15violationRanges2in4kind10dictionarySaySo8_NSRangeVGAA0aB4FileC_8KindTypeQzAA22SourceKittenDictionaryVtF":{"name":"violationRanges(in:kind:dictionary:)","abstract":"
Returns the NSString-based NSRanges to be replaced in the specified file.
Returns the NSString-based NSRanges to be replaced in the specified file.
Returns the substitution to apply for the given range.
","parent_name":"SubstitutionCorrectableRule"},"Protocols/SubstitutionCorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","parent_name":"SubstitutionCorrectableRule"},"Protocols/CorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4file17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_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:18SwiftLintFramework15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","abstract":"Attempts to correct the violations to this rule in the specified file.
","parent_name":"CorrectableRule"},"Protocols/CorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4file5using17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_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/ConfigurationProviderRule.html#/s:18SwiftLintFramework25ConfigurationProviderRuleP0D4TypeQa":{"name":"ConfigurationType","abstract":"
The type of configuration used to configure this rule.
","parent_name":"ConfigurationProviderRule"},"Protocols/ConfigurationProviderRule.html#/s:18SwiftLintFramework25ConfigurationProviderRuleP13configuration0D4TypeQzvp":{"name":"configuration","abstract":"This rule’s configuration.
","parent_name":"ConfigurationProviderRule"},"Protocols/ConfigurationProviderRule.html#/s:18SwiftLintFramework4RuleP13configurationxyp_tKcfc":{"name":"init(configuration:)","parent_name":"ConfigurationProviderRule"},"Protocols/ConfigurationProviderRule.html#/s:18SwiftLintFramework4RuleP9isEqualToySbAaB_pF":{"name":"isEqualTo(_:)","parent_name":"ConfigurationProviderRule"},"Protocols/ConfigurationProviderRule.html#/s:18SwiftLintFramework4RuleP24configurationDescriptionSSvp":{"name":"configurationDescription","parent_name":"ConfigurationProviderRule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP11descriptionAA0D11DescriptionVvpZ":{"name":"description","abstract":"A verbose description of many of this rule’s properties.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP24configurationDescriptionSSvp":{"name":"configurationDescription","abstract":"A description of how this rule has been configured to run.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RulePxycfc":{"name":"init()","abstract":"A default initializer for rules. All rules need to be trivially initializable.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP13configurationxyp_tKcfc":{"name":"init(configuration:)","abstract":"Creates a rule by applying its configuration.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP8validate4file17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_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:18SwiftLintFramework4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_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:18SwiftLintFramework4RuleP9isEqualToySbAaB_pF":{"name":"isEqualTo(_:)","abstract":"Whether or not the specified rule is equivalent to the current rule.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP11collectInfo3for4into17compilerArgumentsyAA0aB4FileC_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/Reporter.html#/s:18SwiftLintFramework8ReporterP10identifierSSvpZ":{"name":"identifier","abstract":"
The unique identifier for this reporter.
","parent_name":"Reporter"},"Protocols/Reporter.html#/s:18SwiftLintFramework8ReporterP10isRealtimeSbvpZ":{"name":"isRealtime","abstract":"Whether or not this reporter can output incrementally as violations are found or if all violations must be","parent_name":"Reporter"},"Protocols/Reporter.html#/s:18SwiftLintFramework8ReporterP14generateReportySSSayAA14StyleViolationVGFZ":{"name":"generateReport(_:)","abstract":"
Return a string with the report for the specified violations.
","parent_name":"Reporter"},"Protocols/ASTRule.html#/s:18SwiftLintFramework7ASTRuleP8KindTypeQa":{"name":"KindType","abstract":"The kind of token being recursed over.
","parent_name":"ASTRule"},"Protocols/ASTRule.html#/s:18SwiftLintFramework7ASTRuleP8validate4file4kind10dictionarySayAA14StyleViolationVGAA0aB4FileC_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:18SwiftLintFramework7ASTRuleP4kind4from8KindTypeQzSgAA22SourceKittenDictionaryV_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/LintableFileManager.html#/s:18SwiftLintFramework19LintableFileManagerP07filesToB06inPath13rootDirectorySaySSGSS_SSSgtF":{"name":"filesToLint(inPath:rootDirectory:)","abstract":"
Returns all files that can be linted in the specified path. If the path is relative, it will be appended to the","parent_name":"LintableFileManager"},"Protocols/LintableFileManager.html#/s:18SwiftLintFramework19LintableFileManagerP16modificationDate03forE6AtPath10Foundation0H0VSgSS_tF":{"name":"modificationDate(forFileAtPath:)","abstract":"
Returns the date when the file at the specified path was last modified. Returns nil if the file cannot be","parent_name":"LintableFileManager"},"Protocols/LintableFileManager.html":{"name":"LintableFileManager","abstract":"
An interface for enumerating files that can be linted by SwiftLint.
"},"Protocols/ASTRule.html":{"name":"ASTRule","abstract":"A rule that leverages the Swift source’s pre-typechecked Abstract Syntax Tree to recurse into the source’s"},"Protocols/Reporter.html":{"name":"Reporter","abstract":"
An interface for reporting violations as strings.
"},"Protocols/Rule.html":{"name":"Rule","abstract":"An executable value that can identify issues (violations) in Swift source code.
"},"Protocols.html#/s:18SwiftLintFramework9OptInRuleP":{"name":"OptInRule","abstract":"A rule that is not enabled by default. Rules conforming to this need to be explicitly enabled by users.
"},"Protocols/ConfigurationProviderRule.html":{"name":"ConfigurationProviderRule","abstract":"A rule that is user-configurable.
"},"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/SubstitutionCorrectableASTRule.html":{"name":"SubstitutionCorrectableASTRule","abstract":"
A SubstitutionCorrectableRule that is also an ASTRule.
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.html#/s:18SwiftLintFramework17AnyCollectingRuleP":{"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/CollectingCorrectableRule.html":{"name":"CollectingCorrectableRule","abstract":"A CollectingRule that is also a CorrectableRule.
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 SwiftSyntax SyntaxRewriter that produces absolute positions where corrections were applied.
A SwiftLint Rule backed by SwiftSyntax that does not use SourceKit requests.
"},"Protocols/ViolationsSyntaxVisitor.html":{"name":"ViolationsSyntaxVisitor","abstract":"A SwiftSyntax SyntaxVisitor that produces absolute positions where violations should be reported.
A thread-safe version of Swift’s standard print().
A thread-safe, newline-terminated version of fputs(..., stderr).
A thread-safe, newline-terminated version of fatalError(...) that doesn’t leak"},"Functions.html#/s:18SwiftLintFramework12reporterFrom10identifierAA8Reporter_pXpSS_tF":{"name":"reporterFrom(identifier:)","abstract":"
Returns the reporter with the specified identifier. Traps if the specified identifier doesn’t correspond to any"},"Extensions/String.html#/s:SS18SwiftLintFrameworkE24absolutePathStandardizedSSyF":{"name":"absolutePathStandardized()","abstract":"
Returns a new string, converting the path to a canonical absolute path.
","parent_name":"String"},"Extensions/String.html#/s:SS18SwiftLintFrameworkE16countOccurrences2ofSiSJ_tF":{"name":"countOccurrences(of:)","abstract":"Count the number of occurrences of the given character in self
If self is a path, this method can be used to get a path expression relative to a root directory
","parent_name":"String"},"Extensions/FileManager.html#/s:18SwiftLintFramework19LintableFileManagerP07filesToB06inPath13rootDirectorySaySSGSS_SSSgtF":{"name":"filesToLint(inPath:rootDirectory:)","parent_name":"FileManager"},"Extensions/FileManager.html#/s:18SwiftLintFramework19LintableFileManagerP16modificationDate03forE6AtPath10Foundation0H0VSgSS_tF":{"name":"modificationDate(forFileAtPath:)","parent_name":"FileManager"},"Extensions/FileManager.html":{"name":"FileManager"},"Extensions/String.html":{"name":"String"},"Enums/ViolationSeverity.html#/s:18SwiftLintFramework17ViolationSeverityO7warningyA2CmF":{"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:18SwiftLintFramework17ViolationSeverityO5erroryA2CmF":{"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/RuleListError.html#/s:18SwiftLintFramework13RuleListErrorO24duplicatedConfigurationsyAcA0D0_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:18SwiftLintFramework8RuleKindO4lintyA2CmF":{"name":"lint","abstract":"Describes rules that validate Swift source conventions.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:18SwiftLintFramework8RuleKindO9idiomaticyA2CmF":{"name":"idiomatic","abstract":"Describes rules that validate common practices in the Swift community.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:18SwiftLintFramework8RuleKindO5styleyA2CmF":{"name":"style","abstract":"Describes rules that validate stylistic choices.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:18SwiftLintFramework8RuleKindO7metricsyA2CmF":{"name":"metrics","abstract":"Describes rules that validate magnitudes or measurements of Swift source.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:18SwiftLintFramework8RuleKindO11performanceyA2CmF":{"name":"performance","abstract":"Describes rules that validate that code patterns with poor performance are avoided.
","parent_name":"RuleKind"},"Enums/RuleIdentifier.html#/s:18SwiftLintFramework14RuleIdentifierO3allyA2CmF":{"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:18SwiftLintFramework14RuleIdentifierO6singleyACSS_tcACmF":{"name":"single(identifier:)","abstract":"
Represents a single SwiftLint rule with the specified identifier.
","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:18SwiftLintFramework14RuleIdentifierO20stringRepresentationSSvp":{"name":"stringRepresentation","abstract":"The spelling of the string for this idenfitier.
","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:18SwiftLintFramework14RuleIdentifierOyACSScfc":{"name":"init(_:)","abstract":"Creates a RuleIdentifier by its string representation.
The configuration didn’t match internal expectations.
","parent_name":"ConfigurationError"},"Enums/ConfigurationError.html#/s:18SwiftLintFramework18ConfigurationErrorO28ambiguousMatchKindParametersyA2CmF":{"name":"ambiguousMatchKindParameters","abstract":"The configuration had both match_kind and excluded_match_kind parameters.
A generic configuration error specified by a string.
","parent_name":"ConfigurationError"},"Enums/ConfigurationError.html#/s:18SwiftLintFramework18ConfigurationErrorO19initialFileNotFoundyACSS_tcACmF":{"name":"initialFileNotFound(path:)","abstract":"The initial configuration file was not found.
","parent_name":"ConfigurationError"},"Enums/AccessControlLevel.html#/s:18SwiftLintFramework18AccessControlLevelO7privateyA2CmF":{"name":"private","abstract":"Accessible by the declaration’s immediate lexical scope.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:18SwiftLintFramework18AccessControlLevelO11fileprivateyA2CmF":{"name":"fileprivate","abstract":"Accessible by the declaration’s same file.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:18SwiftLintFramework18AccessControlLevelO8internalyA2CmF":{"name":"internal","abstract":"Accessible by the declaration’s same module, or modules importing it with the @testable attribute.
Accessible by the declaration’s same program.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:18SwiftLintFramework18AccessControlLevelO4openyA2CmF":{"name":"open","abstract":"Accessible and customizable (via subclassing or overrides) by the declaration’s same program.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"AccessControlLevel"},"Enums/ExecutableInfo.html#/buildID":{"name":"buildID","abstract":"A stable identifier for this executable. Uses the Mach-O header UUID on macOS. Nil on Linux.
","parent_name":"ExecutableInfo"},"Enums/ExecutableInfo.html#/s:18SwiftLintFramework14ExecutableInfoO7buildIDSSSgvpZ":{"name":"buildID","abstract":"A stable identifier for this executable. Uses the Mach-O header UUID on macOS. Nil on Linux.
","parent_name":"ExecutableInfo"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO4callyA2CmF":{"name":"call","abstract":"A call to a named function or closure.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO8argumentyA2CmF":{"name":"argument","abstract":"An argument value for a function or closure.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO5arrayyA2CmF":{"name":"array","abstract":"An Array expression.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO10dictionaryyA2CmF":{"name":"dictionary","abstract":"A Dictionary expression.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO13objectLiteralyA2CmF":{"name":"objectLiteral","abstract":"An object literal expression. https://developer.apple.com/swift/blog/?id=33
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO7closureyA2CmF":{"name":"closure","abstract":"A closure expression. https://docs.swift.org/swift-book/LanguageGuide/Closures.html
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO5tupleyA2CmF":{"name":"tuple","abstract":"A tuple expression. https://docs.swift.org/swift-book/ReferenceManual/Types.html#ID448
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html":{"name":"SwiftExpressionKind","abstract":"The kind of expression for a contiguous set of Swift source tokens.
"},"Enums/ExecutableInfo.html":{"name":"ExecutableInfo","abstract":"Information about this executable.
"},"Enums/AccessControlLevel.html":{"name":"AccessControlLevel","abstract":"The accessibility of a Swift source declaration.
"},"Enums/ConfigurationError.html":{"name":"ConfigurationError","abstract":"All possible configuration errors.
"},"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/ViolationSeverity.html":{"name":"ViolationSeverity","abstract":"The magnitude of a StyleViolation.
The rule list containing all available rules built into SwiftLint.
"},"Classes/RuleStorage.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RuleStorage"},"Classes/RuleStorage.html#/s:18SwiftLintFramework11RuleStorageCACycfc":{"name":"init()","abstract":"Creates a RuleStorage with no initial stored data.
Creates a LinterCache by specifying a SwiftLint configuration and a file manager.
Persists the cache to disk.
","parent_name":"LinterCache"},"Classes/SwiftLintFile.html#/s:18SwiftLintFramework0aB4FileC4fileAC012SourceKittenC00D0C_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:18SwiftLintFramework0aB4FileC20pathDeferringReadingACSS_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:18SwiftLintFramework0aB4FileC8contentsACSS_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:18SwiftLintFramework0aB4FileC8contentsSSvp":{"name":"contents","abstract":"The file’s contents.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:18SwiftLintFramework0aB4FileC10stringView012SourceKittenC006StringF0Vvp":{"name":"stringView","abstract":"A string view into the contents of this file optimized for string manipulation operations.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:18SwiftLintFramework0aB4FileC5linesSay012SourceKittenC04LineVGvp":{"name":"lines","abstract":"The parsed lines for this file’s contents.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:18SwiftLintFramework0aB4FileC15invalidateCacheyyF":{"name":"invalidateCache()","abstract":"Invalidates all cached data for this file.
","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/SwiftLintFile.html":{"name":"SwiftLintFile","abstract":"A unit of Swift source code, either on disk or in memory.
"},"Classes/LinterCache.html":{"name":"LinterCache","abstract":"A persisted cache for storing and retrieving linter results.
"},"Classes/RuleStorage.html":{"name":"RuleStorage","abstract":"A storage mechanism for aggregating the results of CollectingRules.
Reports violations as a newline-separated string of comma-separated values (CSV).
"},"Structs/CheckstyleReporter.html":{"name":"CheckstyleReporter","abstract":"Reports violations as XML conforming to the Checkstyle specification, as defined here:"},"Structs/EmojiReporter.html":{"name":"EmojiReporter","abstract":"
Reports violations in the format that’s both fun and easy to read.
"},"Structs/GitHubActionsLoggingReporter.html":{"name":"GitHubActionsLoggingReporter","abstract":"Reports violations in the format GitHub-hosted virtual machine for Actions can recognize as messages.
"},"Structs/HTMLReporter.html":{"name":"HTMLReporter","abstract":"Reports violations as HTML.
"},"Structs/JSONReporter.html":{"name":"JSONReporter","abstract":"Reports violations as a JSON array.
"},"Structs/JUnitReporter.html":{"name":"JUnitReporter","abstract":"Reports violations as JUnit XML.
"},"Structs/MarkdownReporter.html":{"name":"MarkdownReporter","abstract":"Reports violations as markdown formated (with tables).
"},"rule-directory.html":{"name":"Rule Directory"},"Rules.html":{"name":"Rules"},"Reporters.html":{"name":"Reporters"},"Guides.html":{"name":"Guides","abstract":"The following guides are available globally.
"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally.
"},"Global%20Variables.html":{"name":"Global Variables","abstract":"The following global variables 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.
"},"Functions.html":{"name":"Functions","abstract":"The following functions 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.
"}} \ No newline at end of file +{"Structs/XcodeReporter.html#/s:18SwiftLintFramework8ReporterP10identifierSSvpZ":{"name":"identifier","parent_name":"XcodeReporter"},"Structs/XcodeReporter.html#/s:18SwiftLintFramework8ReporterP10isRealtimeSbvpZ":{"name":"isRealtime","parent_name":"XcodeReporter"},"Structs/XcodeReporter.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"XcodeReporter"},"Structs/XcodeReporter.html#/s:18SwiftLintFramework8ReporterP14generateReportySSSayAA14StyleViolationVGFZ":{"name":"generateReport(_:)","parent_name":"XcodeReporter"},"Structs/SonarQubeReporter.html#/s:18SwiftLintFramework8ReporterP10identifierSSvpZ":{"name":"identifier","parent_name":"SonarQubeReporter"},"Structs/SonarQubeReporter.html#/s:18SwiftLintFramework8ReporterP10isRealtimeSbvpZ":{"name":"isRealtime","parent_name":"SonarQubeReporter"},"Structs/SonarQubeReporter.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"SonarQubeReporter"},"Structs/SonarQubeReporter.html#/s:18SwiftLintFramework8ReporterP14generateReportySSSayAA14StyleViolationVGFZ":{"name":"generateReport(_:)","parent_name":"SonarQubeReporter"},"Structs/GitLabJUnitReporter.html#/s:18SwiftLintFramework8ReporterP10identifierSSvpZ":{"name":"identifier","parent_name":"GitLabJUnitReporter"},"Structs/GitLabJUnitReporter.html#/s:18SwiftLintFramework8ReporterP10isRealtimeSbvpZ":{"name":"isRealtime","parent_name":"GitLabJUnitReporter"},"Structs/GitLabJUnitReporter.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"GitLabJUnitReporter"},"Structs/GitLabJUnitReporter.html#/s:18SwiftLintFramework8ReporterP14generateReportySSSayAA14StyleViolationVGFZ":{"name":"generateReport(_:)","parent_name":"GitLabJUnitReporter"},"Structs/CodeClimateReporter.html#/s:18SwiftLintFramework8ReporterP10identifierSSvpZ":{"name":"identifier","parent_name":"CodeClimateReporter"},"Structs/CodeClimateReporter.html#/s:18SwiftLintFramework8ReporterP10isRealtimeSbvpZ":{"name":"isRealtime","parent_name":"CodeClimateReporter"},"Structs/CodeClimateReporter.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"CodeClimateReporter"},"Structs/CodeClimateReporter.html#/s:18SwiftLintFramework8ReporterP14generateReportySSSayAA14StyleViolationVGFZ":{"name":"generateReport(_:)","parent_name":"CodeClimateReporter"},"Structs/YamlParser.html#/s:18SwiftLintFramework10YamlParserV5parse_3envSDySSypGSS_SDyS2SGtKFZ":{"name":"parse(_:env:)","abstract":"Parses the input YAML string as an untyped dictionary.
","parent_name":"YamlParser"},"Structs/Version.html#/s:18SwiftLintFramework7VersionV5valueSSvp":{"name":"value","abstract":"The string value for this version.
","parent_name":"Version"},"Structs/Version.html#/s:18SwiftLintFramework7VersionV7currentACvpZ":{"name":"current","abstract":"The current SwiftLint version.
","parent_name":"Version"},"Structs/SwiftVersion.html#/s:SY8RawValueQa":{"name":"RawValue","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:SY8rawValue03RawB0Qzvp":{"name":"rawValue","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:SY8rawValuexSg03RawB0Qz_tcfc":{"name":"init(rawValue:)","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV4fiveACvpZ":{"name":"five","abstract":"Swift 5.0.x - https://swift.org/download/#swift-50
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV10fiveDotOneACvpZ":{"name":"fiveDotOne","abstract":"Swift 5.1.x - https://swift.org/download/#swift-51
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV10fiveDotTwoACvpZ":{"name":"fiveDotTwo","abstract":"Swift 5.2.x - https://swift.org/download/#swift-52
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV12fiveDotThreeACvpZ":{"name":"fiveDotThree","abstract":"Swift 5.3.x - https://swift.org/download/#swift-53
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV11fiveDotFourACvpZ":{"name":"fiveDotFour","abstract":"Swift 5.4.x - https://swift.org/download/#swift-54
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV11fiveDotFiveACvpZ":{"name":"fiveDotFive","abstract":"Swift 5.5.x - https://swift.org/download/#swift-55
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV10fiveDotSixACvpZ":{"name":"fiveDotSix","abstract":"Swift 5.6.x - https://swift.org/download/#swift-56
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV12fiveDotSevenACvpZ":{"name":"fiveDotSeven","abstract":"Swift 5.7.x - https://swift.org/download/#swift-57
","parent_name":"SwiftVersion"},"Structs/SwiftVersion.html#/s:18SwiftLintFramework0A7VersionV7currentACvpZ":{"name":"current","abstract":"The current detected Swift compiler version, based on the currently accessible SourceKit version.
","parent_name":"SwiftVersion"},"Structs/SwiftLintSyntaxToken.html#/s:18SwiftLintFramework0aB11SyntaxTokenV5value012SourceKittenC00dE0Vvp":{"name":"value","abstract":"The raw SyntaxToken obtained by SourceKitten.
The syntax kind associated with is token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:18SwiftLintFramework0aB11SyntaxTokenV5valueAC012SourceKittenC00dE0V_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:18SwiftLintFramework0aB11SyntaxTokenV6offset012SourceKittenC09ByteCountVvp":{"name":"offset","abstract":"The starting byte offset in a source file for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxToken.html#/s:18SwiftLintFramework0aB11SyntaxTokenV6length012SourceKittenC09ByteCountVvp":{"name":"length","abstract":"The length in bytes for this token.
","parent_name":"SwiftLintSyntaxToken"},"Structs/SwiftLintSyntaxMap.html#/s:18SwiftLintFramework0aB9SyntaxMapV5value012SourceKittenC00dE0Vvp":{"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:18SwiftLintFramework0aB9SyntaxMapV5valueAC012SourceKittenC00dE0V_tcfc":{"name":"init(value:)","abstract":"Creates a SwiftLintSyntaxMap from the raw SyntaxMap obtained by SourceKitten.
The identifier of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV15ruleDescriptionSSvp":{"name":"ruleDescription","abstract":"The description of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV8ruleNameSSvp":{"name":"ruleName","abstract":"The name of the rule that generated this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV8severityAA0E8SeverityOvp":{"name":"severity","abstract":"The severity of this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV8locationAA8LocationVvp":{"name":"location","abstract":"The location of this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV6reasonSSvp":{"name":"reason","abstract":"The justification for this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV11descriptionSSvp":{"name":"description","abstract":"A printable description for this violation.
","parent_name":"StyleViolation"},"Structs/StyleViolation.html#/s:18SwiftLintFramework14StyleViolationV15ruleDescription8severity8location6reasonAcA04RuleG0V_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:18SwiftLintFramework13RuleParameterV5valuexvp":{"name":"value","abstract":"The value to configure the rule.
","parent_name":"RuleParameter"},"Structs/RuleParameter.html#/s:18SwiftLintFramework13RuleParameterV8severity5valueACyxGAA17ViolationSeverityO_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:18SwiftLintFramework8RuleListV5rulesAcA0D0_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:18SwiftLintFramework15RuleDescriptionV4nameSSvp":{"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:18SwiftLintFramework15RuleDescriptionV11descriptionSSvp":{"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:18SwiftLintFramework15RuleDescriptionV4kindAA0D4KindOvp":{"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:18SwiftLintFramework15RuleDescriptionV18triggeringExamplesSayAA7ExampleVGvp":{"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:18SwiftLintFramework15RuleDescriptionV11correctionsSDyAA7ExampleVAFGvp":{"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:18SwiftLintFramework15RuleDescriptionV17deprecatedAliasesShySSGvp":{"name":"deprecatedAliases","abstract":"
Any previous iteration of the rule’s identifier that was previously shipped with SwiftLint.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:18SwiftLintFramework15RuleDescriptionV03minA7VersionAA0aG0Vvp":{"name":"minSwiftVersion","abstract":"The oldest version of the Swift compiler supported by this rule.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:18SwiftLintFramework15RuleDescriptionV18requiresFileOnDiskSbvp":{"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:18SwiftLintFramework15RuleDescriptionV07consoleE0SSvp":{"name":"consoleDescription","abstract":"
The console-printable string for this description.
","parent_name":"RuleDescription"},"Structs/RuleDescription.html#/s:18SwiftLintFramework15RuleDescriptionV14allIdentifiersSaySSGvp":{"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:18SwiftLintFramework15RuleDescriptionV10identifier4name11description4kind03minA7Version21nonTriggeringExamples010triggeringN011corrections17deprecatedAliases18requiresFileOnDiskACSS_S2SAA0D4KindOAA0aK0VSayAA7ExampleVGATSDyA2SGShySSGSbtcfc":{"name":"init(identifier:name:description:kind:minSwiftVersion:nonTriggeringExamples:triggeringExamples:corrections:deprecatedAliases:requiresFileOnDisk:)","abstract":"Creates a RuleDescription by specifying all its properties directly.
The location describing the start of the region. All locations that are less than this value","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV3endAA8LocationVvp":{"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:18SwiftLintFramework6RegionV23disabledRuleIdentifiersShyAA0F10IdentifierOGvp":{"name":"disabledRuleIdentifiers","abstract":"
All SwiftLint rule identifiers that are disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV5start3end23disabledRuleIdentifiersAcA8LocationV_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:18SwiftLintFramework6RegionV8containsySbAA8LocationVF":{"name":"contains(_:)","abstract":"Whether the specific location is contained in this region.
","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV13isRuleEnabledySbAA0F0_pF":{"name":"isRuleEnabled(_:)","abstract":"Whether the specified rule is enabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV14isRuleDisabledySbAA0F0_pF":{"name":"isRuleDisabled(_:)","abstract":"Whether the specified rule is disabled in this region.
","parent_name":"Region"},"Structs/Region.html#/s:18SwiftLintFramework6RegionV26deprecatedAliasesDisabling4ruleShySSGAA4Rule_p_tF":{"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:18SwiftLintFramework8LocationV4fileSSSgvp":{"name":"file","abstract":"
The file path on disk for this location.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV4lineSiSgvp":{"name":"line","abstract":"The line offset in the file for this location. 1-indexed.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV9characterSiSgvp":{"name":"character","abstract":"The character offset in the file for this location. 1-indexed.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV11descriptionSSvp":{"name":"description","abstract":"A lossless printable description of this location.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV12relativeFileSSSgvp":{"name":"relativeFile","abstract":"The file path for this location relative to the current working directory.
","parent_name":"Location"},"Structs/Location.html#/s:18SwiftLintFramework8LocationV4file4line9characterACSSSg_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:18SwiftLintFramework8LocationV4file8positionAcA0aB4FileC_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:18SwiftLintFramework8LocationV4file15characterOffsetAcA0aB4FileC_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/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV4fileAA0aB4FileCvp":{"name":"file","abstract":"
The file to lint with this linter.
","parent_name":"CollectedLinter"},"Structs/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV15styleViolations5usingSayAA14StyleViolationVGAA11RuleStorageC_tF":{"name":"styleViolations(using:)","abstract":"Computes or retrieves style violations.
","parent_name":"CollectedLinter"},"Structs/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV27styleViolationsAndRuleTimes5usingSayAA14StyleViolationVG_SaySS2id_Sd4timetGtAA0I7StorageC_tF":{"name":"styleViolationsAndRuleTimes(using:)","abstract":"Computes or retrieves style violations and the time spent executing each rule.
","parent_name":"CollectedLinter"},"Structs/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV7correct5usingSayAA10CorrectionVGAA11RuleStorageC_tF":{"name":"correct(using:)","abstract":"Applies corrections for all rules to this file, returning performed corrections.
","parent_name":"CollectedLinter"},"Structs/CollectedLinter.html#/s:18SwiftLintFramework15CollectedLinterV6format7useTabs11indentWidthySb_SitF":{"name":"format(useTabs:indentWidth:)","abstract":"Formats the file associated with this linter.
","parent_name":"CollectedLinter"},"Structs/Linter.html#/s:18SwiftLintFramework6LinterV4fileAA0aB4FileCvp":{"name":"file","abstract":"The file to lint with this linter.
","parent_name":"Linter"},"Structs/Linter.html#/s:18SwiftLintFramework6LinterV12isCollectingSbvp":{"name":"isCollecting","abstract":"Whether or not this linter will be used to collect information from several files.
","parent_name":"Linter"},"Structs/Linter.html#/s:18SwiftLintFramework6LinterV4file13configuration5cache17compilerArgumentsAcA0aB4FileC_AA13ConfigurationVAA0D5CacheCSgSaySSGtcfc":{"name":"init(file:configuration:cache:compilerArguments:)","abstract":"Creates a Linter by specifying its properties directly.
Returns a linter capable of checking for violations after running each rule’s collection step.
","parent_name":"Linter"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV4codeSSvp":{"name":"code","abstract":"The contents of the example
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV13configurationypSgvp":{"name":"configuration","abstract":"The untyped configuration to apply to the rule, if deviating from the default configuration.","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV20testMultiByteOffsetsSbvp":{"name":"testMultiByteOffsets","abstract":"
Whether the example should be tested by prepending multibyte grapheme clusters
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV11testOnLinuxSbvp":{"name":"testOnLinux","abstract":"Whether the example should be tested on Linux
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV4files12StaticStringVvp":{"name":"file","abstract":"The path to the file where the example was created
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV4lineSuvp":{"name":"line","abstract":"The line in the file where the example was created
","parent_name":"Example"},"Structs/Example.html#/s:18SwiftLintFramework7ExampleV_13configuration20testMultiByteOffsets0F17WrappingInComment0fjK6String0F14DisableCommand0F7OnLinux4file4line24excludeFromDocumentationACSS_ypSgS5bs06StaticM0VSuSbtcfc":{"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:18SwiftLintFramework7ExampleV4with4codeACSS_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: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:18SwiftLintFramework10CorrectionV15ruleDescriptionAA04RuleF0Vvp":{"name":"ruleDescription","abstract":"The description of the rule for which this correction was applied.
","parent_name":"Correction"},"Structs/Correction.html#/s:18SwiftLintFramework10CorrectionV8locationAA8LocationVvp":{"name":"location","abstract":"The location of the original violation that was corrected.
","parent_name":"Correction"},"Structs/Correction.html#/s:18SwiftLintFramework10CorrectionV18consoleDescriptionSSvp":{"name":"consoleDescription","abstract":"The console-printable description for this correction.
","parent_name":"Correction"},"Structs/Command/Modifier.html#/s:18SwiftLintFramework7CommandV8ModifierO8previousyA2EmF":{"name":"previous","abstract":"The command should only apply to the line preceding its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:18SwiftLintFramework7CommandV8ModifierO4thisyA2EmF":{"name":"this","abstract":"The command should only apply to the same line as its definition.
","parent_name":"Modifier"},"Structs/Command/Modifier.html#/s:18SwiftLintFramework7CommandV8ModifierO4nextyA2EmF":{"name":"next","abstract":"The command should only apply to the line following its definition.
","parent_name":"Modifier"},"Structs/Command/Action.html#/s:18SwiftLintFramework7CommandV6ActionO6enableyA2EmF":{"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:18SwiftLintFramework7CommandV6ActionO7disableyA2EmF":{"name":"disable","abstract":"The rule(s) associated with this command should be disabled by the SwiftLint engine.
","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:18SwiftLintFramework7CommandV6action15ruleIdentifiers4line9character8modifier15trailingCommentA2C6ActionO_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:18SwiftLintFramework7CommandV12actionString4line9characterACSgSS_S2itcfc":{"name":"init(actionString:line:character:)","abstract":"Creates a command based on the specified parameters.
","parent_name":"Command"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV5valueSDySS0deC00D16KitRepresentable_pGvp":{"name":"value","abstract":"The underlying SourceKitten dictionary.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV12substructureSayACGvp":{"name":"substructure","abstract":"The cached substructure for this dictionary. Empty if there is no substructure.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV14expressionKindAA0a10ExpressionH0OSgvp":{"name":"expressionKind","abstract":"The kind of Swift expression represented by this dictionary, if it is an expression.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV15declarationKind0deC00a11DeclarationH0OSgvp":{"name":"declarationKind","abstract":"The kind of Swift declaration represented by this dictionary, if it is a declaration.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV13statementKind0deC009StatementH0OSgvp":{"name":"statementKind","abstract":"The kind of Swift statement represented by this dictionary, if it is a statement.
","parent_name":"SourceKittenDictionary"},"Structs/SourceKittenDictionary.html#/s:18SwiftLintFramework22SourceKittenDictionaryV13accessibilityAA18AccessControlLevelOSgvp":{"name":"accessibility","abstract":"The accessibility level for this dictionary, if it is a declaration.
","parent_name":"SourceKittenDictionary"},"Structs/Configuration/RulesMode.html#/s:18SwiftLintFramework13ConfigurationV9RulesModeO7defaultyAEShySSG_AGtcAEmF":{"name":"default(disabled:optIn:)","abstract":"The default rules mode, which will enable all rules that aren’t defined as being opt-in","parent_name":"RulesMode"},"Structs/Configuration/RulesMode.html#/s:18SwiftLintFramework13ConfigurationV9RulesModeO4onlyyAEShySSGcAEmF":{"name":"only(_:)","abstract":"
Only enable the rules explicitly listed.
","parent_name":"RulesMode"},"Structs/Configuration/RulesMode.html#/s:18SwiftLintFramework13ConfigurationV9RulesModeO10allEnabledyA2EmF":{"name":"allEnabled","abstract":"Enable all available rules.
","parent_name":"RulesMode"},"Structs/Configuration/IndentationStyle.html#/s:18SwiftLintFramework13ConfigurationV16IndentationStyleO4tabsyA2EmF":{"name":"tabs","abstract":"Swift source code should be indented using tabs.
","parent_name":"IndentationStyle"},"Structs/Configuration/IndentationStyle.html#/s:18SwiftLintFramework13ConfigurationV16IndentationStyleO6spacesyAESi_tcAEmF":{"name":"spaces(count:)","abstract":"Swift source code should be indented using spaces with count spaces per indentation level.
The default indentation style if none is explicitly provided.
","parent_name":"IndentationStyle"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV7defaultACvpZ":{"name":"default","abstract":"The default Configuration resulting from an empty configuration file.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV15defaultFileNameSSvpZ":{"name":"defaultFileName","abstract":"The default file name to look for user-defined configurations.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13includedPathsSaySSGvp":{"name":"includedPaths","abstract":"The paths that should be included when linting
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13excludedPathsSaySSGvp":{"name":"excludedPaths","abstract":"The paths that should be excluded when linting
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV11indentationAC16IndentationStyleOvp":{"name":"indentation","abstract":"The style to use when indenting Swift source code.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV16warningThresholdSiSgvp":{"name":"warningThreshold","abstract":"The threshold for the number of warnings to tolerate before treating the lint as having failed.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV8reporterSSvp":{"name":"reporter","abstract":"The identifier for the Reporter to use to report style violations.
The location of the persisted cache to use with this configuration.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV22allowZeroLintableFilesSbvp":{"name":"allowZeroLintableFiles","abstract":"Allow or disallow SwiftLint to exit successfully when passed only ignored or unlintable files.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV013basedOnCustomD5FilesSbvp":{"name":"basedOnCustomConfigurationFiles","abstract":"This value is true iff the --config parameter was used to specify (a) configuration file(s)","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV5rulesSayAA4Rule_pGvp":{"name":"rules","abstract":"
All rules enabled in this configuration
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13rootDirectorySSvp":{"name":"rootDirectory","abstract":"The root directory is the directory that included & excluded paths relate to.","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV9rulesModeAC05RulesF0Ovp":{"name":"rulesMode","abstract":"
The rules mode used for this configuration.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV18configurationFiles14enableAllRules9cachePath27ignoreParentAndChildConfigs20mockedNetworkResults25useDefaultConfigOnFailureACSaySSG_SbSSSgSbSDyS2SGSbSgtcfc":{"name":"init(configurationFiles:enableAllRules:cachePath:ignoreParentAndChildConfigs:mockedNetworkResults:useDefaultConfigOnFailure:)","abstract":"Creates a Configuration with convenience parameters.
Returns a copy of the current Configuration with its computedCacheDescription property set to the value of","parent_name":"Configuration"},"Structs/Configuration/IndentationStyle.html":{"name":"IndentationStyle","abstract":"
The style of indentation used in a Swift project.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13lintableFiles6inPath12forceExclude15excludeByPrefixSayAA0aB4FileCGSS_S2btF":{"name":"lintableFiles(inPath:forceExclude:excludeByPrefix:)","abstract":"Returns the files that can be linted by SwiftLint in the specified parent path.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV19filterExcludedPaths11fileManager2inSaySSGAA012LintableFileI0_p_AGdtF":{"name":"filterExcludedPaths(fileManager:in:)","abstract":"Returns an array of file paths after removing the excluded paths as defined by this configuration.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV27filterExcludedPathsByPrefix2inSaySSGAFd_tF":{"name":"filterExcludedPathsByPrefix(in:)","abstract":"Returns the file paths that are excluded by this configuration using filtering by absolute path prefix.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV13configuration3forAcA0aB4FileC_tF":{"name":"configuration(for:)","abstract":"Returns a new configuration that applies to the specified file by merging the current configuration with any","parent_name":"Configuration"},"Structs/Configuration.html#/s:18SwiftLintFramework13ConfigurationV4dict8ruleList14enableAllRules9cachePathACSDySSypG_AA04RuleG0VSbSSSgtKcfc":{"name":"init(dict:ruleList:enableAllRules:cachePath:)","abstract":"
Creates a Configuration value based on the specified parameters.
","parent_name":"Configuration"},"Structs/Configuration/RulesMode.html":{"name":"RulesMode","abstract":"Represents how a Configuration object can be configured with regards to rules.
","parent_name":"Configuration"},"Structs/Configuration.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"Configuration"},"Structs/Configuration.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"Configuration"},"Structs/Configuration.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"Configuration"},"Structs/RuleListDocumentation.html#/s:18SwiftLintFramework21RuleListDocumentationVyAcA0dE0Vcfc":{"name":"init(_:)","abstract":"Creates a RuleListDocumentation instance from a RuleList.
","parent_name":"RuleListDocumentation"},"Structs/RuleListDocumentation.html#/s:18SwiftLintFramework21RuleListDocumentationV5write2toy10Foundation3URLV_tKF":{"name":"write(to:)","abstract":"Write the rule list documentation as markdown files to the specified directory.
","parent_name":"RuleListDocumentation"},"Structs/RuleListDocumentation.html":{"name":"RuleListDocumentation","abstract":"User-facing documentation for a SwiftLint RuleList.
"},"Structs/Configuration.html":{"name":"Configuration","abstract":"The configuration struct for SwiftLint. User-defined in the .swiftlint.yml file, drives the behavior of SwiftLint.
A collection of keys and values as parsed out of SourceKit, with many conveniences for accessing SwiftLint-specific"},"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/Linter.html":{"name":"Linter","abstract":"
Represents a file that can be linted for style violations and corrections after being collected.
"},"Structs/CollectedLinter.html":{"name":"CollectedLinter","abstract":"Represents a file that can compute style violations and corrections for a list of rules.
"},"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/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/Version.html":{"name":"Version","abstract":"A type describing the SwiftLint version.
"},"Structs/YamlParser.html":{"name":"YamlParser","abstract":"An interface for parsing YAML.
"},"Structs/CodeClimateReporter.html":{"name":"CodeClimateReporter","abstract":"Reports violations as a JSON array in Code Climate format.
"},"Structs/GitLabJUnitReporter.html":{"name":"GitLabJUnitReporter","abstract":"Reports violations as JUnit XML supported by GitLab.
"},"Structs/SonarQubeReporter.html":{"name":"SonarQubeReporter","abstract":"Reports violations in SonarQube import format.
"},"Structs/XcodeReporter.html":{"name":"XcodeReporter","abstract":"Reports violations in the format Xcode uses to display in the IDE. (default)
"},"Protocols/SwiftSyntaxRule.html#/s:18SwiftLintFramework0A10SyntaxRuleP11makeVisitor4fileAA010ViolationsdG0CSgAA0aB4FileC_tF":{"name":"makeVisitor(file:)","abstract":"Produce a ViolationsSyntaxVisitor for the given file.
Produce a violation for the given file and absolute position.
","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxRule.html#/s:18SwiftLintFramework0A10SyntaxRulePAAE15disabledRegions4fileSay0aD011SourceRangeVGAA0aB4FileC_tF":{"name":"disabledRegions(file:)","abstract":"Returns the source ranges in the specified file where this rule is disabled.
","parent_name":"SwiftSyntaxRule"},"Protocols/SwiftSyntaxRule.html#/s:18SwiftLintFramework4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"SwiftSyntaxRule"},"Protocols/ViolationsSyntaxRewriter.html#/s:18SwiftLintFramework24ViolationsSyntaxRewriterP19correctionPositionsSay0aE016AbsolutePositionVGvp":{"name":"correctionPositions","abstract":"Positions in a source file where corrections were applied.
","parent_name":"ViolationsSyntaxRewriter"},"Protocols/SwiftSyntaxCorrectableRule.html#/s:18SwiftLintFramework0A21SyntaxCorrectableRuleP12makeRewriter4fileAA010ViolationsdH0_pSgAA0aB4FileC_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:18SwiftLintFramework30SeverityBasedRuleConfigurationPAAE8severityAA09ViolationD0Ovp":{"name":"severity","abstract":"The severity of a rule.
","parent_name":"SeverityBasedRuleConfiguration"},"Protocols/RuleConfiguration.html#/s:18SwiftLintFramework17RuleConfigurationP18consoleDescriptionSSvp":{"name":"consoleDescription","abstract":"A human-readable description for this configuration and its applied values.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:18SwiftLintFramework17RuleConfigurationP5apply13configurationyyp_tKF":{"name":"apply(configuration:)","abstract":"Apply an untyped configuration to the current value.
","parent_name":"RuleConfiguration"},"Protocols/RuleConfiguration.html#/s:18SwiftLintFramework17RuleConfigurationP9isEqualToySbAaB_pF":{"name":"isEqualTo(_:)","abstract":"Whether the specified configuration is equivalent to the current value.
","parent_name":"RuleConfiguration"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework25CollectingCorrectableRuleP7correct4file13collectedInfo17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_SDyAL0nJ0QzGSaySSGtF":{"name":"correct(file:collectedInfo:compilerArguments:)","abstract":"Attempts to correct the violations to this rule in the specified file after collecting file info for all files","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework25CollectingCorrectableRuleP7correct4file13collectedInfoSayAA10CorrectionVGAA0aB4FileC_SDyAK0lJ0QzGtF":{"name":"correct(file:collectedInfo:)","abstract":"
Attempts to correct the violations to this rule in the specified file after collecting file info for all files","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4file5using17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_AA0E7StorageCSaySSGtF":{"name":"correct(file:using:compilerArguments:)","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingCorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4file17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_SaySSGtF":{"name":"correct(file:compilerArguments:)","parent_name":"CollectingCorrectableRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework14CollectingRuleP8FileInfoQa":{"name":"FileInfo","abstract":"
The kind of information to collect for each file being linted for this rule.
","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework14CollectingRuleP11collectInfo3for17compilerArguments04FileG0QzAA0abK0C_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:18SwiftLintFramework14CollectingRuleP8validate4file13collectedInfoSayAA14StyleViolationVGAA0aB4FileC_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:18SwiftLintFramework4RuleP11collectInfo3for4into17compilerArgumentsyAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"collectInfo(for:into:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework4RuleP8validate4file5using17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_AA0D7StorageCSaySSGtF":{"name":"validate(file:using:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"CollectingRule"},"Protocols/CollectingRule.html#/s:18SwiftLintFramework4RuleP8validate4file17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_SaySSGtF":{"name":"validate(file:compilerArguments:)","parent_name":"CollectingRule"},"Protocols/AnalyzerRule.html#/s:18SwiftLintFramework4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_tF":{"name":"validate(file:)","parent_name":"AnalyzerRule"},"Protocols/SubstitutionCorrectableASTRule.html#/s:18SwiftLintFramework30SubstitutionCorrectableASTRuleP15violationRanges2in4kind10dictionarySaySo8_NSRangeVGAA0aB4FileC_8KindTypeQzAA22SourceKittenDictionaryVtF":{"name":"violationRanges(in:kind:dictionary:)","abstract":"
Returns the NSString-based NSRanges to be replaced in the specified file.
Returns the NSString-based NSRanges to be replaced in the specified file.
Returns the substitution to apply for the given range.
","parent_name":"SubstitutionCorrectableRule"},"Protocols/SubstitutionCorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","parent_name":"SubstitutionCorrectableRule"},"Protocols/CorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4file17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_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:18SwiftLintFramework15CorrectableRuleP7correct4fileSayAA10CorrectionVGAA0aB4FileC_tF":{"name":"correct(file:)","abstract":"Attempts to correct the violations to this rule in the specified file.
","parent_name":"CorrectableRule"},"Protocols/CorrectableRule.html#/s:18SwiftLintFramework15CorrectableRuleP7correct4file5using17compilerArgumentsSayAA10CorrectionVGAA0aB4FileC_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/ConfigurationProviderRule.html#/s:18SwiftLintFramework25ConfigurationProviderRuleP0D4TypeQa":{"name":"ConfigurationType","abstract":"
The type of configuration used to configure this rule.
","parent_name":"ConfigurationProviderRule"},"Protocols/ConfigurationProviderRule.html#/s:18SwiftLintFramework25ConfigurationProviderRuleP13configuration0D4TypeQzvp":{"name":"configuration","abstract":"This rule’s configuration.
","parent_name":"ConfigurationProviderRule"},"Protocols/ConfigurationProviderRule.html#/s:18SwiftLintFramework4RuleP13configurationxyp_tKcfc":{"name":"init(configuration:)","parent_name":"ConfigurationProviderRule"},"Protocols/ConfigurationProviderRule.html#/s:18SwiftLintFramework4RuleP9isEqualToySbAaB_pF":{"name":"isEqualTo(_:)","parent_name":"ConfigurationProviderRule"},"Protocols/ConfigurationProviderRule.html#/s:18SwiftLintFramework4RuleP24configurationDescriptionSSvp":{"name":"configurationDescription","parent_name":"ConfigurationProviderRule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP11descriptionAA0D11DescriptionVvpZ":{"name":"description","abstract":"A verbose description of many of this rule’s properties.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP24configurationDescriptionSSvp":{"name":"configurationDescription","abstract":"A description of how this rule has been configured to run.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RulePxycfc":{"name":"init()","abstract":"A default initializer for rules. All rules need to be trivially initializable.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP13configurationxyp_tKcfc":{"name":"init(configuration:)","abstract":"Creates a rule by applying its configuration.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP8validate4file17compilerArgumentsSayAA14StyleViolationVGAA0aB4FileC_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:18SwiftLintFramework4RuleP8validate4fileSayAA14StyleViolationVGAA0aB4FileC_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:18SwiftLintFramework4RuleP9isEqualToySbAaB_pF":{"name":"isEqualTo(_:)","abstract":"Whether or not the specified rule is equivalent to the current rule.
","parent_name":"Rule"},"Protocols/Rule.html#/s:18SwiftLintFramework4RuleP11collectInfo3for4into17compilerArgumentsyAA0aB4FileC_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/Reporter.html#/s:18SwiftLintFramework8ReporterP10identifierSSvpZ":{"name":"identifier","abstract":"
The unique identifier for this reporter.
","parent_name":"Reporter"},"Protocols/Reporter.html#/s:18SwiftLintFramework8ReporterP10isRealtimeSbvpZ":{"name":"isRealtime","abstract":"Whether or not this reporter can output incrementally as violations are found or if all violations must be","parent_name":"Reporter"},"Protocols/Reporter.html#/s:18SwiftLintFramework8ReporterP14generateReportySSSayAA14StyleViolationVGFZ":{"name":"generateReport(_:)","abstract":"
Return a string with the report for the specified violations.
","parent_name":"Reporter"},"Protocols/ASTRule.html#/s:18SwiftLintFramework7ASTRuleP8KindTypeQa":{"name":"KindType","abstract":"The kind of token being recursed over.
","parent_name":"ASTRule"},"Protocols/ASTRule.html#/s:18SwiftLintFramework7ASTRuleP8validate4file4kind10dictionarySayAA14StyleViolationVGAA0aB4FileC_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:18SwiftLintFramework7ASTRuleP4kind4from8KindTypeQzSgAA22SourceKittenDictionaryV_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/LintableFileManager.html#/s:18SwiftLintFramework19LintableFileManagerP07filesToB06inPath13rootDirectorySaySSGSS_SSSgtF":{"name":"filesToLint(inPath:rootDirectory:)","abstract":"
Returns all files that can be linted in the specified path. If the path is relative, it will be appended to the","parent_name":"LintableFileManager"},"Protocols/LintableFileManager.html#/s:18SwiftLintFramework19LintableFileManagerP16modificationDate03forE6AtPath10Foundation0H0VSgSS_tF":{"name":"modificationDate(forFileAtPath:)","abstract":"
Returns the date when the file at the specified path was last modified. Returns nil if the file cannot be","parent_name":"LintableFileManager"},"Protocols/LintableFileManager.html":{"name":"LintableFileManager","abstract":"
An interface for enumerating files that can be linted by SwiftLint.
"},"Protocols/ASTRule.html":{"name":"ASTRule","abstract":"A rule that leverages the Swift source’s pre-typechecked Abstract Syntax Tree to recurse into the source’s"},"Protocols/Reporter.html":{"name":"Reporter","abstract":"
An interface for reporting violations as strings.
"},"Protocols/Rule.html":{"name":"Rule","abstract":"An executable value that can identify issues (violations) in Swift source code.
"},"Protocols.html#/s:18SwiftLintFramework9OptInRuleP":{"name":"OptInRule","abstract":"A rule that is not enabled by default. Rules conforming to this need to be explicitly enabled by users.
"},"Protocols/ConfigurationProviderRule.html":{"name":"ConfigurationProviderRule","abstract":"A rule that is user-configurable.
"},"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/SubstitutionCorrectableASTRule.html":{"name":"SubstitutionCorrectableASTRule","abstract":"
A SubstitutionCorrectableRule that is also an ASTRule.
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.html#/s:18SwiftLintFramework17AnyCollectingRuleP":{"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/CollectingCorrectableRule.html":{"name":"CollectingCorrectableRule","abstract":"A CollectingRule that is also a CorrectableRule.
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 SwiftSyntax SyntaxRewriter that produces absolute positions where corrections were applied.
A SwiftLint Rule backed by SwiftSyntax that does not use SourceKit requests.
"},"Functions.html#/s:18SwiftLintFramework11queuedPrintyyxlF":{"name":"queuedPrint(_:)","abstract":"A thread-safe version of Swift’s standard print().
A thread-safe, newline-terminated version of fputs(..., stderr).
A thread-safe, newline-terminated version of fatalError(...) that doesn’t leak"},"Functions.html#/s:18SwiftLintFramework12reporterFrom10identifierAA8Reporter_pXpSS_tF":{"name":"reporterFrom(identifier:)","abstract":"
Returns the reporter with the specified identifier. Traps if the specified identifier doesn’t correspond to any"},"Extensions/String.html#/s:SS18SwiftLintFrameworkE24absolutePathStandardizedSSyF":{"name":"absolutePathStandardized()","abstract":"
Returns a new string, converting the path to a canonical absolute path.
","parent_name":"String"},"Extensions/String.html#/s:SS18SwiftLintFrameworkE16countOccurrences2ofSiSJ_tF":{"name":"countOccurrences(of:)","abstract":"Count the number of occurrences of the given character in self
If self is a path, this method can be used to get a path expression relative to a root directory
","parent_name":"String"},"Extensions/FileManager.html#/s:18SwiftLintFramework19LintableFileManagerP07filesToB06inPath13rootDirectorySaySSGSS_SSSgtF":{"name":"filesToLint(inPath:rootDirectory:)","parent_name":"FileManager"},"Extensions/FileManager.html#/s:18SwiftLintFramework19LintableFileManagerP16modificationDate03forE6AtPath10Foundation0H0VSgSS_tF":{"name":"modificationDate(forFileAtPath:)","parent_name":"FileManager"},"Extensions/FileManager.html":{"name":"FileManager"},"Extensions/String.html":{"name":"String"},"Enums/ViolationSeverity.html#/s:18SwiftLintFramework17ViolationSeverityO7warningyA2CmF":{"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:18SwiftLintFramework17ViolationSeverityO5erroryA2CmF":{"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/RuleListError.html#/s:18SwiftLintFramework13RuleListErrorO24duplicatedConfigurationsyAcA0D0_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:18SwiftLintFramework8RuleKindO4lintyA2CmF":{"name":"lint","abstract":"Describes rules that validate Swift source conventions.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:18SwiftLintFramework8RuleKindO9idiomaticyA2CmF":{"name":"idiomatic","abstract":"Describes rules that validate common practices in the Swift community.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:18SwiftLintFramework8RuleKindO5styleyA2CmF":{"name":"style","abstract":"Describes rules that validate stylistic choices.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:18SwiftLintFramework8RuleKindO7metricsyA2CmF":{"name":"metrics","abstract":"Describes rules that validate magnitudes or measurements of Swift source.
","parent_name":"RuleKind"},"Enums/RuleKind.html#/s:18SwiftLintFramework8RuleKindO11performanceyA2CmF":{"name":"performance","abstract":"Describes rules that validate that code patterns with poor performance are avoided.
","parent_name":"RuleKind"},"Enums/RuleIdentifier.html#/s:18SwiftLintFramework14RuleIdentifierO3allyA2CmF":{"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:18SwiftLintFramework14RuleIdentifierO6singleyACSS_tcACmF":{"name":"single(identifier:)","abstract":"
Represents a single SwiftLint rule with the specified identifier.
","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:18SwiftLintFramework14RuleIdentifierO20stringRepresentationSSvp":{"name":"stringRepresentation","abstract":"The spelling of the string for this idenfitier.
","parent_name":"RuleIdentifier"},"Enums/RuleIdentifier.html#/s:18SwiftLintFramework14RuleIdentifierOyACSScfc":{"name":"init(_:)","abstract":"Creates a RuleIdentifier by its string representation.
The configuration didn’t match internal expectations.
","parent_name":"ConfigurationError"},"Enums/ConfigurationError.html#/s:18SwiftLintFramework18ConfigurationErrorO28ambiguousMatchKindParametersyA2CmF":{"name":"ambiguousMatchKindParameters","abstract":"The configuration had both match_kind and excluded_match_kind parameters.
A generic configuration error specified by a string.
","parent_name":"ConfigurationError"},"Enums/ConfigurationError.html#/s:18SwiftLintFramework18ConfigurationErrorO19initialFileNotFoundyACSS_tcACmF":{"name":"initialFileNotFound(path:)","abstract":"The initial configuration file was not found.
","parent_name":"ConfigurationError"},"Enums/AccessControlLevel.html#/s:18SwiftLintFramework18AccessControlLevelO7privateyA2CmF":{"name":"private","abstract":"Accessible by the declaration’s immediate lexical scope.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:18SwiftLintFramework18AccessControlLevelO11fileprivateyA2CmF":{"name":"fileprivate","abstract":"Accessible by the declaration’s same file.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:18SwiftLintFramework18AccessControlLevelO8internalyA2CmF":{"name":"internal","abstract":"Accessible by the declaration’s same module, or modules importing it with the @testable attribute.
Accessible by the declaration’s same program.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:18SwiftLintFramework18AccessControlLevelO4openyA2CmF":{"name":"open","abstract":"Accessible and customizable (via subclassing or overrides) by the declaration’s same program.
","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"AccessControlLevel"},"Enums/AccessControlLevel.html#/s:SL1loiySbx_xtFZ":{"name":"<(_:_:)","parent_name":"AccessControlLevel"},"Enums/ExecutableInfo.html#/buildID":{"name":"buildID","abstract":"A stable identifier for this executable. Uses the Mach-O header UUID on macOS. Nil on Linux.
","parent_name":"ExecutableInfo"},"Enums/ExecutableInfo.html#/s:18SwiftLintFramework14ExecutableInfoO7buildIDSSSgvpZ":{"name":"buildID","abstract":"A stable identifier for this executable. Uses the Mach-O header UUID on macOS. Nil on Linux.
","parent_name":"ExecutableInfo"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO4callyA2CmF":{"name":"call","abstract":"A call to a named function or closure.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO8argumentyA2CmF":{"name":"argument","abstract":"An argument value for a function or closure.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO5arrayyA2CmF":{"name":"array","abstract":"An Array expression.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO10dictionaryyA2CmF":{"name":"dictionary","abstract":"A Dictionary expression.
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO13objectLiteralyA2CmF":{"name":"objectLiteral","abstract":"An object literal expression. https://developer.apple.com/swift/blog/?id=33
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO7closureyA2CmF":{"name":"closure","abstract":"A closure expression. https://docs.swift.org/swift-book/LanguageGuide/Closures.html
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html#/s:18SwiftLintFramework0A14ExpressionKindO5tupleyA2CmF":{"name":"tuple","abstract":"A tuple expression. https://docs.swift.org/swift-book/ReferenceManual/Types.html#ID448
","parent_name":"SwiftExpressionKind"},"Enums/SwiftExpressionKind.html":{"name":"SwiftExpressionKind","abstract":"The kind of expression for a contiguous set of Swift source tokens.
"},"Enums/ExecutableInfo.html":{"name":"ExecutableInfo","abstract":"Information about this executable.
"},"Enums/AccessControlLevel.html":{"name":"AccessControlLevel","abstract":"The accessibility of a Swift source declaration.
"},"Enums/ConfigurationError.html":{"name":"ConfigurationError","abstract":"All possible configuration errors.
"},"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/ViolationSeverity.html":{"name":"ViolationSeverity","abstract":"The magnitude of a StyleViolation.
The rule list containing all available rules built into SwiftLint.
"},"Classes/ViolationsSyntaxVisitor.html#/s:18SwiftLintFramework23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE09ActorDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:18SwiftLintFramework23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE09ClassDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:18SwiftLintFramework23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE08EnumDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:18SwiftLintFramework23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE013ExtensionDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:18SwiftLintFramework23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE012FunctionDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:18SwiftLintFramework23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE012ProtocolDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/ViolationsSyntaxVisitor.html#/s:18SwiftLintFramework23ViolationsSyntaxVisitorC5visity0aE00eF12ContinueKindOAE010StructDeclE0VF":{"name":"visit(_:)","parent_name":"ViolationsSyntaxVisitor"},"Classes/RuleStorage.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"RuleStorage"},"Classes/RuleStorage.html#/s:18SwiftLintFramework11RuleStorageCACycfc":{"name":"init()","abstract":"Creates a RuleStorage with no initial stored data.
Creates a LinterCache by specifying a SwiftLint configuration and a file manager.
Persists the cache to disk.
","parent_name":"LinterCache"},"Classes/SwiftLintFile.html#/s:18SwiftLintFramework0aB4FileC4fileAC012SourceKittenC00D0C_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:18SwiftLintFramework0aB4FileC20pathDeferringReadingACSS_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:18SwiftLintFramework0aB4FileC8contentsACSS_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:18SwiftLintFramework0aB4FileC8contentsSSvp":{"name":"contents","abstract":"The file’s contents.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:18SwiftLintFramework0aB4FileC10stringView012SourceKittenC006StringF0Vvp":{"name":"stringView","abstract":"A string view into the contents of this file optimized for string manipulation operations.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:18SwiftLintFramework0aB4FileC5linesSay012SourceKittenC04LineVGvp":{"name":"lines","abstract":"The parsed lines for this file’s contents.
","parent_name":"SwiftLintFile"},"Classes/SwiftLintFile.html#/s:18SwiftLintFramework0aB4FileC15invalidateCacheyyF":{"name":"invalidateCache()","abstract":"Invalidates all cached data for this file.
","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/SwiftLintFile.html":{"name":"SwiftLintFile","abstract":"A unit of Swift source code, either on disk or in memory.
"},"Classes/LinterCache.html":{"name":"LinterCache","abstract":"A persisted cache for storing and retrieving linter results.
"},"Classes/RuleStorage.html":{"name":"RuleStorage","abstract":"A storage mechanism for aggregating the results of CollectingRules.
A SwiftSyntax SyntaxVisitor that produces absolute positions where violations should be reported.
Reports violations as a newline-separated string of comma-separated values (CSV).
"},"Structs/CheckstyleReporter.html":{"name":"CheckstyleReporter","abstract":"Reports violations as XML conforming to the Checkstyle specification, as defined here:"},"Structs/EmojiReporter.html":{"name":"EmojiReporter","abstract":"
Reports violations in the format that’s both fun and easy to read.
"},"Structs/GitHubActionsLoggingReporter.html":{"name":"GitHubActionsLoggingReporter","abstract":"Reports violations in the format GitHub-hosted virtual machine for Actions can recognize as messages.
"},"Structs/HTMLReporter.html":{"name":"HTMLReporter","abstract":"Reports violations as HTML.
"},"Structs/JSONReporter.html":{"name":"JSONReporter","abstract":"Reports violations as a JSON array.
"},"Structs/JUnitReporter.html":{"name":"JUnitReporter","abstract":"Reports violations as JUnit XML.
"},"Structs/MarkdownReporter.html":{"name":"MarkdownReporter","abstract":"Reports violations as markdown formated (with tables).
"},"rule-directory.html":{"name":"Rule Directory"},"Rules.html":{"name":"Rules"},"Reporters.html":{"name":"Reporters"},"Guides.html":{"name":"Guides","abstract":"The following guides are available globally.
"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally.
"},"Global%20Variables.html":{"name":"Global Variables","abstract":"The following global variables 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.
"},"Functions.html":{"name":"Functions","abstract":"The following functions 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.
"}} \ No newline at end of file diff --git a/self_binding.html b/self_binding.html index 6918ca1e7..8a7be9e1b 100644 --- a/self_binding.html +++ b/self_binding.html @@ -104,6 +104,9 @@print([foo {
- var sum = 0
- for i in 1...5 { sum += i }
- return sum
-
-}, foo {
- var mul = 1
- for i in 1...5 { mul *= i }
- return mul
-}])
-
-do {
- print("x is 5")
-}
-
do {
print("x is 5")
}
@@ -378,16 +363,31 @@
1
])
+print([foo {
+ var sum = 0
+ for i in 1...5 { sum += i }
+ return sum
+
+}, foo {
+ var mul = 1
+ for i in 1...5 { mul *= i }
+ return mul
+}])
+
+func foo() {
+ run(5) { x in
+ print(x)
+ }
+}
+
[
1,
2,
3
]
-func foo() {
- run(5) { x in
- print(x)
- }
+do {
+ print("x is 5")
}
[1, 2].map { $0 }.filter { true }
@@ -421,23 +421,6 @@
print("x is 5")
↓
-}
-
-print([foo {
- var sum = 0
- for i in 1...5 { sum += i }
- return sum
-
-}, foo {
- var mul = 1
- for i in 1...5 { mul *= i }
- return mul
-↓
-}])
-
-do {
- print("x is 5")
-↓
}
do {
@@ -457,6 +440,25 @@
↓
])
+print([foo {
+ var sum = 0
+ for i in 1...5 { sum += i }
+ return sum
+
+}, foo {
+ var mul = 1
+ for i in 1...5 { mul *= i }
+ return mul
+↓
+}])
+
+func foo() {
+ run(5) { x in
+ print(x)
+ }
+↓
+}
+
[
1,
2,
@@ -464,10 +466,8 @@
↓
]
-func foo() {
- run(5) { x in
- print(x)
- }
+do {
+ print("x is 5")
↓
}
diff --git a/vertical_whitespace_opening_braces.html b/vertical_whitespace_opening_braces.html
index 0a4559f0a..da4dc54c1 100644
--- a/vertical_whitespace_opening_braces.html
+++ b/vertical_whitespace_opening_braces.html
@@ -104,6 +104,9 @@
SwiftLintFile
+
+ ViolationsSyntaxVisitor
+