iv-org-mirror/shard-ameba
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/shard-ameba.git synced 2024-08-15 00:53:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

Deploying to gh-pages from @ 48b15b9bf8 🚀

Browse source
This commit is contained in:
Sija 2021-10-19 09:45:33 +00:00
parent 42809c9681
commit f760465482
106 changed files with 5612 additions and 4623 deletions
Download patch file Download diff file Expand all files Collapse all files

87
Ameba/Rule/Lint/SpecFocus.html
View file

@ -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">&quot;my context&quot;</span>, focus: <span class="n">tr
it <span class="s">&quot;works&quot;</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">&quot;my context&quot;</span> <span class="k">do</span>
it <span class="s">&quot;works&quot;</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">&quot;works&quot;</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">&quot;works&quot;</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">&quot;works&quot;</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">&quot;works&quot;</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">&quot;works&quot;</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">&quot;works&quot;</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">&quot;works&quot;</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">&quot;my context&quot;</span>, focus: <span class="n">tr
it <span class="s">&quot;works&quot;</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">&quot;my context&quot;</span> <span class="k">do</span>
it <span class="s">&quot;works&quot;</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">&quot;works&quot;</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">&quot;works&quot;</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">&quot;works&quot;</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">&quot;works&quot;</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">&quot;works&quot;</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">&quot;works&quot;</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">&quot;works&quot;</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">&quot;works&quot;</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">&quot;works&quot;</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">&quot;works&quot;</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">&quot;works&quot;</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>