mirror of
https://gitea.invidious.io/iv-org/shard-ameba.git
synced 2024-08-15 00:53:29 +00:00
Deploying to gh-pages from @ 48b15b9bf8 🚀
This commit is contained in:
Sija
parent
42809c9681
commit
f760465482
106 changed files with 5612 additions and 4623 deletions
1208
Ameba/Rule/Lint/AmbiguousAssignment.html
Normal file
1208
Ameba/Rule/Lint/AmbiguousAssignment.html
Normal file
File diff suppressed because it is too large
Load diff
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" current" data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -640,17 +645,13 @@
|
|||
</h2>
|
||||
|
||||
<p>A rule that reports incorrect comment directives for Ameba.</p>
|
||||
|
||||
<p>For example, the user can mistakenly add a directive
|
||||
to disable a rule that even doesn't exist:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="c"># ameba:disable BadRuleName</span>
|
||||
<span class="k">def</span> <span class="m">foo</span>
|
||||
<span class="n">:bar</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/BadDirective:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -693,7 +694,7 @@ to disable a rule that even doesn't exist:</p>
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/bad_directive.cr#L20" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/bad_directive.cr#L20" target="_blank">
|
||||
ameba/rule/lint/bad_directive.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -744,12 +745,12 @@ to disable a rule that even doesn't exist:</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that reports incorrect comment directives for Ameba.</p></div>
|
||||
|
||||
|
|
@ -772,47 +773,47 @@ to disable a rule that even doesn't exist:</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source)-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
<a href="#test%28source%29-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -849,17 +850,17 @@ to disable a rule that even doesn't exist:</p>
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -879,12 +880,12 @@ to disable a rule that even doesn't exist:</p>
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -954,7 +955,7 @@ to disable a rule that even doesn't exist:</p>
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -968,23 +969,19 @@ to disable a rule that even doesn't exist:</p>
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that reports incorrect comment directives for Ameba.</p>
|
||||
|
||||
<p>For example, the user can mistakenly add a directive
|
||||
to disable a rule that even doesn't exist:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="c"># ameba:disable BadRuleName</span>
|
||||
<span class="k">def</span> <span class="m">foo</span>
|
||||
<span class="n">:bar</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/BadDirective:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -992,7 +989,7 @@ to disable a rule that even doesn't exist:</p>
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/bad_directive.cr#L20" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/bad_directive.cr#L20" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1016,7 +1013,7 @@ to disable a rule that even doesn't exist:</p>
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1030,7 +1027,7 @@ to disable a rule that even doesn't exist:</p>
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1044,7 +1041,7 @@ to disable a rule that even doesn't exist:</p>
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1058,7 +1055,7 @@ to disable a rule that even doesn't exist:</p>
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1072,7 +1069,7 @@ to disable a rule that even doesn't exist:</p>
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1086,7 +1083,7 @@ to disable a rule that even doesn't exist:</p>
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1100,7 +1097,7 @@ to disable a rule that even doesn't exist:</p>
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1114,7 +1111,7 @@ to disable a rule that even doesn't exist:</p>
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1128,13 +1125,13 @@ to disable a rule that even doesn't exist:</p>
|
|||
|
||||
def <strong>test</strong>(source)
|
||||
|
||||
<a class="method-permalink" href="#test(source)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/bad_directive.cr#L29" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/bad_directive.cr#L29" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -640,19 +645,14 @@
|
|||
</h2>
|
||||
|
||||
<p>A rule that disallows comparison to booleans.</p>
|
||||
|
||||
<p>For example, these are considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal">foo <span class="o">==</span> <span class="n">true</span>
|
||||
bar <span class="o">!=</span> <span class="n">false</span>
|
||||
<span class="n">false</span> <span class="o">===</span> baz</code></pre>
|
||||
|
||||
<p>This is because these expressions evaluate to <code>true</code> or <code>false</code>, so you
|
||||
could get the same result by using either the variable directly,
|
||||
or negating the variable.</p>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/ComparisonToBoolean:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -695,7 +695,7 @@ or negating the variable.</p>
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/comparison_to_boolean.cr#L22" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/comparison_to_boolean.cr#L22" target="_blank">
|
||||
ameba/rule/lint/comparison_to_boolean.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -741,12 +741,12 @@ or negating the variable.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows comparison to booleans.</p></div>
|
||||
|
||||
|
|
@ -769,47 +769,47 @@ or negating the variable.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled:Bool)-instance-method" class="signature"><strong>#enabled=</strong>(enabled : Bool)</a>
|
||||
<a href="#enabled%3D%28enabled%3ABool%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled : Bool)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::Call)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Call)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3ACall%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Call)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -846,17 +846,17 @@ or negating the variable.</p>
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -876,12 +876,12 @@ or negating the variable.</p>
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -951,7 +951,7 @@ or negating the variable.</p>
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -965,25 +965,20 @@ or negating the variable.</p>
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows comparison to booleans.</p>
|
||||
|
||||
<p>For example, these are considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal">foo <span class="o">==</span> <span class="n">true</span>
|
||||
bar <span class="o">!=</span> <span class="n">false</span>
|
||||
<span class="n">false</span> <span class="o">===</span> baz</code></pre>
|
||||
|
||||
<p>This is because these expressions evaluate to <code>true</code> or <code>false</code>, so you
|
||||
could get the same result by using either the variable directly,
|
||||
or negating the variable.</p>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/ComparisonToBoolean:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -991,7 +986,7 @@ or negating the variable.</p>
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/comparison_to_boolean.cr#L22" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/comparison_to_boolean.cr#L22" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1015,7 +1010,7 @@ or negating the variable.</p>
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1029,7 +1024,7 @@ or negating the variable.</p>
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1043,7 +1038,7 @@ or negating the variable.</p>
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1057,7 +1052,7 @@ or negating the variable.</p>
|
|||
|
||||
def <strong>enabled=</strong>(enabled : Bool)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled:Bool)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%3ABool%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1071,7 +1066,7 @@ or negating the variable.</p>
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1085,7 +1080,7 @@ or negating the variable.</p>
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1099,7 +1094,7 @@ or negating the variable.</p>
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1113,7 +1108,7 @@ or negating the variable.</p>
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1127,13 +1122,13 @@ or negating the variable.</p>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::Call)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::Call)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3ACall%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/comparison_to_boolean.cr#L31" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/comparison_to_boolean.cr#L31" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -640,12 +645,9 @@
|
|||
</h2>
|
||||
|
||||
<p>A rule that disallows calls to debugger.</p>
|
||||
|
||||
<p>This is because we don't want debugger breakpoints accidentally being
|
||||
committed into our codebase.</p>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/DebuggerStatement:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -688,7 +690,7 @@ committed into our codebase.</p>
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/debugger_statement.cr#L13" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/debugger_statement.cr#L13" target="_blank">
|
||||
ameba/rule/lint/debugger_statement.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -729,12 +731,12 @@ committed into our codebase.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows calls to debugger.</p></div>
|
||||
|
||||
|
|
@ -757,47 +759,47 @@ committed into our codebase.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::Call)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Call)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3ACall%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Call)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -834,17 +836,17 @@ committed into our codebase.</p>
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -864,12 +866,12 @@ committed into our codebase.</p>
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -939,7 +941,7 @@ committed into our codebase.</p>
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -953,18 +955,15 @@ committed into our codebase.</p>
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows calls to debugger.</p>
|
||||
|
||||
<p>This is because we don't want debugger breakpoints accidentally being
|
||||
committed into our codebase.</p>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/DebuggerStatement:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -972,7 +971,7 @@ committed into our codebase.</p>
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/debugger_statement.cr#L13" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/debugger_statement.cr#L13" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -996,7 +995,7 @@ committed into our codebase.</p>
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1010,7 +1009,7 @@ committed into our codebase.</p>
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1024,7 +1023,7 @@ committed into our codebase.</p>
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1038,7 +1037,7 @@ committed into our codebase.</p>
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1052,7 +1051,7 @@ committed into our codebase.</p>
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1066,7 +1065,7 @@ committed into our codebase.</p>
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1080,7 +1079,7 @@ committed into our codebase.</p>
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1094,7 +1093,7 @@ committed into our codebase.</p>
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1108,13 +1107,13 @@ committed into our codebase.</p>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::Call)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::Call)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3ACall%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/debugger_statement.cr#L20" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/debugger_statement.cr#L20" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -640,13 +645,10 @@
|
|||
</h2>
|
||||
|
||||
<p>A rule that reports duplicated require statements.</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">require</span> <span class="s">"./thing"</span>
|
||||
<span class="k">require</span> <span class="s">"./stuff"</span>
|
||||
<span class="k">require</span> <span class="s">"./thing"</span> <span class="c"># duplicated require</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/DuplicatedRequire:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -689,7 +691,7 @@
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/duplicated_require.cr#L16" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/duplicated_require.cr#L16" target="_blank">
|
||||
ameba/rule/lint/duplicated_require.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -730,12 +732,12 @@
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that reports duplicated require statements.</p></div>
|
||||
|
||||
|
|
@ -758,47 +760,47 @@
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source)-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
<a href="#test%28source%29-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -835,17 +837,17 @@
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -865,12 +867,12 @@
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -940,7 +942,7 @@
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -954,19 +956,16 @@
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that reports duplicated require statements.</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">require</span> <span class="s">"./thing"</span>
|
||||
<span class="k">require</span> <span class="s">"./stuff"</span>
|
||||
<span class="k">require</span> <span class="s">"./thing"</span> <span class="c"># duplicated require</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/DuplicatedRequire:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -974,7 +973,7 @@
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/duplicated_require.cr#L16" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/duplicated_require.cr#L16" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -998,7 +997,7 @@
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1012,7 +1011,7 @@
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1026,7 +1025,7 @@
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1040,7 +1039,7 @@
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1054,7 +1053,7 @@
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1068,7 +1067,7 @@
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1082,7 +1081,7 @@
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1096,7 +1095,7 @@
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1110,13 +1109,13 @@
|
|||
|
||||
def <strong>test</strong>(source)
|
||||
|
||||
<a class="method-permalink" href="#test(source)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/duplicated_require.cr#L23" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/duplicated_require.cr#L23" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -640,9 +645,7 @@
|
|||
</h2>
|
||||
|
||||
<p>A rule that disallows empty ensure statement.</p>
|
||||
|
||||
<p>For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">some_method</span>
|
||||
do_some_stuff
|
||||
<span class="k">ensure</span>
|
||||
|
|
@ -652,9 +655,7 @@
|
|||
do_some_stuff
|
||||
<span class="k">ensure</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And it should be written as this:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">some_method</span>
|
||||
do_some_stuff
|
||||
<span class="k">ensure</span>
|
||||
|
|
@ -666,9 +667,7 @@
|
|||
<span class="k">ensure</span>
|
||||
do_something_else
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/EmptyEnsure
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -711,7 +710,7 @@
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/empty_ensure.cr#L41" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/empty_ensure.cr#L41" target="_blank">
|
||||
ameba/rule/lint/empty_ensure.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -752,12 +751,12 @@
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows empty ensure statement.</p></div>
|
||||
|
||||
|
|
@ -780,47 +779,47 @@
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::ExceptionHandler)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::ExceptionHandler)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3AExceptionHandler%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::ExceptionHandler)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -857,17 +856,17 @@
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -887,12 +886,12 @@
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -962,7 +961,7 @@
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -976,15 +975,13 @@
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows empty ensure statement.</p>
|
||||
|
||||
<p>For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">some_method</span>
|
||||
do_some_stuff
|
||||
<span class="k">ensure</span>
|
||||
|
|
@ -994,9 +991,7 @@
|
|||
do_some_stuff
|
||||
<span class="k">ensure</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And it should be written as this:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">some_method</span>
|
||||
do_some_stuff
|
||||
<span class="k">ensure</span>
|
||||
|
|
@ -1008,9 +1003,7 @@
|
|||
<span class="k">ensure</span>
|
||||
do_something_else
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/EmptyEnsure
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -1018,7 +1011,7 @@
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/empty_ensure.cr#L41" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/empty_ensure.cr#L41" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1042,7 +1035,7 @@
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1056,7 +1049,7 @@
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1070,7 +1063,7 @@
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1084,7 +1077,7 @@
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1098,7 +1091,7 @@
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1112,7 +1105,7 @@
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1126,7 +1119,7 @@
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1140,7 +1133,7 @@
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1154,13 +1147,13 @@
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::ExceptionHandler)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::ExceptionHandler)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3AExceptionHandler%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/empty_ensure.cr#L48" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/empty_ensure.cr#L48" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -640,25 +645,19 @@
|
|||
</h2>
|
||||
|
||||
<p>A rule that disallows empty expressions.</p>
|
||||
|
||||
<p>This is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal">foo <span class="o">=</span> ()
|
||||
|
||||
<span class="k">if</span> ()
|
||||
bar
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And this is valid:</p>
|
||||
|
||||
<pre><code class="language-crystal">foo <span class="o">=</span> (some_expression)
|
||||
|
||||
<span class="k">if</span> (some_expression)
|
||||
bar
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/EmptyExpression:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -703,7 +702,7 @@
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/empty_expression.cr#L30" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/empty_expression.cr#L30" target="_blank">
|
||||
ameba/rule/lint/empty_expression.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -749,12 +748,12 @@
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows empty expressions.</p></div>
|
||||
|
||||
|
|
@ -777,52 +776,52 @@
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled:Bool)-instance-method" class="signature"><strong>#enabled=</strong>(enabled : Bool)</a>
|
||||
<a href="#enabled%3D%28enabled%3ABool%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled : Bool)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::NilLiteral)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::NilLiteral)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3ANilLiteral%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::NilLiteral)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::Expressions)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Expressions)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3AExpressions%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Expressions)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -839,44 +838,49 @@
|
|||
<h3>Instance methods inherited from module <code><a href="../../../Ameba/AST/Util.html">Ameba::AST::Util</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#abort?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#abort%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>abort?(node)</span>
|
||||
abort?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#exit?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#exit%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>exit?(node)</span>
|
||||
exit?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#flow_command?(node,in_loop)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#flow_command%3F%28node%2Cin_loop%29-instance-method" class="tooltip">
|
||||
<span>flow_command?(node, in_loop)</span>
|
||||
flow_command?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#flow_expression?(node,in_loop=false)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#flow_expression%3F%28node%2Cin_loop%3Dfalse%29-instance-method" class="tooltip">
|
||||
<span>flow_expression?(node, in_loop = <span class="n">false</span>)</span>
|
||||
flow_expression?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#literal?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#literal%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>literal?(node)</span>
|
||||
literal?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#loop?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#loop%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>loop?(node)</span>
|
||||
loop?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#node_source(node,code_lines)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#node_source%28node%2Ccode_lines%29-instance-method" class="tooltip">
|
||||
<span>node_source(node, code_lines)</span>
|
||||
node_source</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#raise?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#raise%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>raise?(node)</span>
|
||||
raise?</a>
|
||||
raise?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#source_between%28loc%2Cend_loc%2Ccode_lines%29%3AString%3F-instance-method" class="tooltip">
|
||||
<span>source_between(loc, end_loc, code_lines) : String?</span>
|
||||
source_between</a>
|
||||
|
||||
|
||||
|
||||
|
|
@ -913,17 +917,17 @@
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -943,12 +947,12 @@
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -1018,7 +1022,7 @@
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1032,31 +1036,25 @@
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows empty expressions.</p>
|
||||
|
||||
<p>This is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal">foo <span class="o">=</span> ()
|
||||
|
||||
<span class="k">if</span> ()
|
||||
bar
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And this is valid:</p>
|
||||
|
||||
<pre><code class="language-crystal">foo <span class="o">=</span> (some_expression)
|
||||
|
||||
<span class="k">if</span> (some_expression)
|
||||
bar
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/EmptyExpression:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -1064,7 +1062,7 @@
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/empty_expression.cr#L30" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/empty_expression.cr#L30" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1088,7 +1086,7 @@
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1102,7 +1100,7 @@
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1116,7 +1114,7 @@
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1130,7 +1128,7 @@
|
|||
|
||||
def <strong>enabled=</strong>(enabled : Bool)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled:Bool)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%3ABool%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1144,7 +1142,7 @@
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1158,7 +1156,7 @@
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1172,7 +1170,7 @@
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1186,7 +1184,7 @@
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1200,13 +1198,13 @@
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::NilLiteral)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::NilLiteral)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3ANilLiteral%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/empty_expression.cr#L41" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/empty_expression.cr#L41" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1216,13 +1214,13 @@
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::Expressions)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::Expressions)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3AExpressions%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/empty_expression.cr#L48" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/empty_expression.cr#L48" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -640,9 +645,7 @@
|
|||
</h2>
|
||||
|
||||
<p>A rule that disallows empty loops.</p>
|
||||
|
||||
<p>This is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">while</span> <span class="n">false</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
|
|
@ -652,9 +655,7 @@
|
|||
loop <span class="k">do</span>
|
||||
<span class="c"># nothing here</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And this is valid:</p>
|
||||
|
||||
<pre><code class="language-crystal">a <span class="o">=</span> <span class="n">1</span>
|
||||
<span class="k">while</span> a <span class="o"><</span> <span class="n">10</span>
|
||||
a += <span class="n">1</span>
|
||||
|
|
@ -666,9 +667,7 @@ loop <span class="k">do</span>
|
|||
loop <span class="k">do</span>
|
||||
do_something_here
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/EmptyLoop:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -713,7 +712,7 @@ loop <span class="k">do</span>
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/empty_loop.cr#L40" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/empty_loop.cr#L40" target="_blank">
|
||||
ameba/rule/lint/empty_loop.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -754,12 +753,12 @@ loop <span class="k">do</span>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows empty loops.</p></div>
|
||||
|
||||
|
|
@ -782,57 +781,57 @@ loop <span class="k">do</span>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::Call)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Call)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3ACall%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Call)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::While)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::While)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3AWhile%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::While)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::Until)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Until)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3AUntil%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Until)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -849,44 +848,49 @@ loop <span class="k">do</span>
|
|||
<h3>Instance methods inherited from module <code><a href="../../../Ameba/AST/Util.html">Ameba::AST::Util</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#abort?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#abort%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>abort?(node)</span>
|
||||
abort?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#exit?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#exit%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>exit?(node)</span>
|
||||
exit?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#flow_command?(node,in_loop)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#flow_command%3F%28node%2Cin_loop%29-instance-method" class="tooltip">
|
||||
<span>flow_command?(node, in_loop)</span>
|
||||
flow_command?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#flow_expression?(node,in_loop=false)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#flow_expression%3F%28node%2Cin_loop%3Dfalse%29-instance-method" class="tooltip">
|
||||
<span>flow_expression?(node, in_loop = <span class="n">false</span>)</span>
|
||||
flow_expression?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#literal?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#literal%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>literal?(node)</span>
|
||||
literal?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#loop?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#loop%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>loop?(node)</span>
|
||||
loop?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#node_source(node,code_lines)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#node_source%28node%2Ccode_lines%29-instance-method" class="tooltip">
|
||||
<span>node_source(node, code_lines)</span>
|
||||
node_source</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#raise?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#raise%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>raise?(node)</span>
|
||||
raise?</a>
|
||||
raise?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#source_between%28loc%2Cend_loc%2Ccode_lines%29%3AString%3F-instance-method" class="tooltip">
|
||||
<span>source_between(loc, end_loc, code_lines) : String?</span>
|
||||
source_between</a>
|
||||
|
||||
|
||||
|
||||
|
|
@ -923,17 +927,17 @@ loop <span class="k">do</span>
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -953,12 +957,12 @@ loop <span class="k">do</span>
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -1028,7 +1032,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1042,15 +1046,13 @@ loop <span class="k">do</span>
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows empty loops.</p>
|
||||
|
||||
<p>This is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">while</span> <span class="n">false</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
|
|
@ -1060,9 +1062,7 @@ loop <span class="k">do</span>
|
|||
loop <span class="k">do</span>
|
||||
<span class="c"># nothing here</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And this is valid:</p>
|
||||
|
||||
<pre><code class="language-crystal">a <span class="o">=</span> <span class="n">1</span>
|
||||
<span class="k">while</span> a <span class="o"><</span> <span class="n">10</span>
|
||||
a += <span class="n">1</span>
|
||||
|
|
@ -1074,9 +1074,7 @@ loop <span class="k">do</span>
|
|||
loop <span class="k">do</span>
|
||||
do_something_here
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/EmptyLoop:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -1084,7 +1082,7 @@ loop <span class="k">do</span>
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/empty_loop.cr#L40" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/empty_loop.cr#L40" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1108,7 +1106,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1122,7 +1120,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1136,7 +1134,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1150,7 +1148,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1164,7 +1162,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1178,7 +1176,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1192,7 +1190,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1206,7 +1204,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1220,13 +1218,13 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::Call)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::Call)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3ACall%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/empty_loop.cr#L49" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/empty_loop.cr#L49" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1236,13 +1234,13 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::While)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::While)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3AWhile%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/empty_loop.cr#L55" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/empty_loop.cr#L55" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1252,13 +1250,13 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::Until)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::Until)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3AUntil%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/empty_loop.cr#L59" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/empty_loop.cr#L59" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -640,17 +645,11 @@
|
|||
</h2>
|
||||
|
||||
<p>A rule that disallows duplicated keys in hash literals.</p>
|
||||
|
||||
<p>This is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal">h <span class="o">=</span> {<span class="s">"foo"</span> => <span class="n">1</span>, <span class="s">"bar"</span> => <span class="n">2</span>, <span class="s">"foo"</span> => <span class="n">3</span>}</code></pre>
|
||||
|
||||
<p>And it has to written as this instead:</p>
|
||||
|
||||
<pre><code class="language-crystal">h <span class="o">=</span> {<span class="s">"foo"</span> => <span class="n">1</span>, <span class="s">"bar"</span> => <span class="n">2</span>}</code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/HashDuplicatedKey:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -693,7 +692,7 @@
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/hash_duplicated_key.cr#L22" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/hash_duplicated_key.cr#L22" target="_blank">
|
||||
ameba/rule/lint/hash_duplicated_key.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -734,12 +733,12 @@
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows duplicated keys in hash literals.</p></div>
|
||||
|
||||
|
|
@ -762,47 +761,47 @@
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::HashLiteral)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::HashLiteral)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3AHashLiteral%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::HashLiteral)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -839,17 +838,17 @@
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -869,12 +868,12 @@
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -944,7 +943,7 @@
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -958,23 +957,17 @@
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows duplicated keys in hash literals.</p>
|
||||
|
||||
<p>This is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal">h <span class="o">=</span> {<span class="s">"foo"</span> => <span class="n">1</span>, <span class="s">"bar"</span> => <span class="n">2</span>, <span class="s">"foo"</span> => <span class="n">3</span>}</code></pre>
|
||||
|
||||
<p>And it has to written as this instead:</p>
|
||||
|
||||
<pre><code class="language-crystal">h <span class="o">=</span> {<span class="s">"foo"</span> => <span class="n">1</span>, <span class="s">"bar"</span> => <span class="n">2</span>}</code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/HashDuplicatedKey:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -982,7 +975,7 @@
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/hash_duplicated_key.cr#L22" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/hash_duplicated_key.cr#L22" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1006,7 +999,7 @@
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1020,7 +1013,7 @@
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1034,7 +1027,7 @@
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1048,7 +1041,7 @@
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1062,7 +1055,7 @@
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1076,7 +1069,7 @@
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1090,7 +1083,7 @@
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1104,7 +1097,7 @@
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1118,13 +1111,13 @@
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::HashLiteral)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::HashLiteral)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3AHashLiteral%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/hash_duplicated_key.cr#L29" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/hash_duplicated_key.cr#L29" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -641,19 +646,14 @@
|
|||
|
||||
<p>A rule that disallows useless conditional statements that contain a literal
|
||||
in place of a variable or predicate function.</p>
|
||||
|
||||
<p>This is because a conditional construct with a literal predicate will
|
||||
always result in the same behaviour at run time, meaning it can be
|
||||
replaced with either the body of the construct, or deleted entirely.</p>
|
||||
|
||||
<p>This is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">if</span> <span class="s">"something"</span>
|
||||
<span class="n">:ok</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/LiteralInCondition:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -698,7 +698,7 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/literal_in_condition.cr#L22" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/literal_in_condition.cr#L22" target="_blank">
|
||||
ameba/rule/lint/literal_in_condition.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -739,12 +739,12 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows useless conditional statements that contain a literal in place of a variable or predicate function.</p></div>
|
||||
|
||||
|
|
@ -767,62 +767,62 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#check_node(source,node)-instance-method" class="signature"><strong>#check_node</strong>(source, node)</a>
|
||||
<a href="#check_node%28source%2Cnode%29-instance-method" class="signature"><strong>#check_node</strong>(source, node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::If)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::If)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3AIf%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::If)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::Unless)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Unless)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3AUnless%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Unless)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::Case)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Case)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3ACase%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Case)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -839,44 +839,49 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
<h3>Instance methods inherited from module <code><a href="../../../Ameba/AST/Util.html">Ameba::AST::Util</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#abort?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#abort%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>abort?(node)</span>
|
||||
abort?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#exit?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#exit%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>exit?(node)</span>
|
||||
exit?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#flow_command?(node,in_loop)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#flow_command%3F%28node%2Cin_loop%29-instance-method" class="tooltip">
|
||||
<span>flow_command?(node, in_loop)</span>
|
||||
flow_command?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#flow_expression?(node,in_loop=false)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#flow_expression%3F%28node%2Cin_loop%3Dfalse%29-instance-method" class="tooltip">
|
||||
<span>flow_expression?(node, in_loop = <span class="n">false</span>)</span>
|
||||
flow_expression?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#literal?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#literal%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>literal?(node)</span>
|
||||
literal?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#loop?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#loop%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>loop?(node)</span>
|
||||
loop?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#node_source(node,code_lines)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#node_source%28node%2Ccode_lines%29-instance-method" class="tooltip">
|
||||
<span>node_source(node, code_lines)</span>
|
||||
node_source</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#raise?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#raise%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>raise?(node)</span>
|
||||
raise?</a>
|
||||
raise?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#source_between%28loc%2Cend_loc%2Ccode_lines%29%3AString%3F-instance-method" class="tooltip">
|
||||
<span>source_between(loc, end_loc, code_lines) : String?</span>
|
||||
source_between</a>
|
||||
|
||||
|
||||
|
||||
|
|
@ -913,17 +918,17 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -943,12 +948,12 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -1018,7 +1023,7 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1032,26 +1037,21 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows useless conditional statements that contain a literal
|
||||
in place of a variable or predicate function.</p>
|
||||
|
||||
<p>This is because a conditional construct with a literal predicate will
|
||||
always result in the same behaviour at run time, meaning it can be
|
||||
replaced with either the body of the construct, or deleted entirely.</p>
|
||||
|
||||
<p>This is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">if</span> <span class="s">"something"</span>
|
||||
<span class="n">:ok</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/LiteralInCondition:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -1059,7 +1059,7 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/literal_in_condition.cr#L22" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/literal_in_condition.cr#L22" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1083,13 +1083,13 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
|
||||
def <strong>check_node</strong>(source, node)
|
||||
|
||||
<a class="method-permalink" href="#check_node(source,node)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#check_node%28source%2Cnode%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/literal_in_condition.cr#L32" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/literal_in_condition.cr#L32" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1099,7 +1099,7 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1113,7 +1113,7 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1127,7 +1127,7 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1141,7 +1141,7 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1155,7 +1155,7 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1169,7 +1169,7 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1183,7 +1183,7 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1197,7 +1197,7 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1211,13 +1211,13 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::If)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::If)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3AIf%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/literal_in_condition.cr#L36" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/literal_in_condition.cr#L36" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1227,13 +1227,13 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::Unless)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::Unless)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3AUnless%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/literal_in_condition.cr#L40" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/literal_in_condition.cr#L40" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1243,13 +1243,13 @@ replaced with either the body of the construct, or deleted entirely.</p>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::Case)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::Case)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3ACase%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/literal_in_condition.cr#L44" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/literal_in_condition.cr#L44" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -641,14 +646,10 @@
|
|||
|
||||
<p>A rule that disallows useless string interpolations
|
||||
that contain a literal value instead of a variable or function.</p>
|
||||
|
||||
<p>For example:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="s">"Hello, </span><span class="i">#{</span><span class="n">:Ary</span><span class="i">}</span><span class="s">"</span>
|
||||
<span class="s">"There are </span><span class="i">#{</span><span class="n">4</span><span class="i">}</span><span class="s"> cats"</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/LiteralInInterpolation
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -693,7 +694,7 @@ that contain a literal value instead of a variable or function.</p>
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/literal_in_interpolation.cr#L18" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/literal_in_interpolation.cr#L18" target="_blank">
|
||||
ameba/rule/lint/literal_in_interpolation.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -734,12 +735,12 @@ that contain a literal value instead of a variable or function.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows useless string interpolations that contain a literal value instead of a variable or function.</p></div>
|
||||
|
||||
|
|
@ -762,47 +763,47 @@ that contain a literal value instead of a variable or function.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::StringInterpolation)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::StringInterpolation)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3AStringInterpolation%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::StringInterpolation)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -819,44 +820,49 @@ that contain a literal value instead of a variable or function.</p>
|
|||
<h3>Instance methods inherited from module <code><a href="../../../Ameba/AST/Util.html">Ameba::AST::Util</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#abort?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#abort%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>abort?(node)</span>
|
||||
abort?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#exit?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#exit%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>exit?(node)</span>
|
||||
exit?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#flow_command?(node,in_loop)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#flow_command%3F%28node%2Cin_loop%29-instance-method" class="tooltip">
|
||||
<span>flow_command?(node, in_loop)</span>
|
||||
flow_command?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#flow_expression?(node,in_loop=false)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#flow_expression%3F%28node%2Cin_loop%3Dfalse%29-instance-method" class="tooltip">
|
||||
<span>flow_expression?(node, in_loop = <span class="n">false</span>)</span>
|
||||
flow_expression?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#literal?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#literal%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>literal?(node)</span>
|
||||
literal?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#loop?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#loop%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>loop?(node)</span>
|
||||
loop?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#node_source(node,code_lines)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#node_source%28node%2Ccode_lines%29-instance-method" class="tooltip">
|
||||
<span>node_source(node, code_lines)</span>
|
||||
node_source</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#raise?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#raise%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>raise?(node)</span>
|
||||
raise?</a>
|
||||
raise?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#source_between%28loc%2Cend_loc%2Ccode_lines%29%3AString%3F-instance-method" class="tooltip">
|
||||
<span>source_between(loc, end_loc, code_lines) : String?</span>
|
||||
source_between</a>
|
||||
|
||||
|
||||
|
||||
|
|
@ -893,17 +899,17 @@ that contain a literal value instead of a variable or function.</p>
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -923,12 +929,12 @@ that contain a literal value instead of a variable or function.</p>
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -998,7 +1004,7 @@ that contain a literal value instead of a variable or function.</p>
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1012,21 +1018,17 @@ that contain a literal value instead of a variable or function.</p>
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows useless string interpolations
|
||||
that contain a literal value instead of a variable or function.</p>
|
||||
|
||||
<p>For example:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="s">"Hello, </span><span class="i">#{</span><span class="n">:Ary</span><span class="i">}</span><span class="s">"</span>
|
||||
<span class="s">"There are </span><span class="i">#{</span><span class="n">4</span><span class="i">}</span><span class="s"> cats"</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/LiteralInInterpolation
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -1034,7 +1036,7 @@ that contain a literal value instead of a variable or function.</p>
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/literal_in_interpolation.cr#L18" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/literal_in_interpolation.cr#L18" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1058,7 +1060,7 @@ that contain a literal value instead of a variable or function.</p>
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1072,7 +1074,7 @@ that contain a literal value instead of a variable or function.</p>
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1086,7 +1088,7 @@ that contain a literal value instead of a variable or function.</p>
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1100,7 +1102,7 @@ that contain a literal value instead of a variable or function.</p>
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1114,7 +1116,7 @@ that contain a literal value instead of a variable or function.</p>
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1128,7 +1130,7 @@ that contain a literal value instead of a variable or function.</p>
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1142,7 +1144,7 @@ that contain a literal value instead of a variable or function.</p>
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1156,7 +1158,7 @@ that contain a literal value instead of a variable or function.</p>
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1170,13 +1172,13 @@ that contain a literal value instead of a variable or function.</p>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::StringInterpolation)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::StringInterpolation)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3AStringInterpolation%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/literal_in_interpolation.cr#L27" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/literal_in_interpolation.cr#L27" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -640,19 +645,13 @@
|
|||
</h2>
|
||||
|
||||
<p>A rule that disallows some unwanted symbols in percent array literals.</p>
|
||||
|
||||
<p>For example, this is usually written by mistake:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="s">%i(:one, :two)</span>
|
||||
<span class="s">%w("one", "two")</span></code></pre>
|
||||
|
||||
<p>And the expected example is:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="s">%i(one two)</span>
|
||||
<span class="s">%w(one two)</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/PercentArrays:
|
||||
Enabled: true
|
||||
StringArrayUnwantedSymbols: ',"'
|
||||
|
|
@ -697,7 +696,7 @@
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/percent_array.cr#L26" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/percent_array.cr#L26" target="_blank">
|
||||
ameba/rule/lint/percent_array.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -738,12 +737,12 @@
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows some unwanted symbols in percent array literals.</p></div>
|
||||
|
||||
|
|
@ -766,67 +765,67 @@
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#string_array_unwanted_symbols:String-instance-method" class="signature"><strong>#string_array_unwanted_symbols</strong> : String</a>
|
||||
<a href="#string_array_unwanted_symbols%3AString-instance-method" class="signature"><strong>#string_array_unwanted_symbols</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#string_array_unwanted_symbols=(string_array_unwanted_symbols:String)-instance-method" class="signature"><strong>#string_array_unwanted_symbols=</strong>(string_array_unwanted_symbols : String)</a>
|
||||
<a href="#string_array_unwanted_symbols%3D%28string_array_unwanted_symbols%3AString%29-instance-method" class="signature"><strong>#string_array_unwanted_symbols=</strong>(string_array_unwanted_symbols : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#symbol_array_unwanted_symbols:String-instance-method" class="signature"><strong>#symbol_array_unwanted_symbols</strong> : String</a>
|
||||
<a href="#symbol_array_unwanted_symbols%3AString-instance-method" class="signature"><strong>#symbol_array_unwanted_symbols</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#symbol_array_unwanted_symbols=(symbol_array_unwanted_symbols:String)-instance-method" class="signature"><strong>#symbol_array_unwanted_symbols=</strong>(symbol_array_unwanted_symbols : String)</a>
|
||||
<a href="#symbol_array_unwanted_symbols%3D%28symbol_array_unwanted_symbols%3AString%29-instance-method" class="signature"><strong>#symbol_array_unwanted_symbols=</strong>(symbol_array_unwanted_symbols : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source)-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
<a href="#test%28source%29-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -863,17 +862,17 @@
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -893,12 +892,12 @@
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -968,7 +967,7 @@
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -982,25 +981,19 @@
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows some unwanted symbols in percent array literals.</p>
|
||||
|
||||
<p>For example, this is usually written by mistake:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="s">%i(:one, :two)</span>
|
||||
<span class="s">%w("one", "two")</span></code></pre>
|
||||
|
||||
<p>And the expected example is:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="s">%i(one two)</span>
|
||||
<span class="s">%w(one two)</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/PercentArrays:
|
||||
Enabled: true
|
||||
StringArrayUnwantedSymbols: ',"'
|
||||
|
|
@ -1010,7 +1003,7 @@
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/percent_array.cr#L26" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/percent_array.cr#L26" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1034,7 +1027,7 @@
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1048,7 +1041,7 @@
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1062,7 +1055,7 @@
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1076,7 +1069,7 @@
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1090,7 +1083,7 @@
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1104,7 +1097,7 @@
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1118,7 +1111,7 @@
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1132,7 +1125,7 @@
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1146,7 +1139,7 @@
|
|||
|
||||
def <strong>string_array_unwanted_symbols</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#string_array_unwanted_symbols:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#string_array_unwanted_symbols%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1160,7 +1153,7 @@
|
|||
|
||||
def <strong>string_array_unwanted_symbols=</strong>(string_array_unwanted_symbols : String)
|
||||
|
||||
<a class="method-permalink" href="#string_array_unwanted_symbols=(string_array_unwanted_symbols:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#string_array_unwanted_symbols%3D%28string_array_unwanted_symbols%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1174,7 +1167,7 @@
|
|||
|
||||
def <strong>symbol_array_unwanted_symbols</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#symbol_array_unwanted_symbols:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#symbol_array_unwanted_symbols%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1188,7 +1181,7 @@
|
|||
|
||||
def <strong>symbol_array_unwanted_symbols=</strong>(symbol_array_unwanted_symbols : String)
|
||||
|
||||
<a class="method-permalink" href="#symbol_array_unwanted_symbols=(symbol_array_unwanted_symbols:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#symbol_array_unwanted_symbols%3D%28symbol_array_unwanted_symbols%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1202,13 +1195,13 @@
|
|||
|
||||
def <strong>test</strong>(source)
|
||||
|
||||
<a class="method-permalink" href="#test(source)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/percent_array.cr#L36" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/percent_array.cr#L36" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -641,19 +646,13 @@
|
|||
|
||||
<p>A rule that disallows <code>rand(0)</code> and <code>rand(1)</code> calls.
|
||||
Such calls always return <code>0</code>.</p>
|
||||
|
||||
<p>For example:</p>
|
||||
|
||||
<pre><code class="language-crystal">rand(<span class="n">1</span>)</code></pre>
|
||||
|
||||
<p>Should be written as:</p>
|
||||
|
||||
<pre><code class="language-crystal">rand
|
||||
<span class="c"># or</span>
|
||||
rand(<span class="n">2</span>)</code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/RandZero:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -696,7 +695,7 @@ rand(<span class="n">2</span>)</code></pre>
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/rand_zero.cr#L25" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/rand_zero.cr#L25" target="_blank">
|
||||
ameba/rule/lint/rand_zero.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -737,12 +736,12 @@ rand(<span class="n">2</span>)</code></pre>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows <code>rand(0)</code> and <code>rand(1)</code> calls.</p></div>
|
||||
|
||||
|
|
@ -765,47 +764,47 @@ rand(<span class="n">2</span>)</code></pre>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::Call)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Call)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3ACall%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Call)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -842,17 +841,17 @@ rand(<span class="n">2</span>)</code></pre>
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -872,12 +871,12 @@ rand(<span class="n">2</span>)</code></pre>
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -947,7 +946,7 @@ rand(<span class="n">2</span>)</code></pre>
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -961,26 +960,20 @@ rand(<span class="n">2</span>)</code></pre>
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows <code>rand(0)</code> and <code>rand(1)</code> calls.
|
||||
Such calls always return <code>0</code>.</p>
|
||||
|
||||
<p>For example:</p>
|
||||
|
||||
<pre><code class="language-crystal">rand(<span class="n">1</span>)</code></pre>
|
||||
|
||||
<p>Should be written as:</p>
|
||||
|
||||
<pre><code class="language-crystal">rand
|
||||
<span class="c"># or</span>
|
||||
rand(<span class="n">2</span>)</code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/RandZero:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -988,7 +981,7 @@ rand(<span class="n">2</span>)</code></pre>
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/rand_zero.cr#L25" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/rand_zero.cr#L25" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1012,7 +1005,7 @@ rand(<span class="n">2</span>)</code></pre>
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1026,7 +1019,7 @@ rand(<span class="n">2</span>)</code></pre>
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1040,7 +1033,7 @@ rand(<span class="n">2</span>)</code></pre>
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1054,7 +1047,7 @@ rand(<span class="n">2</span>)</code></pre>
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1068,7 +1061,7 @@ rand(<span class="n">2</span>)</code></pre>
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1082,7 +1075,7 @@ rand(<span class="n">2</span>)</code></pre>
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1096,7 +1089,7 @@ rand(<span class="n">2</span>)</code></pre>
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1110,7 +1103,7 @@ rand(<span class="n">2</span>)</code></pre>
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1124,13 +1117,13 @@ rand(<span class="n">2</span>)</code></pre>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::Call)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::Call)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3ACall%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/rand_zero.cr#L32" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/rand_zero.cr#L32" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -641,17 +646,11 @@
|
|||
|
||||
<p>A rule that disallows string conversion in string interpolation,
|
||||
which is redundant.</p>
|
||||
|
||||
<p>For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="s">"Hello, </span><span class="i">#{</span>name.to_s<span class="i">}</span><span class="s">"</span></code></pre>
|
||||
|
||||
<p>And this is valid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="s">"Hello, </span><span class="i">#{</span>name<span class="i">}</span><span class="s">"</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/RedundantStringCoersion
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -696,7 +695,7 @@ which is redundant.</p>
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/redundant_string_coercion.cr#L23" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/redundant_string_coercion.cr#L23" target="_blank">
|
||||
ameba/rule/lint/redundant_string_coercion.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -737,12 +736,12 @@ which is redundant.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows string conversion in string interpolation, which is redundant.</p></div>
|
||||
|
||||
|
|
@ -765,47 +764,47 @@ which is redundant.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::StringInterpolation)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::StringInterpolation)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3AStringInterpolation%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::StringInterpolation)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -822,44 +821,49 @@ which is redundant.</p>
|
|||
<h3>Instance methods inherited from module <code><a href="../../../Ameba/AST/Util.html">Ameba::AST::Util</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#abort?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#abort%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>abort?(node)</span>
|
||||
abort?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#exit?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#exit%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>exit?(node)</span>
|
||||
exit?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#flow_command?(node,in_loop)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#flow_command%3F%28node%2Cin_loop%29-instance-method" class="tooltip">
|
||||
<span>flow_command?(node, in_loop)</span>
|
||||
flow_command?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#flow_expression?(node,in_loop=false)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#flow_expression%3F%28node%2Cin_loop%3Dfalse%29-instance-method" class="tooltip">
|
||||
<span>flow_expression?(node, in_loop = <span class="n">false</span>)</span>
|
||||
flow_expression?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#literal?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#literal%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>literal?(node)</span>
|
||||
literal?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#loop?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#loop%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>loop?(node)</span>
|
||||
loop?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#node_source(node,code_lines)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#node_source%28node%2Ccode_lines%29-instance-method" class="tooltip">
|
||||
<span>node_source(node, code_lines)</span>
|
||||
node_source</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#raise?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#raise%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>raise?(node)</span>
|
||||
raise?</a>
|
||||
raise?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#source_between%28loc%2Cend_loc%2Ccode_lines%29%3AString%3F-instance-method" class="tooltip">
|
||||
<span>source_between(loc, end_loc, code_lines) : String?</span>
|
||||
source_between</a>
|
||||
|
||||
|
||||
|
||||
|
|
@ -896,17 +900,17 @@ which is redundant.</p>
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -926,12 +930,12 @@ which is redundant.</p>
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -1001,7 +1005,7 @@ which is redundant.</p>
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1015,24 +1019,18 @@ which is redundant.</p>
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows string conversion in string interpolation,
|
||||
which is redundant.</p>
|
||||
|
||||
<p>For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="s">"Hello, </span><span class="i">#{</span>name.to_s<span class="i">}</span><span class="s">"</span></code></pre>
|
||||
|
||||
<p>And this is valid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="s">"Hello, </span><span class="i">#{</span>name<span class="i">}</span><span class="s">"</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/RedundantStringCoersion
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -1040,7 +1038,7 @@ which is redundant.</p>
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/redundant_string_coercion.cr#L23" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/redundant_string_coercion.cr#L23" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1064,7 +1062,7 @@ which is redundant.</p>
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1078,7 +1076,7 @@ which is redundant.</p>
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1092,7 +1090,7 @@ which is redundant.</p>
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1106,7 +1104,7 @@ which is redundant.</p>
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1120,7 +1118,7 @@ which is redundant.</p>
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1134,7 +1132,7 @@ which is redundant.</p>
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1148,7 +1146,7 @@ which is redundant.</p>
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1162,7 +1160,7 @@ which is redundant.</p>
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1176,13 +1174,13 @@ which is redundant.</p>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::StringInterpolation)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::StringInterpolation)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3AStringInterpolation%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/redundant_string_coercion.cr#L32" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/redundant_string_coercion.cr#L32" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -640,9 +645,7 @@
|
|||
</h2>
|
||||
|
||||
<p>A rule that disallows redundant <code>with_index</code> calls.</p>
|
||||
|
||||
<p>For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal">collection.each.with_index <span class="k">do</span> <span class="o">|</span>e<span class="o">|</span>
|
||||
<span class="c"># ...</span>
|
||||
<span class="k">end</span>
|
||||
|
|
@ -650,15 +653,11 @@
|
|||
collection.each_with_index <span class="k">do</span> <span class="o">|</span>e, _<span class="o">|</span>
|
||||
<span class="c"># ...</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>and it should be written as follows:</p>
|
||||
|
||||
<pre><code class="language-crystal">collection.each <span class="k">do</span> <span class="o">|</span>e<span class="o">|</span>
|
||||
<span class="c"># ...</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/RedundantWithIndex:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -701,7 +700,7 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/redundant_with_index.cr#L29" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/redundant_with_index.cr#L29" target="_blank">
|
||||
ameba/rule/lint/redundant_with_index.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -723,12 +722,12 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows redundant <code>with_index</code> calls.</p></div>
|
||||
|
||||
|
|
@ -751,47 +750,47 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::Call)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Call)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3ACall%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Call)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -828,17 +827,17 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -858,12 +857,12 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -933,7 +932,7 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -947,15 +946,13 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows redundant <code>with_index</code> calls.</p>
|
||||
|
||||
<p>For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal">collection.each.with_index <span class="k">do</span> <span class="o">|</span>e<span class="o">|</span>
|
||||
<span class="c"># ...</span>
|
||||
<span class="k">end</span>
|
||||
|
|
@ -963,15 +960,11 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
collection.each_with_index <span class="k">do</span> <span class="o">|</span>e, _<span class="o">|</span>
|
||||
<span class="c"># ...</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>and it should be written as follows:</p>
|
||||
|
||||
<pre><code class="language-crystal">collection.each <span class="k">do</span> <span class="o">|</span>e<span class="o">|</span>
|
||||
<span class="c"># ...</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/RedundantWithIndex:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -979,7 +972,7 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/redundant_with_index.cr#L29" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/redundant_with_index.cr#L29" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1003,7 +996,7 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1017,7 +1010,7 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1031,7 +1024,7 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1045,7 +1038,7 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1059,7 +1052,7 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1073,7 +1066,7 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1087,7 +1080,7 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1101,7 +1094,7 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1115,13 +1108,13 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::Call)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::Call)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3ACall%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/redundant_with_index.cr#L34" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/redundant_with_index.cr#L34" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -640,9 +645,7 @@
|
|||
</h2>
|
||||
|
||||
<p>A rule that disallows redundant <code>each_with_object</code> calls.</p>
|
||||
|
||||
<p>For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal">collection.each_with_object(<span class="n">0</span>) <span class="k">do</span> <span class="o">|</span>e<span class="o">|</span>
|
||||
<span class="c"># ...</span>
|
||||
<span class="k">end</span>
|
||||
|
|
@ -650,15 +653,11 @@
|
|||
collection.each_with_object(<span class="n">0</span>) <span class="k">do</span> <span class="o">|</span>e, _<span class="o">|</span>
|
||||
<span class="c"># ...</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>and it should be written as follows:</p>
|
||||
|
||||
<pre><code class="language-crystal">collection.each <span class="k">do</span> <span class="o">|</span>e<span class="o">|</span>
|
||||
<span class="c"># ...</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/RedundantWithObject:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -701,7 +700,7 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/redundant_with_object.cr#L30" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/redundant_with_object.cr#L30" target="_blank">
|
||||
ameba/rule/lint/redundant_with_object.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -742,12 +741,12 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows redundant <code>each_with_object</code> calls.</p></div>
|
||||
|
||||
|
|
@ -770,47 +769,47 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::Call)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Call)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3ACall%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Call)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -847,17 +846,17 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -877,12 +876,12 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -952,7 +951,7 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -966,15 +965,13 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows redundant <code>each_with_object</code> calls.</p>
|
||||
|
||||
<p>For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal">collection.each_with_object(<span class="n">0</span>) <span class="k">do</span> <span class="o">|</span>e<span class="o">|</span>
|
||||
<span class="c"># ...</span>
|
||||
<span class="k">end</span>
|
||||
|
|
@ -982,15 +979,11 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
collection.each_with_object(<span class="n">0</span>) <span class="k">do</span> <span class="o">|</span>e, _<span class="o">|</span>
|
||||
<span class="c"># ...</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>and it should be written as follows:</p>
|
||||
|
||||
<pre><code class="language-crystal">collection.each <span class="k">do</span> <span class="o">|</span>e<span class="o">|</span>
|
||||
<span class="c"># ...</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/RedundantWithObject:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -998,7 +991,7 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/redundant_with_object.cr#L30" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/redundant_with_object.cr#L30" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1022,7 +1015,7 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1036,7 +1029,7 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1050,7 +1043,7 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1064,7 +1057,7 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1078,7 +1071,7 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1092,7 +1085,7 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1106,7 +1099,7 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1120,7 +1113,7 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1134,13 +1127,13 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::Call)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::Call)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3ACall%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/redundant_with_object.cr#L37" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/redundant_with_object.cr#L37" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -640,9 +645,7 @@
|
|||
</h2>
|
||||
|
||||
<p>A rule that disallows shadowed arguments.</p>
|
||||
|
||||
<p>For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal">do_something <span class="k">do</span> <span class="o">|</span>foo<span class="o">|</span>
|
||||
foo <span class="o">=</span> <span class="n">1</span> <span class="c"># shadows block argument</span>
|
||||
foo
|
||||
|
|
@ -652,9 +655,7 @@
|
|||
foo <span class="o">=</span> <span class="n">1</span> <span class="c"># shadows method argument</span>
|
||||
foo
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>and it should be written as follows:</p>
|
||||
|
||||
<pre><code class="language-crystal">do_something <span class="k">do</span> <span class="o">|</span>foo<span class="o">|</span>
|
||||
foo <span class="o">=</span> foo <span class="o">+</span> <span class="n">42</span>
|
||||
foo
|
||||
|
|
@ -664,9 +665,7 @@
|
|||
foo <span class="o">=</span> foo <span class="o">+</span> <span class="n">42</span>
|
||||
foo
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/ShadowedArgument:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -709,7 +708,7 @@
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/shadowed_argument.cr#L38" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/shadowed_argument.cr#L38" target="_blank">
|
||||
ameba/rule/lint/shadowed_argument.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -750,12 +749,12 @@
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows shadowed arguments.</p></div>
|
||||
|
||||
|
|
@ -778,52 +777,52 @@
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node,scope:AST::Scope)-instance-method" class="signature"><strong>#test</strong>(source, node, scope : AST::Scope)</a>
|
||||
<a href="#test%28source%2Cnode%2Cscope%3AAST%3A%3AScope%29-instance-method" class="signature"><strong>#test</strong>(source, node, scope : AST::Scope)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source)-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
<a href="#test%28source%29-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -860,17 +859,17 @@
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -890,12 +889,12 @@
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -965,7 +964,7 @@
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -979,15 +978,13 @@
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows shadowed arguments.</p>
|
||||
|
||||
<p>For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal">do_something <span class="k">do</span> <span class="o">|</span>foo<span class="o">|</span>
|
||||
foo <span class="o">=</span> <span class="n">1</span> <span class="c"># shadows block argument</span>
|
||||
foo
|
||||
|
|
@ -997,9 +994,7 @@
|
|||
foo <span class="o">=</span> <span class="n">1</span> <span class="c"># shadows method argument</span>
|
||||
foo
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>and it should be written as follows:</p>
|
||||
|
||||
<pre><code class="language-crystal">do_something <span class="k">do</span> <span class="o">|</span>foo<span class="o">|</span>
|
||||
foo <span class="o">=</span> foo <span class="o">+</span> <span class="n">42</span>
|
||||
foo
|
||||
|
|
@ -1009,9 +1004,7 @@
|
|||
foo <span class="o">=</span> foo <span class="o">+</span> <span class="n">42</span>
|
||||
foo
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/ShadowedArgument:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -1019,7 +1012,7 @@
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/shadowed_argument.cr#L38" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/shadowed_argument.cr#L38" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1043,7 +1036,7 @@
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1057,7 +1050,7 @@
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1071,7 +1064,7 @@
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1085,7 +1078,7 @@
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1099,7 +1092,7 @@
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1113,7 +1106,7 @@
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1127,7 +1120,7 @@
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1141,7 +1134,7 @@
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1155,13 +1148,13 @@
|
|||
|
||||
def <strong>test</strong>(source, node, scope : <a href="../../../Ameba/AST/Scope.html">AST::Scope</a>)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node,scope:AST::Scope)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%2Cscope%3AAST%3A%3AScope%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/shadowed_argument.cr#L49" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/shadowed_argument.cr#L49" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1171,13 +1164,13 @@
|
|||
|
||||
def <strong>test</strong>(source)
|
||||
|
||||
<a class="method-permalink" href="#test(source)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/shadowed_argument.cr#L45" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/shadowed_argument.cr#L45" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -642,9 +647,7 @@
|
|||
<p>A rule that disallows a rescued exception that get shadowed by a
|
||||
less specific exception being rescued before a more specific
|
||||
exception is rescued.</p>
|
||||
|
||||
<p>For example, this is invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">begin</span>
|
||||
do_something
|
||||
<span class="k">rescue</span> <span class="t">Exception</span>
|
||||
|
|
@ -652,9 +655,7 @@ exception is rescued.</p>
|
|||
<span class="k">rescue</span> <span class="t">ArgumentError</span>
|
||||
handle_argument_error_exception
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And it has to be written as follows:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">begin</span>
|
||||
do_something
|
||||
<span class="k">rescue</span> <span class="t">ArgumentError</span>
|
||||
|
|
@ -662,9 +663,7 @@ exception is rescued.</p>
|
|||
<span class="k">rescue</span> <span class="t">Exception</span>
|
||||
handle_exception
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/ShadowedException:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -707,7 +706,7 @@ exception is rescued.</p>
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/shadowed_exception.cr#L36" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/shadowed_exception.cr#L36" target="_blank">
|
||||
ameba/rule/lint/shadowed_exception.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -748,12 +747,12 @@ exception is rescued.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows a rescued exception that get shadowed by a less specific exception being rescued before a more specific exception is rescued.</p></div>
|
||||
|
||||
|
|
@ -776,47 +775,47 @@ exception is rescued.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::ExceptionHandler)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::ExceptionHandler)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3AExceptionHandler%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::ExceptionHandler)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -853,17 +852,17 @@ exception is rescued.</p>
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -883,12 +882,12 @@ exception is rescued.</p>
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -958,7 +957,7 @@ exception is rescued.</p>
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -972,7 +971,7 @@ exception is rescued.</p>
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
|
@ -980,9 +979,7 @@ exception is rescued.</p>
|
|||
<p>A rule that disallows a rescued exception that get shadowed by a
|
||||
less specific exception being rescued before a more specific
|
||||
exception is rescued.</p>
|
||||
|
||||
<p>For example, this is invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">begin</span>
|
||||
do_something
|
||||
<span class="k">rescue</span> <span class="t">Exception</span>
|
||||
|
|
@ -990,9 +987,7 @@ exception is rescued.</p>
|
|||
<span class="k">rescue</span> <span class="t">ArgumentError</span>
|
||||
handle_argument_error_exception
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And it has to be written as follows:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">begin</span>
|
||||
do_something
|
||||
<span class="k">rescue</span> <span class="t">ArgumentError</span>
|
||||
|
|
@ -1000,9 +995,7 @@ exception is rescued.</p>
|
|||
<span class="k">rescue</span> <span class="t">Exception</span>
|
||||
handle_exception
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/ShadowedException:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -1010,7 +1003,7 @@ exception is rescued.</p>
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/shadowed_exception.cr#L36" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/shadowed_exception.cr#L36" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1034,7 +1027,7 @@ exception is rescued.</p>
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1048,7 +1041,7 @@ exception is rescued.</p>
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1062,7 +1055,7 @@ exception is rescued.</p>
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1076,7 +1069,7 @@ exception is rescued.</p>
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1090,7 +1083,7 @@ exception is rescued.</p>
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1104,7 +1097,7 @@ exception is rescued.</p>
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1118,7 +1111,7 @@ exception is rescued.</p>
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1132,7 +1125,7 @@ exception is rescued.</p>
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1146,13 +1139,13 @@ exception is rescued.</p>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::ExceptionHandler)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::ExceptionHandler)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3AExceptionHandler%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/shadowed_exception.cr#L43" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/shadowed_exception.cr#L43" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -641,27 +646,21 @@
|
|||
|
||||
<p>A rule that disallows the usage of the same name as outer local variables
|
||||
for block or proc arguments.</p>
|
||||
|
||||
<p>For example, this is considered incorrect:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">some_method</span>
|
||||
foo <span class="o">=</span> <span class="n">1</span>
|
||||
|
||||
<span class="n">3</span>.times <span class="k">do</span> <span class="o">|</span>foo<span class="o">|</span> <span class="c"># shadowing outer `foo`</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>and should be written as:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">some_method</span>
|
||||
foo <span class="o">=</span> <span class="n">1</span>
|
||||
|
||||
<span class="n">3</span>.times <span class="k">do</span> <span class="o">|</span>bar<span class="o">|</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/ShadowingOuterLocalVar:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -704,7 +703,7 @@ for block or proc arguments.</p>
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/shadowing_local_outer_var.cr#L33" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/shadowing_local_outer_var.cr#L33" target="_blank">
|
||||
ameba/rule/lint/shadowing_local_outer_var.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -745,12 +744,12 @@ for block or proc arguments.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows the usage of the same name as outer local variables for block or proc arguments.</p></div>
|
||||
|
||||
|
|
@ -773,57 +772,57 @@ for block or proc arguments.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::ProcLiteral,scope:AST::Scope)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::ProcLiteral, scope : AST::Scope)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3AProcLiteral%2Cscope%3AAST%3A%3AScope%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::ProcLiteral, scope : AST::Scope)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::Block,scope:AST::Scope)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Block, scope : AST::Scope)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3ABlock%2Cscope%3AAST%3A%3AScope%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Block, scope : AST::Scope)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source)-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
<a href="#test%28source%29-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -860,17 +859,17 @@ for block or proc arguments.</p>
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -890,12 +889,12 @@ for block or proc arguments.</p>
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -965,7 +964,7 @@ for block or proc arguments.</p>
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -979,34 +978,28 @@ for block or proc arguments.</p>
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows the usage of the same name as outer local variables
|
||||
for block or proc arguments.</p>
|
||||
|
||||
<p>For example, this is considered incorrect:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">some_method</span>
|
||||
foo <span class="o">=</span> <span class="n">1</span>
|
||||
|
||||
<span class="n">3</span>.times <span class="k">do</span> <span class="o">|</span>foo<span class="o">|</span> <span class="c"># shadowing outer `foo`</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>and should be written as:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">some_method</span>
|
||||
foo <span class="o">=</span> <span class="n">1</span>
|
||||
|
||||
<span class="n">3</span>.times <span class="k">do</span> <span class="o">|</span>bar<span class="o">|</span>
|
||||
<span class="k">end</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/ShadowingOuterLocalVar:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -1014,7 +1007,7 @@ for block or proc arguments.</p>
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/shadowing_local_outer_var.cr#L33" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/shadowing_local_outer_var.cr#L33" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1038,7 +1031,7 @@ for block or proc arguments.</p>
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1052,7 +1045,7 @@ for block or proc arguments.</p>
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1066,7 +1059,7 @@ for block or proc arguments.</p>
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1080,7 +1073,7 @@ for block or proc arguments.</p>
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1094,7 +1087,7 @@ for block or proc arguments.</p>
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1108,7 +1101,7 @@ for block or proc arguments.</p>
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1122,7 +1115,7 @@ for block or proc arguments.</p>
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1136,7 +1129,7 @@ for block or proc arguments.</p>
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1150,13 +1143,13 @@ for block or proc arguments.</p>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::ProcLiteral, scope : <a href="../../../Ameba/AST/Scope.html">AST::Scope</a>)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::ProcLiteral,scope:AST::Scope)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3AProcLiteral%2Cscope%3AAST%3A%3AScope%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/shadowing_local_outer_var.cr#L45" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/shadowing_local_outer_var.cr#L45" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1166,13 +1159,13 @@ for block or proc arguments.</p>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::Block, scope : <a href="../../../Ameba/AST/Scope.html">AST::Scope</a>)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::Block,scope:AST::Scope)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3ABlock%2Cscope%3AAST%3A%3AScope%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/shadowing_local_outer_var.cr#L49" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/shadowing_local_outer_var.cr#L49" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1182,13 +1175,13 @@ for block or proc arguments.</p>
|
|||
|
||||
def <strong>test</strong>(source)
|
||||
|
||||
<a class="method-permalink" href="#test(source)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/shadowing_local_outer_var.cr#L41" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/shadowing_local_outer_var.cr#L41" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -641,11 +646,8 @@
|
|||
|
||||
<p>A rule that disallows using shared variables in fibers,
|
||||
which are mutated during iterations.</p>
|
||||
|
||||
<p>In most cases it leads to unexpected behaviour and is undesired.</p>
|
||||
|
||||
<p>For example, having this example:</p>
|
||||
|
||||
<pre><code class="language-crystal">n <span class="o">=</span> <span class="n">0</span>
|
||||
channel <span class="o">=</span> <span class="t">Channel</span>(<span class="t">Int32</span>).<span class="k">new</span>
|
||||
|
||||
|
|
@ -655,12 +657,9 @@ channel <span class="o">=</span> <span class="t">Channel</span>(<span class="t">
|
|||
<span class="k">end</span>
|
||||
|
||||
<span class="n">3</span>.times { puts channel.receive } <span class="c"># => # 3, 3, 3</span></code></pre>
|
||||
|
||||
<p>The problem is there is only one shared between fibers variable <code>n</code>
|
||||
and when <code>channel.receive</code> is executed its value is <code>3</code>.</p>
|
||||
|
||||
<p>To solve this, the code above needs to be rewritten to the following:</p>
|
||||
|
||||
<pre><code class="language-crystal">n <span class="o">=</span> <span class="n">0</span>
|
||||
channel <span class="o">=</span> <span class="t">Channel</span>(<span class="t">Int32</span>).<span class="k">new</span>
|
||||
|
||||
|
|
@ -671,16 +670,12 @@ channel <span class="o">=</span> <span class="t">Channel</span>(<span class="t">
|
|||
<span class="k">end</span>
|
||||
|
||||
<span class="n">3</span>.times { puts channel.receive } <span class="c"># => # 1, 2, 3</span></code></pre>
|
||||
|
||||
<p>This rule is able to find the shared variables between fibers, which are mutated
|
||||
during iterations. So it reports the issue on the first sample and passes on
|
||||
the second one.</p>
|
||||
|
||||
<p>There are also other technics to solve the problem above which are
|
||||
<a href="https://crystal-lang.org/reference/guides/concurrency.html">officially documented</a></p>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/SharedVarInFiber:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -723,7 +718,7 @@ the second one.</p>
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/shared_var_in_fiber.cr#L52" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/shared_var_in_fiber.cr#L52" target="_blank">
|
||||
ameba/rule/lint/shared_var_in_fiber.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -764,12 +759,12 @@ the second one.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows using shared variables in fibers, which are mutated during iterations.</p></div>
|
||||
|
||||
|
|
@ -792,52 +787,52 @@ the second one.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node,scope:AST::Scope)-instance-method" class="signature"><strong>#test</strong>(source, node, scope : AST::Scope)</a>
|
||||
<a href="#test%28source%2Cnode%2Cscope%3AAST%3A%3AScope%29-instance-method" class="signature"><strong>#test</strong>(source, node, scope : AST::Scope)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source)-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
<a href="#test%28source%29-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -874,17 +869,17 @@ the second one.</p>
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -904,12 +899,12 @@ the second one.</p>
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -979,7 +974,7 @@ the second one.</p>
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -993,18 +988,15 @@ the second one.</p>
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows using shared variables in fibers,
|
||||
which are mutated during iterations.</p>
|
||||
|
||||
<p>In most cases it leads to unexpected behaviour and is undesired.</p>
|
||||
|
||||
<p>For example, having this example:</p>
|
||||
|
||||
<pre><code class="language-crystal">n <span class="o">=</span> <span class="n">0</span>
|
||||
channel <span class="o">=</span> <span class="t">Channel</span>(<span class="t">Int32</span>).<span class="k">new</span>
|
||||
|
||||
|
|
@ -1014,12 +1006,9 @@ channel <span class="o">=</span> <span class="t">Channel</span>(<span class="t">
|
|||
<span class="k">end</span>
|
||||
|
||||
<span class="n">3</span>.times { puts channel.receive } <span class="c"># => # 3, 3, 3</span></code></pre>
|
||||
|
||||
<p>The problem is there is only one shared between fibers variable <code>n</code>
|
||||
and when <code>channel.receive</code> is executed its value is <code>3</code>.</p>
|
||||
|
||||
<p>To solve this, the code above needs to be rewritten to the following:</p>
|
||||
|
||||
<pre><code class="language-crystal">n <span class="o">=</span> <span class="n">0</span>
|
||||
channel <span class="o">=</span> <span class="t">Channel</span>(<span class="t">Int32</span>).<span class="k">new</span>
|
||||
|
||||
|
|
@ -1030,16 +1019,12 @@ channel <span class="o">=</span> <span class="t">Channel</span>(<span class="t">
|
|||
<span class="k">end</span>
|
||||
|
||||
<span class="n">3</span>.times { puts channel.receive } <span class="c"># => # 1, 2, 3</span></code></pre>
|
||||
|
||||
<p>This rule is able to find the shared variables between fibers, which are mutated
|
||||
during iterations. So it reports the issue on the first sample and passes on
|
||||
the second one.</p>
|
||||
|
||||
<p>There are also other technics to solve the problem above which are
|
||||
<a href="https://crystal-lang.org/reference/guides/concurrency.html">officially documented</a></p>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/SharedVarInFiber:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -1047,7 +1032,7 @@ the second one.</p>
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/shared_var_in_fiber.cr#L52" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/shared_var_in_fiber.cr#L52" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1071,7 +1056,7 @@ the second one.</p>
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1085,7 +1070,7 @@ the second one.</p>
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1099,7 +1084,7 @@ the second one.</p>
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1113,7 +1098,7 @@ the second one.</p>
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1127,7 +1112,7 @@ the second one.</p>
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1141,7 +1126,7 @@ the second one.</p>
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1155,7 +1140,7 @@ the second one.</p>
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1169,7 +1154,7 @@ the second one.</p>
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1183,13 +1168,13 @@ the second one.</p>
|
|||
|
||||
def <strong>test</strong>(source, node, scope : <a href="../../../Ameba/AST/Scope.html">AST::Scope</a>)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node,scope:AST::Scope)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%2Cscope%3AAST%3A%3AScope%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/shared_var_in_fiber.cr#L63" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/shared_var_in_fiber.cr#L63" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1199,13 +1184,13 @@ the second one.</p>
|
|||
|
||||
def <strong>test</strong>(source)
|
||||
|
||||
<a class="method-permalink" href="#test(source)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/shared_var_in_fiber.cr#L59" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/shared_var_in_fiber.cr#L59" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -640,14 +645,11 @@
|
|||
</h2>
|
||||
|
||||
<p>Checks if specs are focused.</p>
|
||||
|
||||
<p>In specs <code>focus: true</code> is mainly used to focus on a spec
|
||||
item locally during development. However, if such change
|
||||
is committed, it silently runs only focused spec on all
|
||||
other environment, which is undesired.</p>
|
||||
|
||||
<p>This is considered bad:</p>
|
||||
|
||||
<pre><code class="language-crystal">describe <span class="t">MyClass</span>, focus: <span class="n">true</span> <span class="k">do</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
|
|
@ -659,9 +661,7 @@ context <span class="s">"my context"</span>, focus: <span class="n">tr
|
|||
|
||||
it <span class="s">"works"</span>, focus: <span class="n">true</span> <span class="k">do</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And it should be written as the following:</p>
|
||||
|
||||
<pre><code class="language-crystal">describe <span class="t">MyClass</span> <span class="k">do</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
|
|
@ -673,9 +673,7 @@ context <span class="s">"my context"</span> <span class="k">do</span>
|
|||
|
||||
it <span class="s">"works"</span> <span class="k">do</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/SpecFocus:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -718,7 +716,7 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/spec_focus.cr#L47" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/spec_focus.cr#L47" target="_blank">
|
||||
ameba/rule/lint/spec_focus.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -764,12 +762,12 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>Checks if specs are focused.</p></div>
|
||||
|
||||
|
|
@ -792,52 +790,52 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::Call)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Call)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3ACall%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Call)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source)-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
<a href="#test%28source%29-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -874,17 +872,17 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -904,12 +902,12 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -979,7 +977,7 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -993,20 +991,17 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>Checks if specs are focused.</p>
|
||||
|
||||
<p>In specs <code>focus: true</code> is mainly used to focus on a spec
|
||||
item locally during development. However, if such change
|
||||
is committed, it silently runs only focused spec on all
|
||||
other environment, which is undesired.</p>
|
||||
|
||||
<p>This is considered bad:</p>
|
||||
|
||||
<pre><code class="language-crystal">describe <span class="t">MyClass</span>, focus: <span class="n">true</span> <span class="k">do</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
|
|
@ -1018,9 +1013,7 @@ context <span class="s">"my context"</span>, focus: <span class="n">tr
|
|||
|
||||
it <span class="s">"works"</span>, focus: <span class="n">true</span> <span class="k">do</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And it should be written as the following:</p>
|
||||
|
||||
<pre><code class="language-crystal">describe <span class="t">MyClass</span> <span class="k">do</span>
|
||||
<span class="k">end</span>
|
||||
|
||||
|
|
@ -1032,9 +1025,7 @@ context <span class="s">"my context"</span> <span class="k">do</span>
|
|||
|
||||
it <span class="s">"works"</span> <span class="k">do</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/SpecFocus:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -1042,7 +1033,7 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/spec_focus.cr#L47" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/spec_focus.cr#L47" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1066,7 +1057,7 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1080,7 +1071,7 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1094,7 +1085,7 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1108,7 +1099,7 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1122,7 +1113,7 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1136,7 +1127,7 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1150,7 +1141,7 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1164,7 +1155,7 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1178,13 +1169,13 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::Call)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::Call)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3ACall%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/spec_focus.cr#L61" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/spec_focus.cr#L61" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1194,13 +1185,13 @@ it <span class="s">"works"</span> <span class="k">do</span>
|
|||
|
||||
def <strong>test</strong>(source)
|
||||
|
||||
<a class="method-permalink" href="#test(source)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/spec_focus.cr#L55" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/spec_focus.cr#L55" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -640,16 +645,12 @@
|
|||
</h2>
|
||||
|
||||
<p>A rule that reports invalid Crystal syntax.</p>
|
||||
|
||||
<p>For example, this syntax is invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">hello</span>
|
||||
do_something
|
||||
<span class="k">rescue</span> <span class="t">Exception</span> => e
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And should be properly written:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">hello</span>
|
||||
do_something
|
||||
<span class="k">rescue</span> e : <span class="t">Exception</span>
|
||||
|
|
@ -694,7 +695,7 @@
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/syntax.cr#L21" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/syntax.cr#L21" target="_blank">
|
||||
ameba/rule/lint/syntax.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -716,12 +717,12 @@
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that reports invalid Crystal syntax.</p></div>
|
||||
|
||||
|
|
@ -744,47 +745,47 @@
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity:Ameba::Severity)-instance-method" class="signature"><strong>#severity=</strong>(severity : Ameba::Severity)</a>
|
||||
<a href="#severity%3D%28severity%3AAmeba%3A%3ASeverity%29-instance-method" class="signature"><strong>#severity=</strong>(severity : Ameba::Severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source)-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
<a href="#test%28source%29-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -821,17 +822,17 @@
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -851,12 +852,12 @@
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -926,7 +927,7 @@
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -940,22 +941,18 @@
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that reports invalid Crystal syntax.</p>
|
||||
|
||||
<p>For example, this syntax is invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">hello</span>
|
||||
do_something
|
||||
<span class="k">rescue</span> <span class="t">Exception</span> => e
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And should be properly written:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">hello</span>
|
||||
do_something
|
||||
<span class="k">rescue</span> e : <span class="t">Exception</span>
|
||||
|
|
@ -965,7 +962,7 @@
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/syntax.cr#L21" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/syntax.cr#L21" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -989,7 +986,7 @@
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1003,7 +1000,7 @@
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1017,7 +1014,7 @@
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1031,7 +1028,7 @@
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1045,7 +1042,7 @@
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1059,7 +1056,7 @@
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1073,7 +1070,7 @@
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1087,7 +1084,7 @@
|
|||
|
||||
def <strong>severity=</strong>(severity : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity:Ameba::Severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%3AAmeba%3A%3ASeverity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1101,13 +1098,13 @@
|
|||
|
||||
def <strong>test</strong>(source)
|
||||
|
||||
<a class="method-permalink" href="#test(source)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/syntax.cr#L27" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/syntax.cr#L27" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -641,21 +646,16 @@
|
|||
|
||||
<p>A rule that reports unneeded disable directives.
|
||||
For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="c"># ameba:disable Style/PredicateName</span>
|
||||
<span class="k">def</span> <span class="m">comment?</span>
|
||||
do_something
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>as the predicate name is correct and the comment directive does not
|
||||
have any effect, the snippet should be written as the following:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">comment?</span>
|
||||
do_something
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/UnneededDisableDirective
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -698,7 +698,7 @@ have any effect, the snippet should be written as the following:</p>
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/unneeded_disable_directive.cr#L27" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/unneeded_disable_directive.cr#L27" target="_blank">
|
||||
ameba/rule/lint/unneeded_disable_directive.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -739,12 +739,12 @@ have any effect, the snippet should be written as the following:</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that reports unneeded disable directives.</p></div>
|
||||
|
||||
|
|
@ -767,47 +767,47 @@ have any effect, the snippet should be written as the following:</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source)-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
<a href="#test%28source%29-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -844,17 +844,17 @@ have any effect, the snippet should be written as the following:</p>
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -874,12 +874,12 @@ have any effect, the snippet should be written as the following:</p>
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -949,7 +949,7 @@ have any effect, the snippet should be written as the following:</p>
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -963,28 +963,23 @@ have any effect, the snippet should be written as the following:</p>
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that reports unneeded disable directives.
|
||||
For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="c"># ameba:disable Style/PredicateName</span>
|
||||
<span class="k">def</span> <span class="m">comment?</span>
|
||||
do_something
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>as the predicate name is correct and the comment directive does not
|
||||
have any effect, the snippet should be written as the following:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">comment?</span>
|
||||
do_something
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/UnneededDisableDirective
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -992,7 +987,7 @@ have any effect, the snippet should be written as the following:</p>
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/unneeded_disable_directive.cr#L27" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/unneeded_disable_directive.cr#L27" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1016,7 +1011,7 @@ have any effect, the snippet should be written as the following:</p>
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1030,7 +1025,7 @@ have any effect, the snippet should be written as the following:</p>
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1044,7 +1039,7 @@ have any effect, the snippet should be written as the following:</p>
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1058,7 +1053,7 @@ have any effect, the snippet should be written as the following:</p>
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1072,7 +1067,7 @@ have any effect, the snippet should be written as the following:</p>
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1086,7 +1081,7 @@ have any effect, the snippet should be written as the following:</p>
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1100,7 +1095,7 @@ have any effect, the snippet should be written as the following:</p>
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1114,7 +1109,7 @@ have any effect, the snippet should be written as the following:</p>
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1128,13 +1123,13 @@ have any effect, the snippet should be written as the following:</p>
|
|||
|
||||
def <strong>test</strong>(source)
|
||||
|
||||
<a class="method-permalink" href="#test(source)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/unneeded_disable_directive.cr#L34" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/unneeded_disable_directive.cr#L34" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -640,35 +645,27 @@
|
|||
</h2>
|
||||
|
||||
<p>A rule that reports unreachable code.</p>
|
||||
|
||||
<p>For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>(a)
|
||||
<span class="k">return</span> <span class="n">42</span>
|
||||
a <span class="o">+</span> <span class="n">1</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<pre><code class="language-crystal">a <span class="o">=</span> <span class="n">1</span>
|
||||
loop <span class="k">do</span>
|
||||
<span class="k">break</span>
|
||||
a += <span class="n">1</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And has to be written as the following:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>(a)
|
||||
<span class="k">return</span> <span class="n">42</span> <span class="k">if</span> a <span class="o">==</span> <span class="n">0</span>
|
||||
a <span class="o">+</span> <span class="n">1</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<pre><code class="language-crystal">a <span class="o">=</span> <span class="n">1</span>
|
||||
loop <span class="k">do</span>
|
||||
<span class="k">break</span> a <span class="o">></span> <span class="n">3</span>
|
||||
a += <span class="n">1</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/UnreachableCode:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -713,7 +710,7 @@ loop <span class="k">do</span>
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/unreachable_code.cr#L44" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/unreachable_code.cr#L44" target="_blank">
|
||||
ameba/rule/lint/unreachable_code.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -754,12 +751,12 @@ loop <span class="k">do</span>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that reports unreachable code.</p></div>
|
||||
|
||||
|
|
@ -782,52 +779,52 @@ loop <span class="k">do</span>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node,flow_expression:AST::FlowExpression)-instance-method" class="signature"><strong>#test</strong>(source, node, flow_expression : AST::FlowExpression)</a>
|
||||
<a href="#test%28source%2Cnode%2Cflow_expression%3AAST%3A%3AFlowExpression%29-instance-method" class="signature"><strong>#test</strong>(source, node, flow_expression : AST::FlowExpression)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source)-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
<a href="#test%28source%29-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -844,44 +841,49 @@ loop <span class="k">do</span>
|
|||
<h3>Instance methods inherited from module <code><a href="../../../Ameba/AST/Util.html">Ameba::AST::Util</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#abort?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#abort%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>abort?(node)</span>
|
||||
abort?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#exit?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#exit%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>exit?(node)</span>
|
||||
exit?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#flow_command?(node,in_loop)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#flow_command%3F%28node%2Cin_loop%29-instance-method" class="tooltip">
|
||||
<span>flow_command?(node, in_loop)</span>
|
||||
flow_command?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#flow_expression?(node,in_loop=false)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#flow_expression%3F%28node%2Cin_loop%3Dfalse%29-instance-method" class="tooltip">
|
||||
<span>flow_expression?(node, in_loop = <span class="n">false</span>)</span>
|
||||
flow_expression?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#literal?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#literal%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>literal?(node)</span>
|
||||
literal?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#loop?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#loop%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>loop?(node)</span>
|
||||
loop?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#node_source(node,code_lines)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#node_source%28node%2Ccode_lines%29-instance-method" class="tooltip">
|
||||
<span>node_source(node, code_lines)</span>
|
||||
node_source</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#raise?(node)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/AST/Util.html#raise%3F%28node%29-instance-method" class="tooltip">
|
||||
<span>raise?(node)</span>
|
||||
raise?</a>
|
||||
raise?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/AST/Util.html#source_between%28loc%2Cend_loc%2Ccode_lines%29%3AString%3F-instance-method" class="tooltip">
|
||||
<span>source_between(loc, end_loc, code_lines) : String?</span>
|
||||
source_between</a>
|
||||
|
||||
|
||||
|
||||
|
|
@ -918,17 +920,17 @@ loop <span class="k">do</span>
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -948,12 +950,12 @@ loop <span class="k">do</span>
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -1023,7 +1025,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1037,41 +1039,33 @@ loop <span class="k">do</span>
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that reports unreachable code.</p>
|
||||
|
||||
<p>For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>(a)
|
||||
<span class="k">return</span> <span class="n">42</span>
|
||||
a <span class="o">+</span> <span class="n">1</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<pre><code class="language-crystal">a <span class="o">=</span> <span class="n">1</span>
|
||||
loop <span class="k">do</span>
|
||||
<span class="k">break</span>
|
||||
a += <span class="n">1</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And has to be written as the following:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>(a)
|
||||
<span class="k">return</span> <span class="n">42</span> <span class="k">if</span> a <span class="o">==</span> <span class="n">0</span>
|
||||
a <span class="o">+</span> <span class="n">1</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<pre><code class="language-crystal">a <span class="o">=</span> <span class="n">1</span>
|
||||
loop <span class="k">do</span>
|
||||
<span class="k">break</span> a <span class="o">></span> <span class="n">3</span>
|
||||
a += <span class="n">1</span>
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/UnreachableCode:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -1079,7 +1073,7 @@ loop <span class="k">do</span>
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/unreachable_code.cr#L44" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/unreachable_code.cr#L44" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1103,7 +1097,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1117,7 +1111,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1131,7 +1125,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1145,7 +1139,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1159,7 +1153,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1173,7 +1167,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1187,7 +1181,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1201,7 +1195,7 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1215,13 +1209,13 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>test</strong>(source, node, flow_expression : <a href="../../../Ameba/AST/FlowExpression.html">AST::FlowExpression</a>)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node,flow_expression:AST::FlowExpression)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%2Cflow_expression%3AAST%3A%3AFlowExpression%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/unreachable_code.cr#L57" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/unreachable_code.cr#L57" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1231,13 +1225,13 @@ loop <span class="k">do</span>
|
|||
|
||||
def <strong>test</strong>(source)
|
||||
|
||||
<a class="method-permalink" href="#test(source)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/unreachable_code.cr#L53" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/unreachable_code.cr#L53" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -641,19 +646,14 @@
|
|||
|
||||
<p>A rule that reports unused arguments.
|
||||
For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>(a, b, c)
|
||||
a <span class="o">+</span> b
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>and should be written as:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>(a, b)
|
||||
a <span class="o">+</span> b
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/UnusedArgument:
|
||||
Enabled: true
|
||||
IgnoreDefs: true
|
||||
|
|
@ -699,7 +699,7 @@ For example, this is considered invalid:</p>
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/unused_argument.cr#L27" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/unused_argument.cr#L27" target="_blank">
|
||||
ameba/rule/lint/unused_argument.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -740,12 +740,12 @@ For example, this is considered invalid:</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that reports unused arguments.</p></div>
|
||||
|
||||
|
|
@ -768,92 +768,92 @@ For example, this is considered invalid:</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#ignore_blocks:Bool-instance-method" class="signature"><strong>#ignore_blocks</strong> : Bool</a>
|
||||
<a href="#ignore_blocks%3ABool-instance-method" class="signature"><strong>#ignore_blocks</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#ignore_blocks=(ignore_blocks:Bool)-instance-method" class="signature"><strong>#ignore_blocks=</strong>(ignore_blocks : Bool)</a>
|
||||
<a href="#ignore_blocks%3D%28ignore_blocks%3ABool%29-instance-method" class="signature"><strong>#ignore_blocks=</strong>(ignore_blocks : Bool)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#ignore_defs:Bool-instance-method" class="signature"><strong>#ignore_defs</strong> : Bool</a>
|
||||
<a href="#ignore_defs%3ABool-instance-method" class="signature"><strong>#ignore_defs</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#ignore_defs=(ignore_defs:Bool)-instance-method" class="signature"><strong>#ignore_defs=</strong>(ignore_defs : Bool)</a>
|
||||
<a href="#ignore_defs%3D%28ignore_defs%3ABool%29-instance-method" class="signature"><strong>#ignore_defs=</strong>(ignore_defs : Bool)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#ignore_procs:Bool-instance-method" class="signature"><strong>#ignore_procs</strong> : Bool</a>
|
||||
<a href="#ignore_procs%3ABool-instance-method" class="signature"><strong>#ignore_procs</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#ignore_procs=(ignore_procs:Bool)-instance-method" class="signature"><strong>#ignore_procs=</strong>(ignore_procs : Bool)</a>
|
||||
<a href="#ignore_procs%3D%28ignore_procs%3ABool%29-instance-method" class="signature"><strong>#ignore_procs=</strong>(ignore_procs : Bool)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::ProcLiteral,scope:AST::Scope)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::ProcLiteral, scope : AST::Scope)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3AProcLiteral%2Cscope%3AAST%3A%3AScope%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::ProcLiteral, scope : AST::Scope)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::Block,scope:AST::Scope)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Block, scope : AST::Scope)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3ABlock%2Cscope%3AAST%3A%3AScope%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Block, scope : AST::Scope)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::Def,scope:AST::Scope)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Def, scope : AST::Scope)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3ADef%2Cscope%3AAST%3A%3AScope%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Def, scope : AST::Scope)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source)-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
<a href="#test%28source%29-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -890,17 +890,17 @@ For example, this is considered invalid:</p>
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -920,12 +920,12 @@ For example, this is considered invalid:</p>
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -995,7 +995,7 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1009,26 +1009,21 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that reports unused arguments.
|
||||
For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>(a, b, c)
|
||||
a <span class="o">+</span> b
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>and should be written as:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>(a, b)
|
||||
a <span class="o">+</span> b
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/UnusedArgument:
|
||||
Enabled: true
|
||||
IgnoreDefs: true
|
||||
|
|
@ -1039,7 +1034,7 @@ For example, this is considered invalid:</p>
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/unused_argument.cr#L27" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/unused_argument.cr#L27" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1063,7 +1058,7 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1077,7 +1072,7 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1091,7 +1086,7 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1105,7 +1100,7 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1119,7 +1114,7 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1133,7 +1128,7 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1147,7 +1142,7 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>ignore_blocks</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#ignore_blocks:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#ignore_blocks%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1161,7 +1156,7 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>ignore_blocks=</strong>(ignore_blocks : Bool)
|
||||
|
||||
<a class="method-permalink" href="#ignore_blocks=(ignore_blocks:Bool)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#ignore_blocks%3D%28ignore_blocks%3ABool%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1175,7 +1170,7 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>ignore_defs</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#ignore_defs:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#ignore_defs%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1189,7 +1184,7 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>ignore_defs=</strong>(ignore_defs : Bool)
|
||||
|
||||
<a class="method-permalink" href="#ignore_defs=(ignore_defs:Bool)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#ignore_defs%3D%28ignore_defs%3ABool%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1203,7 +1198,7 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>ignore_procs</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#ignore_procs:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#ignore_procs%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1217,7 +1212,7 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>ignore_procs=</strong>(ignore_procs : Bool)
|
||||
|
||||
<a class="method-permalink" href="#ignore_procs=(ignore_procs:Bool)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#ignore_procs%3D%28ignore_procs%3ABool%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1231,7 +1226,7 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1245,7 +1240,7 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1259,13 +1254,13 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::ProcLiteral, scope : <a href="../../../Ameba/AST/Scope.html">AST::Scope</a>)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::ProcLiteral,scope:AST::Scope)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3AProcLiteral%2Cscope%3AAST%3A%3AScope%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/unused_argument.cr#L43" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/unused_argument.cr#L43" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1275,13 +1270,13 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::Block, scope : <a href="../../../Ameba/AST/Scope.html">AST::Scope</a>)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::Block,scope:AST::Scope)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3ABlock%2Cscope%3AAST%3A%3AScope%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/unused_argument.cr#L47" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/unused_argument.cr#L47" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1291,13 +1286,13 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::Def, scope : <a href="../../../Ameba/AST/Scope.html">AST::Scope</a>)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::Def,scope:AST::Scope)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3ADef%2Cscope%3AAST%3A%3AScope%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/unused_argument.cr#L51" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/unused_argument.cr#L51" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1307,13 +1302,13 @@ For example, this is considered invalid:</p>
|
|||
|
||||
def <strong>test</strong>(source)
|
||||
|
||||
<a class="method-permalink" href="#test(source)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/unused_argument.cr#L39" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/unused_argument.cr#L39" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -640,23 +645,17 @@
|
|||
</h2>
|
||||
|
||||
<p>A rule that disallows useless assignments.</p>
|
||||
|
||||
<p>For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>
|
||||
var <span class="o">=</span> <span class="n">1</span>
|
||||
do_something
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And has to be written as the following:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>
|
||||
var <span class="o">=</span> <span class="n">1</span>
|
||||
do_something(var)
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/UselessAssign:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -699,7 +698,7 @@
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/useless_assign.cr#L28" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/useless_assign.cr#L28" target="_blank">
|
||||
ameba/rule/lint/useless_assign.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -740,12 +739,12 @@
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows useless assignments.</p></div>
|
||||
|
||||
|
|
@ -768,52 +767,52 @@
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node,scope:AST::Scope)-instance-method" class="signature"><strong>#test</strong>(source, node, scope : AST::Scope)</a>
|
||||
<a href="#test%28source%2Cnode%2Cscope%3AAST%3A%3AScope%29-instance-method" class="signature"><strong>#test</strong>(source, node, scope : AST::Scope)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source)-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
<a href="#test%28source%29-instance-method" class="signature"><strong>#test</strong>(source)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -850,17 +849,17 @@
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -880,12 +879,12 @@
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -955,7 +954,7 @@
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -969,29 +968,23 @@
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows useless assignments.</p>
|
||||
|
||||
<p>For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>
|
||||
var <span class="o">=</span> <span class="n">1</span>
|
||||
do_something
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And has to be written as the following:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>
|
||||
var <span class="o">=</span> <span class="n">1</span>
|
||||
do_something(var)
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/UselessAssign:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -999,7 +992,7 @@
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/useless_assign.cr#L28" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/useless_assign.cr#L28" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1023,7 +1016,7 @@
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1037,7 +1030,7 @@
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1051,7 +1044,7 @@
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1065,7 +1058,7 @@
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1079,7 +1072,7 @@
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1093,7 +1086,7 @@
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1107,7 +1100,7 @@
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1121,7 +1114,7 @@
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1135,13 +1128,13 @@
|
|||
|
||||
def <strong>test</strong>(source, node, scope : <a href="../../../Ameba/AST/Scope.html">AST::Scope</a>)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node,scope:AST::Scope)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%2Cscope%3AAST%3A%3AScope%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/useless_assign.cr#L39" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/useless_assign.cr#L39" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1151,13 +1144,13 @@
|
|||
|
||||
def <strong>test</strong>(source)
|
||||
|
||||
<a class="method-permalink" href="#test(source)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/useless_assign.cr#L35" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/useless_assign.cr#L35" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="generator" content="Crystal Docs 0.36.1">
|
||||
<meta name="generator" content="Crystal Docs 1.1.1">
|
||||
<meta name="crystal_docs.project_version" content="master">
|
||||
<meta name="crystal_docs.project_name" content="ameba">
|
||||
|
||||
|
|
@ -286,6 +286,11 @@
|
|||
|
||||
<ul>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
|
||||
<a href="../../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
|
||||
<a href="../../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
|
||||
|
||||
|
|
@ -641,27 +646,21 @@
|
|||
|
||||
<p>A rule that disallows useless conditions in when clause
|
||||
where it is guaranteed to always return the same result.</p>
|
||||
|
||||
<p>For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">case</span>
|
||||
<span class="k">when</span> utc?
|
||||
io <span class="o"><<</span> <span class="s">" UTC"</span>
|
||||
<span class="k">when</span> local?
|
||||
<span class="t">Format</span>.<span class="k">new</span>(<span class="s">" %:z"</span>).format(<span class="k">self</span>, io) <span class="k">if</span> local?
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And has to be written as the following:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">case</span>
|
||||
<span class="k">when</span> utc?
|
||||
io <span class="o"><<</span> <span class="s">" UTC"</span>
|
||||
<span class="k">when</span> local?
|
||||
<span class="t">Format</span>.<span class="k">new</span>(<span class="s">" %:z"</span>).format(<span class="k">self</span>, io)
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/UselessConditionInWhen:
|
||||
Enabled: true</code></pre>
|
||||
|
||||
|
|
@ -704,7 +703,7 @@ where it is guaranteed to always return the same result.</p>
|
|||
</h2>
|
||||
|
||||
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/useless_condition_in_when.cr#L33" target="_blank">
|
||||
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/useless_condition_in_when.cr#L33" target="_blank">
|
||||
ameba/rule/lint/useless_condition_in_when.cr
|
||||
</a>
|
||||
|
||||
|
|
@ -745,12 +744,12 @@ where it is guaranteed to always return the same result.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
<a href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method" class="signature"><strong>.new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#new(config=nil)-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
<a href="#new%28config%3Dnil%29-class-method" class="signature"><strong>.new</strong>(config = <span class="n">nil</span>)</a>
|
||||
|
||||
<div class="summary"><p>A rule that disallows useless conditions in when clause where it is guaranteed to always return the same result.</p></div>
|
||||
|
||||
|
|
@ -773,47 +772,47 @@ where it is guaranteed to always return the same result.</p>
|
|||
<ul class="list-summary">
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description:String-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
<a href="#description%3AString-instance-method" class="signature"><strong>#description</strong> : String</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#description=(description:String)-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
<a href="#description%3D%28description%3AString%29-instance-method" class="signature"><strong>#description=</strong>(description : String)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled:Bool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
<a href="#enabled%3ABool-instance-method" class="signature"><strong>#enabled</strong> : Bool</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#enabled=(enabled)-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
<a href="#enabled%3D%28enabled%29-instance-method" class="signature"><strong>#enabled=</strong>(enabled)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded:Array(String)?-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
<a href="#excluded%3AArray%28String%29%3F-instance-method" class="signature"><strong>#excluded</strong> : Array(String)?</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#excluded=(excluded:Array(String)?)-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
<a href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method" class="signature"><strong>#excluded=</strong>(excluded : Array(String)?)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity:Ameba::Severity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#severity=(severity)-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
<a href="#severity%3D%28severity%29-instance-method" class="signature"><strong>#severity=</strong>(severity)</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="entry-summary">
|
||||
<a href="#test(source,node:Crystal::When)-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::When)</a>
|
||||
<a href="#test%28source%2Cnode%3ACrystal%3A%3AWhen%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::When)</a>
|
||||
|
||||
</li>
|
||||
|
||||
|
|
@ -850,17 +849,17 @@ where it is guaranteed to always return the same result.</p>
|
|||
<h3>Instance methods inherited from class <code><a href="../../../Ameba/Rule/Base.html">Ameba::Rule::Base</a></code></h3>
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#==(other)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#%3D%3D%28other%29-instance-method" class="tooltip">
|
||||
<span>==(other)</span>
|
||||
==</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#catch(source:Source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#catch%28source%3ASource%29-instance-method" class="tooltip">
|
||||
<span>catch(source : Source)</span>
|
||||
catch</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded?(source)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#excluded%3F%28source%29-instance-method" class="tooltip">
|
||||
<span>excluded?(source)</span>
|
||||
excluded?</a>,
|
||||
|
||||
|
|
@ -880,12 +879,12 @@ where it is guaranteed to always return the same result.</p>
|
|||
name</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#special?-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#special%3F-instance-method" class="tooltip">
|
||||
<span>special?</span>
|
||||
special?</a>,
|
||||
|
||||
|
||||
<a href="../../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method" class="tooltip">
|
||||
<a href="../../../Ameba/Rule/Base.html#test%28source%3ASource%2Cnode%3ACrystal%3A%3AASTNode%2C%2Aopts%29-instance-method" class="tooltip">
|
||||
<span>test(source : Source, node : Crystal::ASTNode, *opts)<br/>test(source : Source)</span>
|
||||
test</a>
|
||||
|
||||
|
|
@ -955,7 +954,7 @@ where it is guaranteed to always return the same result.</p>
|
|||
|
||||
def self.<strong>new</strong>(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
|
||||
|
||||
<a class="method-permalink" href="#new(ctx:YAML::ParseContext,node:YAML::Nodes::Node)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28ctx%3AYAML%3A%3AParseContext%2Cnode%3AYAML%3A%3ANodes%3A%3ANode%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -969,34 +968,28 @@ where it is guaranteed to always return the same result.</p>
|
|||
|
||||
def self.<strong>new</strong>(config = <span class="n">nil</span>)
|
||||
|
||||
<a class="method-permalink" href="#new(config=nil)-class-method">#</a>
|
||||
<a class="method-permalink" href="#new%28config%3Dnil%29-class-method">#</a>
|
||||
</div>
|
||||
|
||||
<div class="doc">
|
||||
|
||||
<p>A rule that disallows useless conditions in when clause
|
||||
where it is guaranteed to always return the same result.</p>
|
||||
|
||||
<p>For example, this is considered invalid:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">case</span>
|
||||
<span class="k">when</span> utc?
|
||||
io <span class="o"><<</span> <span class="s">" UTC"</span>
|
||||
<span class="k">when</span> local?
|
||||
<span class="t">Format</span>.<span class="k">new</span>(<span class="s">" %:z"</span>).format(<span class="k">self</span>, io) <span class="k">if</span> local?
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>And has to be written as the following:</p>
|
||||
|
||||
<pre><code class="language-crystal"><span class="k">case</span>
|
||||
<span class="k">when</span> utc?
|
||||
io <span class="o"><<</span> <span class="s">" UTC"</span>
|
||||
<span class="k">when</span> local?
|
||||
<span class="t">Format</span>.<span class="k">new</span>(<span class="s">" %:z"</span>).format(<span class="k">self</span>, io)
|
||||
<span class="k">end</span></code></pre>
|
||||
|
||||
<p>YAML configuration example:</p>
|
||||
|
||||
<pre><code class="language-crystal">Lint/UselessConditionInWhen:
|
||||
Enabled: true</code></pre>
|
||||
</div>
|
||||
|
|
@ -1004,7 +997,7 @@ where it is guaranteed to always return the same result.</p>
|
|||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/useless_condition_in_when.cr#L33" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/useless_condition_in_when.cr#L33" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -1028,7 +1021,7 @@ where it is guaranteed to always return the same result.</p>
|
|||
|
||||
def <strong>description</strong> : String
|
||||
|
||||
<a class="method-permalink" href="#description:String-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3AString-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1042,7 +1035,7 @@ where it is guaranteed to always return the same result.</p>
|
|||
|
||||
def <strong>description=</strong>(description : String)
|
||||
|
||||
<a class="method-permalink" href="#description=(description:String)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#description%3D%28description%3AString%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1056,7 +1049,7 @@ where it is guaranteed to always return the same result.</p>
|
|||
|
||||
def <strong>enabled</strong> : Bool
|
||||
|
||||
<a class="method-permalink" href="#enabled:Bool-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3ABool-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1070,7 +1063,7 @@ where it is guaranteed to always return the same result.</p>
|
|||
|
||||
def <strong>enabled=</strong>(enabled)
|
||||
|
||||
<a class="method-permalink" href="#enabled=(enabled)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#enabled%3D%28enabled%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1084,7 +1077,7 @@ where it is guaranteed to always return the same result.</p>
|
|||
|
||||
def <strong>excluded</strong> : Array(String)?
|
||||
|
||||
<a class="method-permalink" href="#excluded:Array(String)?-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3AArray%28String%29%3F-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1098,7 +1091,7 @@ where it is guaranteed to always return the same result.</p>
|
|||
|
||||
def <strong>excluded=</strong>(excluded : Array(String)?)
|
||||
|
||||
<a class="method-permalink" href="#excluded=(excluded:Array(String)?)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#excluded%3D%28excluded%3AArray%28String%29%3F%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1112,7 +1105,7 @@ where it is guaranteed to always return the same result.</p>
|
|||
|
||||
def <strong>severity</strong> : <a href="../../../Ameba/Severity.html">Ameba::Severity</a>
|
||||
|
||||
<a class="method-permalink" href="#severity:Ameba::Severity-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3AAmeba%3A%3ASeverity-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1126,7 +1119,7 @@ where it is guaranteed to always return the same result.</p>
|
|||
|
||||
def <strong>severity=</strong>(severity)
|
||||
|
||||
<a class="method-permalink" href="#severity=(severity)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#severity%3D%28severity%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
|
@ -1140,13 +1133,13 @@ where it is guaranteed to always return the same result.</p>
|
|||
|
||||
def <strong>test</strong>(source, node : Crystal::When)
|
||||
|
||||
<a class="method-permalink" href="#test(source,node:Crystal::When)-instance-method">#</a>
|
||||
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3AWhen%29-instance-method">#</a>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<div>
|
||||
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/rule/lint/useless_condition_in_when.cr#L50" target="_blank">View source</a>]
|
||||
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/rule/lint/useless_condition_in_when.cr#L50" target="_blank">View source</a>]
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue