Persists the cache to disk.
+Throws
+ Throws if the linter cache doesn’t have alocation value, if the cache couldn’t be serialized, or if
+ the contents couldn’t be written to disk.
+
+A new String.
The reporter type.
+All style violations to the rule’s expectations.
+
+
+ dictionary
+
+ |
+
+
+
+ The |
+
The kind from the specified dictionary, if one was found.
All style violations to the rule’s expectations.
+All corrections that were applied.
+All corrections that were applied.
+The collected file information.
+The collected file information.
+All style violations to the rule’s expectations.
+All style violations to the rule’s expectations.
+All corrections that were applied.
@@ -441,7 +441,7 @@All corrections that were applied.
@@ -526,8 +526,12 @@ and returns all corrections that were applied. +All corrections that were applied.
+Creates a rule by applying its configuration.
Throws
- Throws if the configuration didn’t match the expected format. +Throws if the configuration didn’t match the expected format.
+
+ configuration
+
+ |
+
+
+
+ The untyped configuration value to apply. + |
+
All style violations to the rule’s expectations.
+All style violations to the rule’s expectations.
+
+
+ rule
+
+ |
+
+
+
+ The |
+
Whether or not the specified rule is equivalent to the current rule.
+All style violations to the rule’s expectations.
+Apply an untyped configuration to the current value.
Throws
- Throws if the configuration is not in the expected format. +Throws if the configuration is not in the expected format.
+
+ configuration
+
+ |
+
+
+
+ The untyped configuration value to apply. + |
+
+
+ ruleConfiguration
+
+ |
+
+
+
+ The rule configuration to compare against. + |
+
Whether the specified configuration is equivalent to the current value.
+
+
+ file
+
+ |
+
+
+
+ The file in which to find ranges of violations for this rule. + |
+
+
+ kind
+
+ |
+
+
+
+ The kind of token being recursed over. + |
+
+
+ dictionary
+
+ |
+
+
+
+ The dicttionary for an AST subset to validate. + |
+
The NSString-based NSRanges to be replaced in the specified file.
+
+ file
+
+ |
+
+
+
+ The file in which to find ranges of violations for this rule. + |
+
The NSString-based NSRanges to be replaced in the specified file.
+
+ violationRange
+
+ |
+
+
+
+ The NSString-based |
+
+
+ file
+
+ |
+
+
+
+ The file in which the violation should be replaced. + |
+
The range of the correction and its contents, if one could be computed.
+
+
+ storage
+
+ |
+
+
+
+ The storage object containing all collected info. + |
+
All style violations found by this linter.
+
+
+ storage
+
+ |
+
+
+
+ The storage object containing all collected info. + |
+
All style violations found by this linter, and the time spent executing each rule.
+
+
+ storage
+
+ |
+
+
+
+ The storage object containing all collected info. + |
+
All corrections that were applied.
+The character offset within the line in the source file where this command is - defined.
+ defined.
+
+ rulesMode
+
+ |
+
+
+
+ The |
+
+
+ included
+
+ |
+
+
+
+ Included paths to lint. + |
+
+
+ excluded
+
+ |
+
+
+
+ Excluded paths to not lint. + |
+
+
+ warningThreshold
+
+ |
+
+
+
+ The threshold for the number of warnings to tolerate before treating the + lint as having failed. + |
+
+
+ reporter
+
+ |
+
+
+
+ The identifier for the |
+
+
+ ruleList
+
+ |
+
+
+
+ All rules that should be accessible to this configuration. + |
+
+
+ configuredRules
+
+ |
+
+
+
+ The rules with their own configurations already applied. + |
+
+
+ swiftlintVersion
+
+ |
+
+
+
+ The SwiftLint version defined in this configuration. + |
+
+
+ cachePath
+
+ |
+
+
+
+ The location of the persisted cache to use whith this configuration. + |
+
+
+ indentation
+
+ |
+
+
+
+ The style to use when indenting Swift source code. + |
+
+
+ customRulesIdentifiers
+
+ |
+
+
+
+ All custom rule identifiers defined in the configuration. + |
+
+
+ path
+
+ |
+
+
+
+ The path on disk to the configuration file. + |
+
+
+ rootPath
+
+ |
+
+
+
+ The root directory to search for nested configurations. + |
+
+
+ optional
+
+ |
+
+
+
+ If false, the initializer will trap if the file isn’t found. + |
+
+
+ quiet
+
+ |
+
+
+
+ If false, a message will be logged to stderr when the configuration file is + loaded. + |
+
+
+ enableAllRules
+
+ |
+
+
+
+ Enable all available rules. + |
+
+
+ cachePath
+
+ |
+
+
+
+ The location of the persisted cache to use whith this configuration. + |
+
+
+ customRulesIdentifiers
+
+ |
+
+
+
+ All custom rule identifiers defined in the configuration. + |
+
A new Configuration value.
+ customRulesIdentifiers
+
+ All custom rule identifiers defined in the configuration.
+
+
+ storage
+
+ |
+
+
+
+ The storage object where collected info should be saved. + |
+
A linter capable of checking for violations after running each rule’s collection step.
+True if the specific location is contained in this region.
+True if the specified rule is enabled in this region.
+True if the specified rule is disabled in this region.
+Deprecated rule aliases.
+AnalyzerRule
+
+ Parameters
+
+
+
+
+
+ identifier
+
+
+
+
+ Sets the description’s identifier property.
+
+
+
+
+
+
+ name
+
+
+
+
+ Sets the description’s name property.
+
+
+
+
+
+
+ description
+
+
+
+
+ Sets the description’s description property.
+
+
+
+
+
+
+ kind
+
+
+
+
+ Sets the description’s kind property.
+
+
+
+
+
+
+ minSwiftVersion
+
+
+
+
+ Sets the description’s minSwiftVersion property.
+
+
+
+
+
+
+ nonTriggeringExamples
+
+
+
+
+ Sets the description’s nonTriggeringExamples property.
+
+
+
+
+
+
+ triggeringExamples
+
+
+
+
+ Sets the description’s triggeringExamples property.
+
+
+
+
+
+
+ corrections
+
+
+
+
+ Sets the description’s corrections property.
+
+
+
+
+
+
+ deprecatedAliases
+
+
+
+
+ Sets the description’s deprecatedAliases property.
+
+
+
+
+
+
+ requiresFileOnDisk
+
+
+
+
+ Sets the description’s requiresFileOnDisk property.
+
+
+
+
+
+
@@ -774,7 +901,7 @@ conforming to AnalyzerRule
diff --git a/Structs/RuleListDocumentation.html b/Structs/RuleListDocumentation.html
index 7431766e0..95302d521 100644
--- a/Structs/RuleListDocumentation.html
+++ b/Structs/RuleListDocumentation.html
@@ -384,6 +384,11 @@
Write the rule list documentation as markdown files to the specified directory.
+
+ Throws
+ Throws if the files could not be written to.
+
+
@@ -414,7 +419,7 @@
diff --git a/Structs/SwiftLintSyntaxMap.html b/Structs/SwiftLintSyntaxMap.html
index e9f1f7e47..ef8674a2f 100644
--- a/Structs/SwiftLintSyntaxMap.html
+++ b/Structs/SwiftLintSyntaxMap.html
@@ -396,10 +396,6 @@
Creates a SwiftLintSyntaxMap from the raw SyntaxMap obtained by SourceKitten.
-
-- arameter value: The raw
SyntaxMap obtained by SourceKitten.
-
-
Declaration
@@ -409,6 +405,25 @@
+
+ Parameters
+
+
+
+
+
+ value
+
+
+
+
+ The raw SyntaxMap obtained by SourceKitten.
+
+
+
+
+
+
diff --git a/Structs/YamlParser.html b/Structs/YamlParser.html
index 62125276b..f3f8e6204 100644
--- a/Structs/YamlParser.html
+++ b/Structs/YamlParser.html
@@ -335,6 +335,11 @@
Parses the input YAML string as an untyped dictionary.
+
+ Throws
+ Throws if the yaml string provided could not be parsed.
+
+
@@ -377,8 +382,12 @@
+
+ Return Value
+ The parsed YAML as an untyped dictionary.
+
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Classes.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Classes.html
index eaf06247e..2d8cf0228 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Classes.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Classes.html
@@ -373,7 +373,7 @@
@@ -404,7 +404,7 @@
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Classes/LinterCache.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Classes/LinterCache.html
index df73dfb2e..e9fa674b4 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Classes/LinterCache.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Classes/LinterCache.html
@@ -396,6 +396,12 @@
Persists the cache to disk.
+
+ Throws
+ Throws if the linter cache doesn’t have a location value, if the cache couldn’t be serialized, or if
+ the contents couldn’t be written to disk.
+
+
@@ -407,7 +413,7 @@
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Extensions/String.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Extensions/String.html
index fa9e2aeb9..795423735 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Extensions/String.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Extensions/String.html
@@ -344,8 +344,12 @@
+
+ Return Value
+ A new String.
+
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Functions.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Functions.html
index c23c07dec..47d66faeb 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Functions.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Functions.html
@@ -488,8 +488,12 @@ known reporters.
+
+ Return Value
+ The reporter type.
+
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols.html
index 986652e14..7be900b8b 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols.html
@@ -373,7 +373,7 @@ structure, validating the rule recursively in nested source bodies.
@@ -435,7 +435,7 @@ structure, validating the rule recursively in nested source bodies.
@@ -465,7 +465,7 @@ structure, validating the rule recursively in nested source bodies.
@@ -495,7 +495,7 @@ structure, validating the rule recursively in nested source bodies.
@@ -526,7 +526,7 @@ structure, validating the rule recursively in nested source bodies.
@@ -557,7 +557,7 @@ structure, validating the rule recursively in nested source bodies.
@@ -589,7 +589,7 @@ updated content.
@@ -620,7 +620,7 @@ updated content.
@@ -650,7 +650,7 @@ updated content.
@@ -682,7 +682,7 @@ static analysis than syntactic checks.
@@ -725,7 +725,7 @@ static analysis than syntactic checks.
@@ -756,7 +756,7 @@ static analysis than syntactic checks.
@@ -787,7 +787,7 @@ static analysis than syntactic checks.
@@ -818,7 +818,7 @@ static analysis than syntactic checks.
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/ASTRule.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/ASTRule.html
index 2a95fd3de..0a06fc2b8 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/ASTRule.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/ASTRule.html
@@ -420,8 +420,12 @@ expectations.
+
+ Return Value
+ All style violations to the rule’s expectations.
+
@@ -450,8 +454,32 @@ expectations.
+
+ Parameters
+
+
+
+
+
+ dictionary
+
+
+
+
+ The SourceKittenDictionary representing the source structure from which to extract the
+ kind.
+
+
+
+
+
+
+
+ Return Value
+ The kind from the specified dictionary, if one was found.
+
@@ -483,7 +511,7 @@ expectations.
@@ -547,8 +575,12 @@ expectations.
+
+ Return Value
+ All style violations to the rule’s expectations.
+
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/AnalyzerRule.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/AnalyzerRule.html
index 54ed8998c..e5df190b4 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/AnalyzerRule.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/AnalyzerRule.html
@@ -349,7 +349,7 @@ static analysis than syntactic checks.
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/CollectingCorrectableRule.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/CollectingCorrectableRule.html
index 009af8ea5..a953f2c7f 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/CollectingCorrectableRule.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/CollectingCorrectableRule.html
@@ -401,8 +401,12 @@ and returns all corrections that were applied.
+
+ Return Value
+ All corrections that were applied.
+
@@ -468,8 +472,12 @@ and returns all corrections that were applied.
+
+ Return Value
+ All corrections that were applied.
+
@@ -514,7 +522,7 @@ and returns all corrections that were applied.
@@ -546,7 +554,7 @@ and returns all corrections that were applied.
@@ -578,7 +586,7 @@ and returns all corrections that were applied.
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/CollectingRule.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/CollectingRule.html
index 533a0543f..0b9152142 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/CollectingRule.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/CollectingRule.html
@@ -346,7 +346,7 @@
@@ -413,8 +413,12 @@
+
+ Return Value
+ The collected file information.
+
@@ -462,8 +466,12 @@
+
+ Return Value
+ The collected file information.
+
@@ -543,8 +551,12 @@ expectations.
+
+ Return Value
+ All style violations to the rule’s expectations.
+
@@ -605,8 +617,12 @@ expectations.
+
+ Return Value
+ All style violations to the rule’s expectations.
+
@@ -651,7 +667,7 @@ expectations.
@@ -683,7 +699,7 @@ expectations.
@@ -715,7 +731,7 @@ expectations.
@@ -747,7 +763,7 @@ expectations.
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/ConfigurationProviderRule.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/ConfigurationProviderRule.html
index bebd56dad..85d331236 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/ConfigurationProviderRule.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/ConfigurationProviderRule.html
@@ -346,7 +346,7 @@
@@ -376,7 +376,7 @@
@@ -421,7 +421,7 @@
@@ -453,7 +453,7 @@
@@ -485,7 +485,7 @@
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/CorrectableRule.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/CorrectableRule.html
index 358ed056c..75729e5cf 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/CorrectableRule.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/CorrectableRule.html
@@ -388,7 +388,7 @@
All corrections that were applied.
@@ -441,7 +441,7 @@
All corrections that were applied.
@@ -526,8 +526,12 @@ and returns all corrections that were applied.
+
+ Return Value
+ All corrections that were applied.
+
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/Rule.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/Rule.html
index e38df41d6..5a44ca955 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/Rule.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/Rule.html
@@ -427,7 +427,7 @@
Creates a rule by applying its configuration.
Throws
- Throws if the configuration didn’t match the expected format.
+ Throws if the configuration didn’t match the expected format.
@@ -440,8 +440,27 @@
+
+ Parameters
+
+
+
+
+
+ configuration
+
+
+
+
+ The untyped configuration value to apply.
+
+
+
+
+
+
@@ -508,8 +527,12 @@
+
+ Return Value
+ All style violations to the rule’s expectations.
+
@@ -557,8 +580,12 @@
+
+ Return Value
+ All style violations to the rule’s expectations.
+
@@ -594,8 +621,31 @@
+
+ Parameters
+
+
+
+
+
+ rule
+
+
+
+
+ The rule value to compare against.
+
+
+
+
+
+
+
+ Return Value
+ Whether or not the specified rule is equivalent to the current rule.
+
@@ -680,7 +730,7 @@
@@ -765,8 +815,12 @@ expectations.
+
+ Return Value
+ All style violations to the rule’s expectations.
+
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/RuleConfiguration.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/RuleConfiguration.html
index 61650857b..4e80f2b2d 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/RuleConfiguration.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/RuleConfiguration.html
@@ -367,7 +367,7 @@
Apply an untyped configuration to the current value.
Throws
- Throws if the configuration is not in the expected format.
+ Throws if the configuration is not in the expected format.
@@ -380,8 +380,27 @@
+
+ Parameters
+
+
+
+
+
+ configuration
+
+
+
+
+ The untyped configuration value to apply.
+
+
+
+
+
+
@@ -410,8 +429,31 @@
+
+ Parameters
+
+
+
+
+
+ ruleConfiguration
+
+
+
+
+ The rule configuration to compare against.
+
+
+
+
+
+
+
+ Return Value
+ Whether the specified configuration is equivalent to the current value.
+
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/SubstitutionCorrectableASTRule.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/SubstitutionCorrectableASTRule.html
index 15e981c5e..4ca79c0ab 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/SubstitutionCorrectableASTRule.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/SubstitutionCorrectableASTRule.html
@@ -345,8 +345,55 @@
+
+ Parameters
+
+
+
+
+
+ file
+
+
+
+
+ The file in which to find ranges of violations for this rule.
+
+
+
+
+
+
+ kind
+
+
+
+
+ The kind of token being recursed over.
+
+
+
+
+
+
+ dictionary
+
+
+
+
+ The dicttionary for an AST subset to validate.
+
+
+
+
+
+
+
+ Return Value
+ The NSString-based NSRanges to be replaced in the specified file.
+
@@ -378,7 +425,7 @@
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/SubstitutionCorrectableRule.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/SubstitutionCorrectableRule.html
index 711b51df7..fdeea2439 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/SubstitutionCorrectableRule.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Protocols/SubstitutionCorrectableRule.html
@@ -346,8 +346,31 @@ updated content.
+
+ Parameters
+
+
+
+
+
+ file
+
+
+
+
+ The file in which to find ranges of violations for this rule.
+
+
+
+
+
+
+
+ Return Value
+ The NSString-based NSRanges to be replaced in the specified file.
+
@@ -376,8 +399,43 @@ updated content.
+
+ Parameters
+
+
+
+
+
+ violationRange
+
+
+
+
+ The NSString-based NSRange of the violation that should be replaced.
+
+
+
+
+
+
+ file
+
+
+
+
+ The file in which the violation should be replaced.
+
+
+
+
+
+
+
+ Return Value
+ The range of the correction and its contents, if one could be computed.
+
@@ -409,7 +467,7 @@ updated content.
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs.html
index 76d18dc3f..a3c478991 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs.html
@@ -341,7 +341,7 @@
@@ -372,7 +372,7 @@
@@ -435,7 +435,7 @@ values.
@@ -497,7 +497,7 @@ values.
@@ -530,7 +530,7 @@ values.
@@ -592,7 +592,7 @@ values.
@@ -623,7 +623,7 @@ values.
@@ -747,7 +747,7 @@ values.
@@ -884,7 +884,7 @@ values.
@@ -946,7 +946,7 @@ values.
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/CollectedLinter.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/CollectedLinter.html
index 1f7ec7e19..4f0a3e8af 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/CollectedLinter.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/CollectedLinter.html
@@ -348,7 +348,7 @@
@@ -377,8 +377,31 @@
+
+ Parameters
+
+
+
+
+
+ storage
+
+
+
+
+ The storage object containing all collected info.
+
+
+
+
+
+
+
+ Return Value
+ All style violations found by this linter.
+
@@ -408,8 +431,31 @@
+
+ Parameters
+
+
+
+
+
+ storage
+
+
+
+
+ The storage object containing all collected info.
+
+
+
+
+
+
+
+ Return Value
+ All style violations found by this linter, and the time spent executing each rule.
+
@@ -438,8 +484,31 @@
+
+ Parameters
+
+
+
+
+
+ storage
+
+
+
+
+ The storage object containing all collected info.
+
+
+
+
+
+
+
+ Return Value
+ All corrections that were applied.
+
@@ -500,7 +569,7 @@
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/Command.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/Command.html
index c13f30a48..bc936b004 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/Command.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/Command.html
@@ -555,7 +555,7 @@
The character offset within the line in the source file where this command is
- defined.
+ defined.
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/Configuration.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/Configuration.html
index eeca51f7b..566c7bb7d 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/Configuration.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/Configuration.html
@@ -754,8 +754,148 @@
+
+ Parameters
+
+
+
+
+
+ rulesMode
+
+
+
+
+ The RulesMode for this configuration.
+
+
+
+
+
+
+ included
+
+
+
+
+ Included paths to lint.
+
+
+
+
+
+
+ excluded
+
+
+
+
+ Excluded paths to not lint.
+
+
+
+
+
+
+ warningThreshold
+
+
+
+
+ The threshold for the number of warnings to tolerate before treating the
+ lint as having failed.
+
+
+
+
+
+
+ reporter
+
+
+
+
+ The identifier for the Reporter to use to report style violations.
+
+
+
+
+
+
+ ruleList
+
+
+
+
+ All rules that should be accessible to this configuration.
+
+
+
+
+
+
+ configuredRules
+
+
+
+
+ The rules with their own configurations already applied.
+
+
+
+
+
+
+ swiftlintVersion
+
+
+
+
+ The SwiftLint version defined in this configuration.
+
+
+
+
+
+
+ cachePath
+
+
+
+
+ The location of the persisted cache to use whith this configuration.
+
+
+
+
+
+
+ indentation
+
+
+
+
+ The style to use when indenting Swift source code.
+
+
+
+
+
+
+ customRulesIdentifiers
+
+
+
+
+ All custom rule identifiers defined in the configuration.
+
+
+
+
+
+
@@ -786,8 +926,100 @@
+
+ Parameters
+
+
+
+
+
+ path
+
+
+
+
+ The path on disk to the configuration file.
+
+
+
+
+
+
+ rootPath
+
+
+
+
+ The root directory to search for nested configurations.
+
+
+
+
+
+
+ optional
+
+
+
+
+ If false, the initializer will trap if the file isn’t found.
+
+
+
+
+
+
+ quiet
+
+
+
+
+ If false, a message will be logged to stderr when the configuration file is
+ loaded.
+
+
+
+
+
+
+ enableAllRules
+
+
+
+
+ Enable all available rules.
+
+
+
+
+
+
+ cachePath
+
+
+
+
+ The location of the persisted cache to use whith this configuration.
+
+
+
+
+
+
+ customRulesIdentifiers
+
+
+
+
+ All custom rule identifiers defined in the configuration.
+
+
+
+
+
+
@@ -829,7 +1061,7 @@
@@ -872,8 +1104,12 @@
+
+ Return Value
+ A new Configuration value.
+
@@ -1174,11 +1410,23 @@ child configurations in the directory inheritance graph present until the level
+
+
+
+ customRulesIdentifiers
+
+
+
+
+ All custom rule identifiers defined in the configuration.
+
+
+
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/Linter.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/Linter.html
index 9449544e3..581bdbbbe 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/Linter.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/Linter.html
@@ -491,8 +491,31 @@
+
+ Parameters
+
+
+
+
+
+ storage
+
+
+
+
+ The storage object where collected info should be saved.
+
+
+
+
+
+
+
+ Return Value
+ A linter capable of checking for violations after running each rule’s collection step.
+
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/Region.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/Region.html
index 8b702d946..558617c3d 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/Region.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/Region.html
@@ -529,8 +529,12 @@
+
+ Return Value
+ True if the specific location is contained in this region.
+
@@ -578,8 +582,12 @@
+
+ Return Value
+ True if the specified rule is enabled in this region.
+
@@ -627,8 +635,12 @@
+
+ Return Value
+ True if the specified rule is disabled in this region.
+
@@ -677,8 +689,12 @@ Returns the empty set if the rule isn’t disabled in this region.
+
+ Return Value
+ Deprecated rule aliases.
+
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/RuleDescription.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/RuleDescription.html
index 52bcb734b..fcf1fe7fb 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/RuleDescription.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/RuleDescription.html
@@ -731,8 +731,135 @@ conforming to AnalyzerRule
+
+ Parameters
+
+
+
+
+
+ identifier
+
+
+
+
+ Sets the description’s identifier property.
+
+
+
+
+
+
+ name
+
+
+
+
+ Sets the description’s name property.
+
+
+
+
+
+
+ description
+
+
+
+
+ Sets the description’s description property.
+
+
+
+
+
+
+ kind
+
+
+
+
+ Sets the description’s kind property.
+
+
+
+
+
+
+ minSwiftVersion
+
+
+
+
+ Sets the description’s minSwiftVersion property.
+
+
+
+
+
+
+ nonTriggeringExamples
+
+
+
+
+ Sets the description’s nonTriggeringExamples property.
+
+
+
+
+
+
+ triggeringExamples
+
+
+
+
+ Sets the description’s triggeringExamples property.
+
+
+
+
+
+
+ corrections
+
+
+
+
+ Sets the description’s corrections property.
+
+
+
+
+
+
+ deprecatedAliases
+
+
+
+
+ Sets the description’s deprecatedAliases property.
+
+
+
+
+
+
+ requiresFileOnDisk
+
+
+
+
+ Sets the description’s requiresFileOnDisk property.
+
+
+
+
+
+
@@ -774,7 +901,7 @@ conforming to AnalyzerRule
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/RuleListDocumentation.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/RuleListDocumentation.html
index 7431766e0..95302d521 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/RuleListDocumentation.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/RuleListDocumentation.html
@@ -384,6 +384,11 @@
Write the rule list documentation as markdown files to the specified directory.
+
+ Throws
+ Throws if the files could not be written to.
+
+
@@ -414,7 +419,7 @@
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/SwiftLintSyntaxMap.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/SwiftLintSyntaxMap.html
index e9f1f7e47..ef8674a2f 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/SwiftLintSyntaxMap.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/SwiftLintSyntaxMap.html
@@ -396,10 +396,6 @@
Creates a SwiftLintSyntaxMap from the raw SyntaxMap obtained by SourceKitten.
-
-- arameter value: The raw
SyntaxMap obtained by SourceKitten.
-
-
Declaration
@@ -409,6 +405,25 @@
+
+ Parameters
+
+
+
+
+
+ value
+
+
+
+
+ The raw SyntaxMap obtained by SourceKitten.
+
+
+
+
+
+
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/YamlParser.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/YamlParser.html
index 62125276b..f3f8e6204 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/YamlParser.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/Structs/YamlParser.html
@@ -335,6 +335,11 @@
Parses the input YAML string as an untyped dictionary.
+
+ Throws
+ Throws if the yaml string provided could not be parsed.
+
+
@@ -377,8 +382,12 @@
+
+ Return Value
+ The parsed YAML as an untyped dictionary.
+
diff --git a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/implicit_return.html b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/implicit_return.html
index 38781cfb4..6a32ebac1 100644
--- a/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/implicit_return.html
+++ b/docsets/SwiftLintFramework.docset/Contents/Resources/Documents/implicit_return.html
@@ -316,7 +316,7 @@
Kind: style
Analyzer rule: No
Minimum Swift compiler version: 3.0.0
-Default configuration: warning, included: [SwiftLintFramework.ImplicitReturnConfiguration.ReturnKind.function, SwiftLintFramework.ImplicitReturnConfiguration.ReturnKind.closure, SwiftLintFramework.ImplicitReturnConfiguration.ReturnKind.getter]
+Default configuration: warning, included: [SwiftLintFramework.ImplicitReturnConfiguration.ReturnKind.closure, SwiftLintFramework.ImplicitReturnConfiguration.ReturnKind.function, SwiftLintFramework.ImplicitReturnConfiguration.ReturnKind.getter]
Non Triggering Examples
if foo {
diff --git a/docsets/SwiftLintFramework.tgz b/docsets/SwiftLintFramework.tgz
index 054808311..500beeff8 100644
Binary files a/docsets/SwiftLintFramework.tgz and b/docsets/SwiftLintFramework.tgz differ
diff --git a/implicit_return.html b/implicit_return.html
index 38781cfb4..6a32ebac1 100644
--- a/implicit_return.html
+++ b/implicit_return.html
@@ -316,7 +316,7 @@
Kind: style
Analyzer rule: No
Minimum Swift compiler version: 3.0.0
-Default configuration: warning, included: [SwiftLintFramework.ImplicitReturnConfiguration.ReturnKind.function, SwiftLintFramework.ImplicitReturnConfiguration.ReturnKind.closure, SwiftLintFramework.ImplicitReturnConfiguration.ReturnKind.getter]
+Default configuration: warning, included: [SwiftLintFramework.ImplicitReturnConfiguration.ReturnKind.closure, SwiftLintFramework.ImplicitReturnConfiguration.ReturnKind.function, SwiftLintFramework.ImplicitReturnConfiguration.ReturnKind.getter]
Non Triggering Examples
if foo {