Deploying to gh-pages from @ d8c32f0045 🚀

This commit is contained in:
veelenga 2021-02-24 08:11:10 +00:00
parent 8d0a0f7c6a
commit c1e843ec60
103 changed files with 19232 additions and 1880 deletions

View file

@ -131,6 +131,11 @@
</li>
<li class=" " data-id="ameba/Ameba/AST/TopLevelNodesVisitor" data-name="ameba::ast::toplevelnodesvisitor">
<a href="../Ameba/AST/TopLevelNodesVisitor.html">TopLevelNodesVisitor</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/Util" data-name="ameba::ast::util">
<a href="../Ameba/AST/Util.html">Util</a>
@ -221,9 +226,19 @@
</li>
<li class=" " data-id="ameba/Ameba/Issue" data-name="ameba::issue">
<li class="parent " data-id="ameba/Ameba/Issue" data-name="ameba::issue">
<a href="../Ameba/Issue.html">Issue</a>
<ul>
<li class=" " data-id="ameba/Ameba/Issue/Status" data-name="ameba::issue::status">
<a href="../Ameba/Issue/Status.html">Status</a>
</li>
</ul>
</li>
<li class=" " data-id="ameba/Ameba/Reportable" data-name="ameba::reportable">
@ -286,6 +301,11 @@
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/DuplicatedRequire" data-name="ameba::rule::lint::duplicatedrequire">
<a href="../Ameba/Rule/Lint/DuplicatedRequire.html">DuplicatedRequire</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/EmptyEnsure" data-name="ameba::rule::lint::emptyensure">
<a href="../Ameba/Rule/Lint/EmptyEnsure.html">EmptyEnsure</a>
@ -361,6 +381,11 @@
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/SpecFocus" data-name="ameba::rule::lint::specfocus">
<a href="../Ameba/Rule/Lint/SpecFocus.html">SpecFocus</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/Syntax" data-name="ameba::rule::lint::syntax">
<a href="../Ameba/Rule/Lint/Syntax.html">Syntax</a>
@ -421,11 +446,36 @@
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/AnyInsteadOfEmpty" data-name="ameba::rule::performance::anyinsteadofempty">
<a href="../Ameba/Rule/Performance/AnyInsteadOfEmpty.html">AnyInsteadOfEmpty</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/ChainedCallWithNoBang" data-name="ameba::rule::performance::chainedcallwithnobang">
<a href="../Ameba/Rule/Performance/ChainedCallWithNoBang.html">ChainedCallWithNoBang</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/CompactAfterMap" data-name="ameba::rule::performance::compactaftermap">
<a href="../Ameba/Rule/Performance/CompactAfterMap.html">CompactAfterMap</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/FirstLastAfterFilter" data-name="ameba::rule::performance::firstlastafterfilter">
<a href="../Ameba/Rule/Performance/FirstLastAfterFilter.html">FirstLastAfterFilter</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/FlattenAfterMap" data-name="ameba::rule::performance::flattenaftermap">
<a href="../Ameba/Rule/Performance/FlattenAfterMap.html">FlattenAfterMap</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/MapInsteadOfBlock" data-name="ameba::rule::performance::mapinsteadofblock">
<a href="../Ameba/Rule/Performance/MapInsteadOfBlock.html">MapInsteadOfBlock</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/SizeAfterFilter" data-name="ameba::rule::performance::sizeafterfilter">
<a href="../Ameba/Rule/Performance/SizeAfterFilter.html">SizeAfterFilter</a>
@ -446,6 +496,11 @@
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/IsAFilter" data-name="ameba::rule::style::isafilter">
<a href="../Ameba/Rule/Style/IsAFilter.html">IsAFilter</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/IsANil" data-name="ameba::rule::style::isanil">
<a href="../Ameba/Rule/Style/IsANil.html">IsANil</a>
@ -501,6 +556,11 @@
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/VerboseBlock" data-name="ameba::rule::style::verboseblock">
<a href="../Ameba/Rule/Style/VerboseBlock.html">VerboseBlock</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/WhileTrue" data-name="ameba::rule::style::whiletrue">
<a href="../Ameba/Rule/Style/WhileTrue.html">WhileTrue</a>
@ -620,7 +680,7 @@ config.formatter <span class="o">=</span> my_formatter</code></pre>
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/config.cr#L15" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/d8c32f00/src/ameba/config.cr#L15" target="_blank">
ameba/config.cr
</a>
@ -713,17 +773,12 @@ config.formatter <span class="o">=</span> my_formatter</code></pre>
</li>
<li class="entry-summary">
<a href="#formatter-instance-method" class="signature"><strong>#formatter</strong></a>
<a href="#formatter:Formatter::BaseFormatter?-instance-method" class="signature"><strong>#formatter</strong> : Formatter::BaseFormatter?</a>
<div class="summary"><p>Returns a formatter to be used while inspecting files.</p></div>
</li>
<li class="entry-summary">
<a href="#formatter=(formatter:Formatter::BaseFormatter?)-instance-method" class="signature"><strong>#formatter=</strong>(formatter : Formatter::BaseFormatter?)</a>
</li>
<li class="entry-summary">
<a href="#formatter=(name:String%7CSymbol)-instance-method" class="signature"><strong>#formatter=</strong>(name : String | Symbol)</a>
@ -731,6 +786,13 @@ config.formatter <span class="o">=</span> my_formatter</code></pre>
</li>
<li class="entry-summary">
<a href="#formatter=(formatter:Formatter::BaseFormatter)-instance-method" class="signature"><strong>#formatter=</strong>(formatter : Formatter::BaseFormatter)</a>
<div class="summary"><p>Returns a formatter to be used while inspecting files.</p></div>
</li>
<li class="entry-summary">
<a href="#globs:Array(String)-instance-method" class="signature"><strong>#globs</strong> : Array(String)</a>
@ -775,7 +837,7 @@ config.formatter <span class="o">=</span> my_formatter</code></pre>
</li>
<li class="entry-summary">
<a href="#update_rules(names,**args)-instance-method" class="signature"><strong>#update_rules</strong>(names, **args)</a>
<a href="#update_rules(names,enabled=true,excluded=nil)-instance-method" class="signature"><strong>#update_rules</strong>(names, enabled = <span class="n">true</span>, excluded = <span class="n">nil</span>)</a>
<div class="summary"><p>Updates rules properties.</p></div>
@ -858,7 +920,7 @@ config.formatter <span class="o">=</span> my_formatter</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/config.cr#L86" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/d8c32f00/src/ameba/config.cr#L86" target="_blank">View source</a>]
</div>
</div>
@ -881,7 +943,7 @@ config.formatter <span class="o">=</span> my_formatter</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/config.cr#L78" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/d8c32f00/src/ameba/config.cr#L78" target="_blank">View source</a>]
</div>
</div>
@ -918,7 +980,7 @@ config.excluded <span class="o">=</span> [<span class="s">&quot;spec&quot;</span
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/config.cr#L56" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/d8c32f00/src/ameba/config.cr#L55" target="_blank">View source</a>]
</div>
</div>
@ -943,17 +1005,17 @@ config.excluded <span class="o">=</span> [<span class="s">&quot;spec&quot;</span
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/config.cr#L56" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/d8c32f00/src/ameba/config.cr#L55" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="formatter-instance-method">
<div class="entry-detail" id="formatter:Formatter::BaseFormatter?-instance-method">
<div class="signature">
def <strong>formatter</strong>
def <strong>formatter</strong> : <a href="../Ameba/Formatter/BaseFormatter.html">Formatter::BaseFormatter</a>?
<a class="method-permalink" href="#formatter-instance-method">#</a>
<a class="method-permalink" href="#formatter:Formatter::BaseFormatter?-instance-method">#</a>
</div>
<div class="doc">
@ -969,23 +1031,7 @@ config.formatter</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/config.cr#L114" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="formatter=(formatter:Formatter::BaseFormatter?)-instance-method">
<div class="signature">
def <strong>formatter=</strong>(formatter : <a href="../Ameba/Formatter/BaseFormatter.html">Formatter::BaseFormatter</a>?)
<a class="method-permalink" href="#formatter=(formatter:Formatter::BaseFormatter?)-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/config.cr#L34" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/d8c32f00/src/ameba/config.cr#L113" target="_blank">View source</a>]
</div>
</div>
@ -1009,7 +1055,33 @@ config.formatter <span class="o">=</span> <span class="n">:progress</span></code
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/config.cr#L125" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/d8c32f00/src/ameba/config.cr#L123" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="formatter=(formatter:Formatter::BaseFormatter)-instance-method">
<div class="signature">
def <strong>formatter=</strong>(formatter : <a href="../Ameba/Formatter/BaseFormatter.html">Formatter::BaseFormatter</a>)
<a class="method-permalink" href="#formatter=(formatter:Formatter::BaseFormatter)-instance-method">#</a>
</div>
<div class="doc">
<p>Returns a formatter to be used while inspecting files.
If formatter is not set, it will return default formatter.</p>
<pre><code class="language-crystal">config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
config.formatter <span class="o">=</span> custom_formatter
config.formatter</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/d8c32f00/src/ameba/config.cr#L113" target="_blank">View source</a>]
</div>
</div>
@ -1036,7 +1108,7 @@ config.globs</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/config.cr#L47" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/d8c32f00/src/ameba/config.cr#L46" target="_blank">View source</a>]
</div>
</div>
@ -1063,7 +1135,7 @@ config.globs</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/config.cr#L47" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/d8c32f00/src/ameba/config.cr#L46" target="_blank">View source</a>]
</div>
</div>
@ -1079,7 +1151,7 @@ config.globs</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/config.cr#L35" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/d8c32f00/src/ameba/config.cr#L34" target="_blank">View source</a>]
</div>
</div>
@ -1095,7 +1167,7 @@ config.globs</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/config.cr#L36" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/d8c32f00/src/ameba/config.cr#L35" target="_blank">View source</a>]
</div>
</div>
@ -1111,7 +1183,7 @@ config.globs</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/config.cr#L36" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/d8c32f00/src/ameba/config.cr#L35" target="_blank">View source</a>]
</div>
</div>
@ -1138,7 +1210,7 @@ config.sources <span class="c"># =&gt; list of sources pointing to files found b
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/config.cr#L100" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/d8c32f00/src/ameba/config.cr#L99" target="_blank">View source</a>]
</div>
</div>
@ -1162,17 +1234,17 @@ config.update_rule <span class="s">&quot;MyRuleName&quot;</span>, enabled: <span
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/config.cr#L140" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/d8c32f00/src/ameba/config.cr#L137" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="update_rules(names,**args)-instance-method">
<div class="entry-detail" id="update_rules(names,enabled=true,excluded=nil)-instance-method">
<div class="signature">
def <strong>update_rules</strong>(names, **args)
def <strong>update_rules</strong>(names, enabled = <span class="n">true</span>, excluded = <span class="n">nil</span>)
<a class="method-permalink" href="#update_rules(names,**args)-instance-method">#</a>
<a class="method-permalink" href="#update_rules(names,enabled=true,excluded=nil)-instance-method">#</a>
</div>
<div class="doc">
@ -1190,7 +1262,7 @@ config.update_rules <span class="s">%w(Rule1 Rule2)</span>, enabled: <span class
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/config.cr#L163" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/d8c32f00/src/ameba/config.cr#L158" target="_blank">View source</a>]
</div>
</div>