GitHub/SwiftLint
1
0
Fork 0
mirror of https://github.com/realm/SwiftLint.git synced 2026-06-06 20:18:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Automated deployment to GitHub Pages: 1aa8289085

Browse Source
This commit is contained in:
swiftlintbot@jpsim.com
2024-03-04 15:49:00 +00:00
parent 266954c7f7
commit 8dd9f1d574
20 changed files with 154 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Protocols.html
+6 -6
View File
@@ -666,7 +666,7 @@ structure, validating the rule recursively in nested source bodies.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L5-L74">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L5-L77">Show on GitHub</a>
</div>
</section>
</div>
@@ -696,7 +696,7 @@ structure, validating the rule recursively in nested source bodies.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L119">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L126">Show on GitHub</a>
</div>
</section>
</div>
@@ -727,7 +727,7 @@ structure, validating the rule recursively in nested source bodies.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L122-L149">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L129-L156">Show on GitHub</a>
</div>
</section>
</div>
@@ -759,7 +759,7 @@ updated content.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L162-L177">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L169-L184">Show on GitHub</a>
</div>
</section>
</div>
@@ -789,7 +789,7 @@ updated content.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L202">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L209">Show on GitHub</a>
</div>
</section>
</div>
@@ -821,7 +821,7 @@ static analysis than syntactic checks.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L206">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L213">Show on GitHub</a>
</div>
</section>
</div>
Protocols/AnalyzerRule.html
+2 -2
View File
@@ -351,7 +351,7 @@
static analysis than syntactic checks.</p>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L206">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L213">Show on GitHub</a>
</div>
</div>
</section>
@@ -387,7 +387,7 @@ static analysis than syntactic checks.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L209-L211">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L216-L218">Show on GitHub</a>
</div>
</section>
</div>
Protocols/CorrectableRule.html
+4 -4
View File
@@ -350,7 +350,7 @@
<p>A rule that can correct violations.</p>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L122-L149">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L129-L156">Show on GitHub</a>
</div>
</div>
</section>
@@ -426,7 +426,7 @@
<p>All corrections that were applied.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L129">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L136">Show on GitHub</a>
</div>
</section>
</div>
@@ -479,7 +479,7 @@
<p>All corrections that were applied.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L136">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L143">Show on GitHub</a>
</div>
</section>
</div>
@@ -569,7 +569,7 @@ and returns all corrections that were applied.</p>
<p>All corrections that were applied.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L148">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L155">Show on GitHub</a>
</div>
</section>
</div>
Protocols/Rule.html
+47 -10
View File
@@ -350,7 +350,7 @@
<p>An executable value that can identify issues (violations) in Swift source code.</p>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L5-L74">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L5-L77">Show on GitHub</a>
</div>
</div>
</section>
@@ -517,6 +517,43 @@
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SwiftLintCore4RuleP06shouldB10EmptyFilesSbvp"></a>
<a name="//apple_ref/swift/Property/shouldLintEmptyFiles" class="dashAnchor"></a>
<a class="token" href="#/s:13SwiftLintCore4RuleP06shouldB10EmptyFilesSbvp">shouldLintEmptyFiles</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Whether this rule should be used on empty files. Defaults to <code>false</code>.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">shouldLintEmptyFiles</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L23">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
@@ -542,7 +579,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L23">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L26">Show on GitHub</a>
</div>
</section>
</div>
@@ -603,7 +640,7 @@
</table>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L30">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L33">Show on GitHub</a>
</div>
</section>
</div>
@@ -675,7 +712,7 @@
<p>All style violations to the rule&rsquo;s expectations.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L38">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L41">Show on GitHub</a>
</div>
</section>
</div>
@@ -728,7 +765,7 @@
<p>All style violations to the rule&rsquo;s expectations.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L45">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L48">Show on GitHub</a>
</div>
</section>
</div>
@@ -788,7 +825,7 @@
<p>Whether or not the specified rule is equivalent to the current rule.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L52">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L55">Show on GitHub</a>
</div>
</section>
</div>
@@ -873,7 +910,7 @@
</table>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L61">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L64">Show on GitHub</a>
</div>
</section>
</div>
@@ -963,7 +1000,7 @@ expectations.</p>
<p>All style violations to the rule&rsquo;s expectations.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L73">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L76">Show on GitHub</a>
</div>
</section>
</div>
@@ -997,7 +1034,7 @@ cached value is still valid given the new cache value.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L104-L106">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L111-L113">Show on GitHub</a>
</div>
</section>
</div>
@@ -1030,7 +1067,7 @@ cached value is still valid given the new cache value.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L115">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L122">Show on GitHub</a>
</div>
</section>
</div>
Protocols/SubstitutionCorrectableRule.html
+4 -4
View File
@@ -351,7 +351,7 @@
updated content.</p>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L162-L177">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L169-L184">Show on GitHub</a>
</div>
</div>
</section>
@@ -408,7 +408,7 @@ updated content.</p>
<p>The NSString-based <code>NSRange</code>s to be replaced in the specified file.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L168">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L175">Show on GitHub</a>
</div>
</section>
</div>
@@ -473,7 +473,7 @@ updated content.</p>
<p>The range of the correction and its contents, if one could be computed.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L176">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L183">Show on GitHub</a>
</div>
</section>
</div>
@@ -505,7 +505,7 @@ updated content.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L180-L198">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L187-L205">Show on GitHub</a>
</div>
</section>
</div>
Structs.html
+2 -2
View File
@@ -599,7 +599,7 @@ non-triggering style</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L126-L169">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L131-L180">Show on GitHub</a>
</div>
</section>
</div>
@@ -632,7 +632,7 @@ non-triggering style</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L174-L349">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L185-L360">Show on GitHub</a>
</div>
</section>
</div>
Structs/CollectedLinter.html
+6 -6
View File
@@ -352,7 +352,7 @@
<p>A <code>CollectedLinter</code> is only created after a <code><a href="../Structs/Linter.html">Linter</a></code> has run its collection steps in <code><a href="../Structs/Linter.html#/s:13SwiftLintCore6LinterV7collect4intoAA09CollectedD0VAA11RuleStorageC_tF">Linter.collect(into:)</a></code>.</p>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L174-L349">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L185-L360">Show on GitHub</a>
</div>
</div>
</section>
@@ -386,7 +386,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L176">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L187">Show on GitHub</a>
</div>
</section>
</div>
@@ -439,7 +439,7 @@
<p>All style violations found by this linter.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L195-L197">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L206-L208">Show on GitHub</a>
</div>
</section>
</div>
@@ -493,7 +493,7 @@
<p>All style violations found by this linter, and the time spent executing each rule.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L204-L207">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L215-L218">Show on GitHub</a>
</div>
</section>
</div>
@@ -546,7 +546,7 @@
<p>All corrections that were applied.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L282-L304">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L293-L315">Show on GitHub</a>
</div>
</section>
</div>
@@ -607,7 +607,7 @@
</table>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L310-L317">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L321-L328">Show on GitHub</a>
</div>
</section>
</div>
Structs/Linter.html
+5 -5
View File
@@ -350,7 +350,7 @@
<p>Represents a file that can be linted for style violations and corrections after being collected.</p>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L126-L169">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L131-L180">Show on GitHub</a>
</div>
</div>
</section>
@@ -384,7 +384,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L128">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L133">Show on GitHub</a>
</div>
</section>
</div>
@@ -414,7 +414,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L130">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L135">Show on GitHub</a>
</div>
</section>
</div>
@@ -500,7 +500,7 @@
</table>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L142-L156">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L147-L167">Show on GitHub</a>
</div>
</section>
</div>
@@ -553,7 +553,7 @@
<p>A linter capable of checking for violations after running each rule&rsquo;s collection step.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L163-L168">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L174-L179">Show on GitHub</a>
</div>
</section>
</div>
docsets/SwiftLintCore.docset/Contents/Resources/Documents/Protocols.html
+6 -6
View File
@@ -666,7 +666,7 @@ structure, validating the rule recursively in nested source bodies.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L5-L74">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L5-L77">Show on GitHub</a>
</div>
</section>
</div>
@@ -696,7 +696,7 @@ structure, validating the rule recursively in nested source bodies.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L119">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L126">Show on GitHub</a>
</div>
</section>
</div>
@@ -727,7 +727,7 @@ structure, validating the rule recursively in nested source bodies.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L122-L149">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L129-L156">Show on GitHub</a>
</div>
</section>
</div>
@@ -759,7 +759,7 @@ updated content.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L162-L177">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L169-L184">Show on GitHub</a>
</div>
</section>
</div>
@@ -789,7 +789,7 @@ updated content.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L202">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L209">Show on GitHub</a>
</div>
</section>
</div>
@@ -821,7 +821,7 @@ static analysis than syntactic checks.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L206">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L213">Show on GitHub</a>
</div>
</section>
</div>
docsets/SwiftLintCore.docset/Contents/Resources/Documents/Protocols/AnalyzerRule.html
+2 -2
View File
@@ -351,7 +351,7 @@
static analysis than syntactic checks.</p>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L206">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L213">Show on GitHub</a>
</div>
</div>
</section>
@@ -387,7 +387,7 @@ static analysis than syntactic checks.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L209-L211">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L216-L218">Show on GitHub</a>
</div>
</section>
</div>
docsets/SwiftLintCore.docset/Contents/Resources/Documents/Protocols/CorrectableRule.html
+4 -4
View File
@@ -350,7 +350,7 @@
<p>A rule that can correct violations.</p>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L122-L149">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L129-L156">Show on GitHub</a>
</div>
</div>
</section>
@@ -426,7 +426,7 @@
<p>All corrections that were applied.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L129">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L136">Show on GitHub</a>
</div>
</section>
</div>
@@ -479,7 +479,7 @@
<p>All corrections that were applied.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L136">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L143">Show on GitHub</a>
</div>
</section>
</div>
@@ -569,7 +569,7 @@ and returns all corrections that were applied.</p>
<p>All corrections that were applied.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L148">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L155">Show on GitHub</a>
</div>
</section>
</div>
docsets/SwiftLintCore.docset/Contents/Resources/Documents/Protocols/Rule.html
+47 -10
View File
@@ -350,7 +350,7 @@
<p>An executable value that can identify issues (violations) in Swift source code.</p>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L5-L74">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L5-L77">Show on GitHub</a>
</div>
</div>
</section>
@@ -517,6 +517,43 @@
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:13SwiftLintCore4RuleP06shouldB10EmptyFilesSbvp"></a>
<a name="//apple_ref/swift/Property/shouldLintEmptyFiles" class="dashAnchor"></a>
<a class="token" href="#/s:13SwiftLintCore4RuleP06shouldB10EmptyFilesSbvp">shouldLintEmptyFiles</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Whether this rule should be used on empty files. Defaults to <code>false</code>.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">shouldLintEmptyFiles</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L23">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
@@ -542,7 +579,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L23">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L26">Show on GitHub</a>
</div>
</section>
</div>
@@ -603,7 +640,7 @@
</table>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L30">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L33">Show on GitHub</a>
</div>
</section>
</div>
@@ -675,7 +712,7 @@
<p>All style violations to the rule&rsquo;s expectations.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L38">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L41">Show on GitHub</a>
</div>
</section>
</div>
@@ -728,7 +765,7 @@
<p>All style violations to the rule&rsquo;s expectations.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L45">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L48">Show on GitHub</a>
</div>
</section>
</div>
@@ -788,7 +825,7 @@
<p>Whether or not the specified rule is equivalent to the current rule.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L52">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L55">Show on GitHub</a>
</div>
</section>
</div>
@@ -873,7 +910,7 @@
</table>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L61">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L64">Show on GitHub</a>
</div>
</section>
</div>
@@ -963,7 +1000,7 @@ expectations.</p>
<p>All style violations to the rule&rsquo;s expectations.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L73">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L76">Show on GitHub</a>
</div>
</section>
</div>
@@ -997,7 +1034,7 @@ cached value is still valid given the new cache value.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L104-L106">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L111-L113">Show on GitHub</a>
</div>
</section>
</div>
@@ -1030,7 +1067,7 @@ cached value is still valid given the new cache value.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L115">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L122">Show on GitHub</a>
</div>
</section>
</div>
docsets/SwiftLintCore.docset/Contents/Resources/Documents/Protocols/SubstitutionCorrectableRule.html
+4 -4
View File
@@ -351,7 +351,7 @@
updated content.</p>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L162-L177">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L169-L184">Show on GitHub</a>
</div>
</div>
</section>
@@ -408,7 +408,7 @@ updated content.</p>
<p>The NSString-based <code>NSRange</code>s to be replaced in the specified file.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L168">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L175">Show on GitHub</a>
</div>
</section>
</div>
@@ -473,7 +473,7 @@ updated content.</p>
<p>The range of the correction and its contents, if one could be computed.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L176">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L183">Show on GitHub</a>
</div>
</section>
</div>
@@ -505,7 +505,7 @@ updated content.</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L180-L198">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Protocols/Rule.swift#L187-L205">Show on GitHub</a>
</div>
</section>
</div>
docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs.html
+2 -2
View File
@@ -599,7 +599,7 @@ non-triggering style</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L126-L169">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L131-L180">Show on GitHub</a>
</div>
</section>
</div>
@@ -632,7 +632,7 @@ non-triggering style</p>
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L174-L349">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L185-L360">Show on GitHub</a>
</div>
</section>
</div>
docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/CollectedLinter.html
+6 -6
View File
@@ -352,7 +352,7 @@
<p>A <code>CollectedLinter</code> is only created after a <code><a href="../Structs/Linter.html">Linter</a></code> has run its collection steps in <code><a href="../Structs/Linter.html#/s:13SwiftLintCore6LinterV7collect4intoAA09CollectedD0VAA11RuleStorageC_tF">Linter.collect(into:)</a></code>.</p>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L174-L349">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L185-L360">Show on GitHub</a>
</div>
</div>
</section>
@@ -386,7 +386,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L176">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L187">Show on GitHub</a>
</div>
</section>
</div>
@@ -439,7 +439,7 @@
<p>All style violations found by this linter.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L195-L197">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L206-L208">Show on GitHub</a>
</div>
</section>
</div>
@@ -493,7 +493,7 @@
<p>All style violations found by this linter, and the time spent executing each rule.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L204-L207">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L215-L218">Show on GitHub</a>
</div>
</section>
</div>
@@ -546,7 +546,7 @@
<p>All corrections that were applied.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L282-L304">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L293-L315">Show on GitHub</a>
</div>
</section>
</div>
@@ -607,7 +607,7 @@
</table>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L310-L317">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L321-L328">Show on GitHub</a>
</div>
</section>
</div>
docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Linter.html
+5 -5
View File
@@ -350,7 +350,7 @@
<p>Represents a file that can be linted for style violations and corrections after being collected.</p>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L126-L169">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L131-L180">Show on GitHub</a>
</div>
</div>
</section>
@@ -384,7 +384,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L128">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L133">Show on GitHub</a>
</div>
</section>
</div>
@@ -414,7 +414,7 @@
</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L130">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L135">Show on GitHub</a>
</div>
</section>
</div>
@@ -500,7 +500,7 @@
</table>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L142-L156">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L147-L167">Show on GitHub</a>
</div>
</section>
</div>
@@ -553,7 +553,7 @@
<p>A linter capable of checking for violations after running each rule&rsquo;s collection step.</p>
</div>
<div class="slightly-smaller">
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L163-L168">Show on GitHub</a>
<a href="https://github.com/realm/SwiftLint/tree/main/Source/SwiftLintCore/Models/Linter.swift#L174-L179">Show on GitHub</a>
</div>
</section>
</div>
docsets/SwiftLintCore.docset/Contents/Resources/Documents/search.json
+1 -1
View File
File diff suppressed because one or more lines are too long
docsets/SwiftLintCore.docset/Contents/Resources/docSet.dsidx
BIN
View File
Binary file not shown.
docsets/SwiftLintCore.tgz
BIN
View File
Binary file not shown.
search.json
+1 -1
View File
File diff suppressed because one or more lines are too long