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 @ bedf3a68d7 🚀

Browse source
This commit is contained in:
veelenga 2021-01-12 10:04:15 +00:00
parent 783b1f1658
commit edc349b964
93 changed files with 3493 additions and 1634 deletions
Download patch file Download diff file Expand all files Collapse all files

99
Ameba.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -576,11 +576,11 @@
<p>To run the linter with default parameters:</p>
<pre><code class="language-crystal"><span class="t">Ameba</span>.run</code></pre>
<pre><code><span class="t">Ameba</span>.run</code></pre>
<p>To configure and run it:</p>
<pre><code class="language-crystal">config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
<pre><code>config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
config.formatter <span class="o">=</span> formatter
config.files <span class="o">=</span> file_paths
@ -622,6 +622,69 @@ config.files <span class="o">=</span> file_paths
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba.cr#L24" target="_blank">
ameba.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/glob_utils.cr#L1" target="_blank">
ameba/glob_utils.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/inline_comments.cr#L1" target="_blank">
ameba/inline_comments.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/issue.cr#L1" target="_blank">
ameba/issue.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/reportable.cr#L1" target="_blank">
ameba/reportable.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/runner.cr#L1" target="_blank">
ameba/runner.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/severity.cr#L1" target="_blank">
ameba/severity.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/source.cr#L1" target="_blank">
ameba/source.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/tokenizer.cr#L3" target="_blank">
ameba/tokenizer.cr
</a>
<br/>
@ -638,7 +701,7 @@ config.files <span class="o">=</span> file_paths
<dl>
<dt class="entry-const" id="VERSION">
<strong>VERSION</strong> = <code>{{ (<span class="s">`shards version \&quot;/home/travis/build/crystal-ameba/ameba/src\&quot;`</span>).chomp.stringify }}</code>
<strong>VERSION</strong> = <code>{{ (<span class="s">`shards version \&quot;/home/runner/work/ameba/ameba/src\&quot;`</span>).chomp.stringify }}</code>
</dt>
@ -706,13 +769,15 @@ Can be configured via <code>config</code> parameter.</p>
<p>Examples:</p>
<pre><code class="language-crystal"><span class="t">Ameba</span>.run
<pre><code><span class="t">Ameba</span>.run
<span class="t">Ameba</span>.run config</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba.cr#L39" target="_blank">View source</a>]
</div>
</div>

131
Ameba/AST.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::AST - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -596,6 +596,111 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branch.cr#L1" target="_blank">
ameba/ast/branch.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branchable.cr#L3" target="_blank">
ameba/ast/branchable.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/flow_expression.cr#L3" target="_blank">
ameba/ast/flow_expression.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L3" target="_blank">
ameba/ast/scope.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/argument.cr#L1" target="_blank">
ameba/ast/variabling/argument.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L4" target="_blank">
ameba/ast/variabling/assignment.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/ivariable.cr#L1" target="_blank">
ameba/ast/variabling/ivariable.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/reference.cr#L3" target="_blank">
ameba/ast/variabling/reference.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L1" target="_blank">
ameba/ast/variabling/variable.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/base_visitor.cr#L4" target="_blank">
ameba/ast/visitors/base_visitor.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/counting_visitor.cr#L1" target="_blank">
ameba/ast/visitors/counting_visitor.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/flow_expression_visitor.cr#L4" target="_blank">
ameba/ast/visitors/flow_expression_visitor.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L3" target="_blank">
ameba/ast/visitors/node_visitor.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/redundant_control_expression_visitor.cr#L1" target="_blank">
ameba/ast/visitors/redundant_control_expression_visitor.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/scope_visitor.cr#L3" target="_blank">
ameba/ast/visitors/scope_visitor.cr
</a>
<br/>

59
Ameba/AST/Argument.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST::Argument - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::AST::Argument - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -579,7 +579,7 @@ Holds the reference to the variable, thus to scope.</p>
<p>For example, all these vars are arguments:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>(a, b, c <span class="o">=</span> <span class="n">10</span>, <span class="o">&amp;</span>block)
<pre><code><span class="k">def</span> <span class="m">method</span>(a, b, c <span class="o">=</span> <span class="n">10</span>, <span class="o">&amp;</span>block)
<span class="n">3</span>.times <span class="k">do</span> <span class="o">|</span>i<span class="o">|</span>
<span class="k">end</span>
@ -608,6 +608,13 @@ Holds the reference to the variable, thus to scope.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/argument.cr#L15" target="_blank">
ameba/ast/variabling/argument.cr
</a>
<br/>
@ -756,12 +763,14 @@ Holds the reference to the variable, thus to scope.</p>
<p>Creates a new argument.</p>
<pre><code class="language-crystal"><span class="t">Argument</span>.<span class="k">new</span>(node, variable)</code></pre>
<pre><code><span class="t">Argument</span>.<span class="k">new</span>(node, variable)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/argument.cr#L31" target="_blank">View source</a>]
</div>
</div>
@ -790,6 +799,8 @@ Holds the reference to the variable, thus to scope.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/argument.cr#L23" target="_blank">View source</a>]
</div>
</div>
@ -804,6 +815,8 @@ Holds the reference to the variable, thus to scope.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/argument.cr#L23" target="_blank">View source</a>]
</div>
</div>
@ -823,6 +836,8 @@ Holds the reference to the variable, thus to scope.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/argument.cr#L35" target="_blank">View source</a>]
</div>
</div>
@ -837,6 +852,8 @@ Holds the reference to the variable, thus to scope.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/argument.cr#L22" target="_blank">View source</a>]
</div>
</div>
@ -851,6 +868,8 @@ Holds the reference to the variable, thus to scope.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/argument.cr#L22" target="_blank">View source</a>]
</div>
</div>
@ -870,6 +889,8 @@ Holds the reference to the variable, thus to scope.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/argument.cr#L40" target="_blank">View source</a>]
</div>
</div>
@ -889,6 +910,8 @@ Holds the reference to the variable, thus to scope.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/argument.cr#L17" target="_blank">View source</a>]
</div>
</div>
@ -903,6 +926,8 @@ Holds the reference to the variable, thus to scope.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/argument.cr#L24" target="_blank">View source</a>]
</div>
</div>
@ -917,6 +942,8 @@ Holds the reference to the variable, thus to scope.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/argument.cr#L24" target="_blank">View source</a>]
</div>
</div>
@ -936,6 +963,8 @@ Holds the reference to the variable, thus to scope.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/argument.cr#L20" target="_blank">View source</a>]
</div>
</div>

79
Ameba/AST/Assignment.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST::Assignment - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::AST::Assignment - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -599,6 +599,13 @@ Holds the assign node and the variable.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L7" target="_blank">
ameba/ast/variabling/assignment.cr
</a>
<br/>
@ -790,12 +797,14 @@ Holds the assign node and the variable.</p>
<p>Creates a new assignment.</p>
<pre><code class="language-crystal"><span class="t">Assignment</span>.<span class="k">new</span>(node, variable, scope)</code></pre>
<pre><code><span class="t">Assignment</span>.<span class="k">new</span>(node, variable, scope)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L32" target="_blank">View source</a>]
</div>
</div>
@ -829,6 +838,8 @@ Holds the assign node and the variable.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L17" target="_blank">View source</a>]
</div>
</div>
@ -843,6 +854,8 @@ Holds the assign node and the variable.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L24" target="_blank">View source</a>]
</div>
</div>
@ -857,6 +870,8 @@ Holds the assign node and the variable.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L24" target="_blank">View source</a>]
</div>
</div>
@ -873,12 +888,14 @@ Holds the assign node and the variable.</p>
<p>Returns true if this assignment is in a branch, false if not.
For example, this assignment is in a branch:</p>
<pre><code class="language-crystal">a <span class="o">=</span> <span class="n">1</span> <span class="k">if</span> a.<span class="k">nil?</span></code></pre>
<pre><code>a <span class="o">=</span> <span class="n">1</span> <span class="k">if</span> a.<span class="k">nil?</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L61" target="_blank">View source</a>]
</div>
</div>
@ -893,6 +910,8 @@ For example, this assignment is in a branch:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L23" target="_blank">View source</a>]
</div>
</div>
@ -907,6 +926,8 @@ For example, this assignment is in a branch:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L23" target="_blank">View source</a>]
</div>
</div>
@ -926,6 +947,8 @@ For example, this assignment is in a branch:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L11" target="_blank">View source</a>]
</div>
</div>
@ -942,12 +965,14 @@ For example, this assignment is in a branch:</p>
<p>Returns true if this assignment is an op assign, false if not.
For example, this is an op assign:</p>
<pre><code class="language-crystal">a ||= <span class="n">1</span></code></pre>
<pre><code>a ||= <span class="n">1</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L51" target="_blank">View source</a>]
</div>
</div>
@ -962,6 +987,8 @@ For example, this is an op assign:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L8" target="_blank">View source</a>]
</div>
</div>
@ -976,6 +1003,8 @@ For example, this is an op assign:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L8" target="_blank">View source</a>]
</div>
</div>
@ -990,6 +1019,8 @@ For example, this is an op assign:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L41" target="_blank">View source</a>]
</div>
</div>
@ -1009,6 +1040,8 @@ For example, this is an op assign:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L20" target="_blank">View source</a>]
</div>
</div>
@ -1028,6 +1061,8 @@ For example, this is an op assign:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L66" target="_blank">View source</a>]
</div>
</div>
@ -1042,6 +1077,8 @@ For example, this is an op assign:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L22" target="_blank">View source</a>]
</div>
</div>
@ -1056,6 +1093,8 @@ For example, this is an op assign:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L22" target="_blank">View source</a>]
</div>
</div>
@ -1072,13 +1111,13 @@ For example, this is an op assign:</p>
<p>Indicates whether the node is a transformed assignment by the compiler.
i.e.</p>
<pre><code class="language-crystal">collection.each <span class="k">do</span> <span class="o">|</span>(a, b)<span class="o">|</span>
<pre><code>collection.each <span class="k">do</span> <span class="o">|</span>(a, b)<span class="o">|</span>
puts b
<span class="k">end</span></code></pre>
<p>is transformed to:</p>
<pre><code class="language-crystal">collection.each <span class="k">do</span> <span class="o">|</span>__arg0<span class="o">|</span>
<pre><code>collection.each <span class="k">do</span> <span class="o">|</span>__arg0<span class="o">|</span>
a <span class="o">=</span> __arg0[<span class="n">0</span>]
b <span class="o">=</span> __arg0[<span class="n">1</span>]
puts(b)
@ -1088,6 +1127,8 @@ i.e.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L99" target="_blank">View source</a>]
</div>
</div>
@ -1107,6 +1148,8 @@ i.e.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/assignment.cr#L14" target="_blank">View source</a>]
</div>
</div>

39
Ameba/AST/BaseVisitor.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST::BaseVisitor - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::AST::BaseVisitor - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -616,6 +616,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/base_visitor.cr#L6" target="_blank">
ameba/ast/visitors/base_visitor.cr
</a>
<br/>
@ -723,12 +730,14 @@
<p>Creates instance of this visitor.</p>
<pre><code class="language-crystal">visitor <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">AST</span><span class="t">::</span><span class="t">NodeVisitor</span>.<span class="k">new</span>(rule, source)</code></pre>
<pre><code>visitor <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">AST</span><span class="t">::</span><span class="t">NodeVisitor</span>.<span class="k">new</span>(rule, source)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/base_visitor.cr#L19" target="_blank">View source</a>]
</div>
</div>
@ -763,6 +772,8 @@ Returns true meaning all child nodes will be traversed.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/base_visitor.cr#L25" target="_blank">View source</a>]
</div>
</div>

67
Ameba/AST/Branch.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST::Branch - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::AST::Branch - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,7 +578,7 @@
Branch is a part of a branchable statement.
For example, the branchable if statement contains 3 branches:</p>
<pre><code class="language-crystal"><span class="k">if</span> a <span class="o">=</span> something <span class="c"># --&gt; Branch A</span>
<pre><code><span class="k">if</span> a <span class="o">=</span> something <span class="c"># --&gt; Branch A</span>
a <span class="o">=</span> <span class="n">1</span> <span class="c"># --&gt; Branch B</span>
put a <span class="k">if</span> <span class="k">out</span> <span class="c"># --&gt; Branch C</span>
<span class="k">else</span>
@ -607,6 +607,13 @@ For example, the branchable if statement contains 3 branches:</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branch.cr#L15" target="_blank">
ameba/ast/branch.cr
</a>
<br/>
@ -788,12 +795,14 @@ For example, the branchable if statement contains 3 branches:</p>
<p>Creates a new branch.</p>
<pre><code class="language-crystal"><span class="t">Branch</span>.<span class="k">new</span>(if_node)</code></pre>
<pre><code><span class="t">Branch</span>.<span class="k">new</span>(if_node)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branch.cr#L33" target="_blank">View source</a>]
</div>
</div>
@ -821,12 +830,14 @@ For example, the branchable if statement contains 3 branches:</p>
<p>Constructs a new branch based on the node some parent scope.</p>
<pre><code class="language-crystal"><span class="t">Branch</span>.<span class="k">of</span>(assign_node, def_node)</code></pre>
<pre><code><span class="t">Branch</span>.<span class="k">of</span>(assign_node, def_node)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branch.cr#L66" target="_blank">View source</a>]
</div>
</div>
@ -842,12 +853,14 @@ For example, the branchable if statement contains 3 branches:</p>
<p>Constructs a new branch based on the node in scope.</p>
<pre><code class="language-crystal"><span class="t">Branch</span>.<span class="k">of</span>(assign_node, scope)</code></pre>
<pre><code><span class="t">Branch</span>.<span class="k">of</span>(assign_node, scope)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branch.cr#L57" target="_blank">View source</a>]
</div>
</div>
@ -897,6 +910,8 @@ For example, the branchable if statement contains 3 branches:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branch.cr#L24" target="_blank">View source</a>]
</div>
</div>
@ -911,6 +926,8 @@ For example, the branchable if statement contains 3 branches:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branch.cr#L24" target="_blank">View source</a>]
</div>
</div>
@ -950,7 +967,7 @@ For example, the branchable if statement contains 3 branches:</p>
<p>Returns true if current branch is in a loop, false - otherwise.
For example, this branch is in a loop:</p>
<pre><code class="language-crystal"><span class="k">while</span> <span class="n">true</span>
<pre><code><span class="k">while</span> <span class="n">true</span>
handle_input <span class="c"># this branch is in a loop</span>
<span class="k">if</span> wrong_input
show_message <span class="c"># this branch is also in a loop.</span>
@ -961,6 +978,8 @@ For example, this branch is in a loop:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branch.cr#L48" target="_blank">View source</a>]
</div>
</div>
@ -975,6 +994,8 @@ For example, this branch is in a loop:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branch.cr#L23" target="_blank">View source</a>]
</div>
</div>
@ -989,6 +1010,8 @@ For example, this branch is in a loop:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branch.cr#L23" target="_blank">View source</a>]
</div>
</div>
@ -1008,6 +1031,8 @@ For example, this branch is in a loop:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branch.cr#L17" target="_blank">View source</a>]
</div>
</div>
@ -1027,6 +1052,8 @@ For example, this branch is in a loop:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branch.cr#L20" target="_blank">View source</a>]
</div>
</div>
@ -1041,6 +1068,8 @@ For example, this branch is in a loop:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branch.cr#L22" target="_blank">View source</a>]
</div>
</div>
@ -1055,6 +1084,8 @@ For example, this branch is in a loop:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branch.cr#L22" target="_blank">View source</a>]
</div>
</div>

59
Ameba/AST/Branchable.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST::Branchable - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::AST::Branchable - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,7 +578,7 @@
For example, <code>Crystal::If</code>, <code>Crystal::Unless</code>, <code>Crystal::While</code>
are branchables.</p>
<pre><code class="language-crystal">white a <span class="o">&gt;</span> <span class="n">100</span> <span class="c"># Branchable A</span>
<pre><code>white a <span class="o">&gt;</span> <span class="n">100</span> <span class="c"># Branchable A</span>
<span class="k">if</span> b <span class="o">&gt;</span> <span class="n">2</span> <span class="c"># Branchable B</span>
a += <span class="n">1</span>
<span class="k">end</span>
@ -620,6 +620,13 @@ are branchables.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branchable.cr#L15" target="_blank">
ameba/ast/branchable.cr
</a>
<br/>
@ -820,12 +827,14 @@ are branchables.</p>
<p>Creates a new branchable</p>
<pre><code class="language-crystal"><span class="t">Branchable</span>.<span class="k">new</span>(node, parent_branchable)</code></pre>
<pre><code><span class="t">Branchable</span>.<span class="k">new</span>(node, parent_branchable)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branchable.cr#L35" target="_blank">View source</a>]
</div>
</div>
@ -854,6 +863,8 @@ are branchables.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branchable.cr#L18" target="_blank">View source</a>]
</div>
</div>
@ -868,6 +879,8 @@ are branchables.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branchable.cr#L28" target="_blank">View source</a>]
</div>
</div>
@ -882,6 +895,8 @@ are branchables.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branchable.cr#L28" target="_blank">View source</a>]
</div>
</div>
@ -896,6 +911,8 @@ are branchables.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branchable.cr#L27" target="_blank">View source</a>]
</div>
</div>
@ -910,6 +927,8 @@ are branchables.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branchable.cr#L27" target="_blank">View source</a>]
</div>
</div>
@ -929,6 +948,8 @@ are branchables.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branchable.cr#L39" target="_blank">View source</a>]
</div>
</div>
@ -948,6 +969,8 @@ are branchables.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branchable.cr#L21" target="_blank">View source</a>]
</div>
</div>
@ -967,6 +990,8 @@ are branchables.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branchable.cr#L24" target="_blank">View source</a>]
</div>
</div>
@ -981,6 +1006,8 @@ are branchables.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branchable.cr#L26" target="_blank">View source</a>]
</div>
</div>
@ -995,6 +1022,8 @@ are branchables.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/branchable.cr#L26" target="_blank">View source</a>]
</div>
</div>

41
Ameba/AST/CountingVisitor.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST::CountingVisitor - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::AST::CountingVisitor - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -598,6 +598,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/counting_visitor.cr#L3" target="_blank">
ameba/ast/visitors/counting_visitor.cr
</a>
<br/>
@ -738,6 +745,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/counting_visitor.cr#L8" target="_blank">View source</a>]
</div>
</div>
@ -771,6 +780,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/counting_visitor.cr#L18" target="_blank">View source</a>]
</div>
</div>
@ -785,6 +796,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/counting_visitor.cr#L5" target="_blank">View source</a>]
</div>
</div>
@ -799,6 +812,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/counting_visitor.cr#L33" target="_blank">View source</a>]
</div>
</div>

59
Ameba/AST/FlowExpression.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST::FlowExpression - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::AST::FlowExpression - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -577,7 +577,7 @@
<p>Represents a flow expression in Crystal code.
For example,</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">foobar</span>
<pre><code><span class="k">def</span> <span class="m">foobar</span>
a <span class="o">=</span> <span class="n">3</span>
<span class="k">return</span> <span class="n">42</span> <span class="c"># =&gt; flow expression</span>
a <span class="o">+</span> <span class="n">1</span>
@ -623,6 +623,13 @@ a parent node, which allows easily search through the related statement
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/flow_expression.cr#L18" target="_blank">
ameba/ast/flow_expression.cr
</a>
<br/>
@ -818,12 +825,14 @@ a parent node, which allows easily search through the related statement
<p>Creates a new flow expression.</p>
<pre><code class="language-crystal"><span class="t">FlowExpression</span>.<span class="k">new</span>(node, parent_node)</code></pre>
<pre><code><span class="t">FlowExpression</span>.<span class="k">new</span>(node, parent_node)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/flow_expression.cr#L36" target="_blank">View source</a>]
</div>
</div>
@ -852,6 +861,8 @@ a parent node, which allows easily search through the related statement
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/flow_expression.cr#L29" target="_blank">View source</a>]
</div>
</div>
@ -866,6 +877,8 @@ a parent node, which allows easily search through the related statement
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/flow_expression.cr#L29" target="_blank">View source</a>]
</div>
</div>
@ -885,6 +898,8 @@ a parent node, which allows easily search through the related statement
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/flow_expression.cr#L22" target="_blank">View source</a>]
</div>
</div>
@ -899,6 +914,8 @@ a parent node, which allows easily search through the related statement
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/flow_expression.cr#L28" target="_blank">View source</a>]
</div>
</div>
@ -913,6 +930,8 @@ a parent node, which allows easily search through the related statement
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/flow_expression.cr#L28" target="_blank">View source</a>]
</div>
</div>
@ -932,6 +951,8 @@ a parent node, which allows easily search through the related statement
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/flow_expression.cr#L25" target="_blank">View source</a>]
</div>
</div>
@ -946,6 +967,8 @@ a parent node, which allows easily search through the related statement
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/flow_expression.cr#L27" target="_blank">View source</a>]
</div>
</div>
@ -960,6 +983,8 @@ a parent node, which allows easily search through the related statement
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/flow_expression.cr#L27" target="_blank">View source</a>]
</div>
</div>
@ -976,7 +1001,7 @@ a parent node, which allows easily search through the related statement
<p>Returns nodes which can't be reached because of a flow command inside.
For example:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">foobar</span>
<pre><code><span class="k">def</span> <span class="m">foobar</span>
a <span class="o">=</span> <span class="n">1</span>
<span class="k">return</span> <span class="n">42</span>
@ -987,6 +1012,8 @@ For example:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/flow_expression.cr#L50" target="_blank">View source</a>]
</div>
</div>

35
Ameba/AST/FlowExpressionVisitor.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST::FlowExpressionVisitor - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::AST::FlowExpressionVisitor - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -612,6 +612,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/flow_expression_visitor.cr#L6" target="_blank">
ameba/ast/visitors/flow_expression_visitor.cr
</a>
<br/>
@ -786,6 +793,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/flow_expression_visitor.cr#L12" target="_blank">View source</a>]
</div>
</div>

53
Ameba/AST/InstanceVariable.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST::InstanceVariable - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::AST::InstanceVariable - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -587,6 +587,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/ivariable.cr#L2" target="_blank">
ameba/ast/variabling/ivariable.cr
</a>
<br/>
@ -719,6 +726,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/ivariable.cr#L10" target="_blank">View source</a>]
</div>
</div>
@ -747,6 +756,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/ivariable.cr#L6" target="_blank">View source</a>]
</div>
</div>
@ -761,6 +772,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/ivariable.cr#L6" target="_blank">View source</a>]
</div>
</div>
@ -775,6 +788,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/ivariable.cr#L5" target="_blank">View source</a>]
</div>
</div>
@ -789,6 +804,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/ivariable.cr#L5" target="_blank">View source</a>]
</div>
</div>
@ -803,6 +820,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/ivariable.cr#L7" target="_blank">View source</a>]
</div>
</div>
@ -817,6 +836,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/ivariable.cr#L7" target="_blank">View source</a>]
</div>
</div>
@ -831,6 +852,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/ivariable.cr#L3" target="_blank">View source</a>]
</div>
</div>
@ -845,6 +868,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/ivariable.cr#L8" target="_blank">View source</a>]
</div>
</div>
@ -859,6 +884,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/ivariable.cr#L8" target="_blank">View source</a>]
</div>
</div>

87
Ameba/AST/NodeVisitor.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST::NodeVisitor - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::AST::NodeVisitor - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -577,7 +577,7 @@
<p>An AST Visitor that traverses the source and allows all nodes
to be inspected by rules.</p>
<pre><code class="language-crystal">visitor <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">AST</span><span class="t">::</span><span class="t">NodeVisitor</span>.<span class="k">new</span>(rule, source)</code></pre>
<pre><code>visitor <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">AST</span><span class="t">::</span><span class="t">NodeVisitor</span>.<span class="k">new</span>(rule, source)</code></pre>
@ -601,6 +601,13 @@ to be inspected by rules.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L39" target="_blank">
ameba/ast/visitors/node_visitor.cr
</a>
<br/>
@ -899,6 +906,8 @@ to be inspected by rules.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L42" target="_blank">View source</a>]
</div>
</div>
@ -933,6 +942,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -953,6 +964,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -973,6 +986,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -993,6 +1008,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1013,6 +1030,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1033,6 +1052,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1053,6 +1074,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1073,6 +1096,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1093,6 +1118,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1113,6 +1140,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1133,6 +1162,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1153,6 +1184,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1173,6 +1206,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1193,6 +1228,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1213,6 +1250,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1233,6 +1272,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1253,6 +1294,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1273,6 +1316,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1293,6 +1338,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1313,6 +1360,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1333,6 +1382,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1353,6 +1404,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1373,6 +1426,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1393,6 +1448,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1407,6 +1464,8 @@ Returns true meaning that child nodes will be traversed as well.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/node_visitor.cr#L56" target="_blank">View source</a>]
</div>
</div>

41
Ameba/AST/RedundantControlExpressionVisitor.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST::RedundantControlExpressionVisitor - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::AST::RedundantControlExpressionVisitor - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -600,6 +600,13 @@ is reached.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/redundant_control_expression_visitor.cr#L5" target="_blank">
ameba/ast/visitors/redundant_control_expression_visitor.cr
</a>
<br/>
@ -708,6 +715,8 @@ is reached.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/redundant_control_expression_visitor.cr#L15" target="_blank">View source</a>]
</div>
</div>
@ -741,6 +750,8 @@ is reached.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/redundant_control_expression_visitor.cr#L13" target="_blank">View source</a>]
</div>
</div>
@ -760,6 +771,8 @@ is reached.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/redundant_control_expression_visitor.cr#L7" target="_blank">View source</a>]
</div>
</div>
@ -779,6 +792,8 @@ is reached.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/redundant_control_expression_visitor.cr#L10" target="_blank">View source</a>]
</div>
</div>

37
Ameba/AST/Reference.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST::Reference - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::AST::Reference - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -600,6 +600,13 @@ the variable from its reference.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/reference.cr#L7" target="_blank">
ameba/ast/variabling/reference.cr
</a>
<br/>
@ -807,6 +814,8 @@ the variable from its reference.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/reference.cr#L8" target="_blank">View source</a>]
</div>
</div>
@ -821,6 +830,8 @@ the variable from its reference.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/reference.cr#L8" target="_blank">View source</a>]
</div>
</div>

105
Ameba/AST/Scope.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST::Scope - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::AST::Scope - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -599,6 +599,13 @@ This is where the local variables belong to.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L6" target="_blank">
ameba/ast/scope.cr
</a>
<br/>
@ -887,12 +894,14 @@ This is where the local variables belong to.</p>
<p>Creates a new scope. Accepts the AST node and the outer scope.</p>
<pre><code class="language-crystal">scope <span class="o">=</span> <span class="t">Scope</span>.<span class="k">new</span>(class_node, <span class="n">nil</span>)</code></pre>
<pre><code>scope <span class="o">=</span> <span class="t">Scope</span>.<span class="k">new</span>(class_node, <span class="n">nil</span>)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L39" target="_blank">View source</a>]
</div>
</div>
@ -945,13 +954,15 @@ This is where the local variables belong to.</p>
<p>Creates a new argument in the current scope.</p>
<pre><code class="language-crystal">scope <span class="o">=</span> <span class="t">Scope</span>.<span class="k">new</span>(class_node, <span class="n">nil</span>)
<pre><code>scope <span class="o">=</span> <span class="t">Scope</span>.<span class="k">new</span>(class_node, <span class="n">nil</span>)
scope.add_argument(arg_node)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L59" target="_blank">View source</a>]
</div>
</div>
@ -967,13 +978,15 @@ scope.add_argument(arg_node)</code></pre>
<p>Adds a new instance variable to the current scope.</p>
<pre><code class="language-crystal">scope <span class="o">=</span> <span class="t">Scope</span>.<span class="k">new</span>(class_node, <span class="n">nil</span>)
<pre><code>scope <span class="o">=</span> <span class="t">Scope</span>.<span class="k">new</span>(class_node, <span class="n">nil</span>)
scope.add_ivariable(ivar_node)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L70" target="_blank">View source</a>]
</div>
</div>
@ -989,13 +1002,15 @@ scope.add_ivariable(ivar_node)</code></pre>
<p>Creates a new variable in the current scope.</p>
<pre><code class="language-crystal">scope <span class="o">=</span> <span class="t">Scope</span>.<span class="k">new</span>(class_node, <span class="n">nil</span>)
<pre><code>scope <span class="o">=</span> <span class="t">Scope</span>.<span class="k">new</span>(class_node, <span class="n">nil</span>)
scope.add_variable(var_node)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L49" target="_blank">View source</a>]
</div>
</div>
@ -1015,6 +1030,8 @@ scope.add_variable(var_node)</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L155" target="_blank">View source</a>]
</div>
</div>
@ -1034,6 +1051,8 @@ scope.add_variable(var_node)</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L14" target="_blank">View source</a>]
</div>
</div>
@ -1049,13 +1068,15 @@ scope.add_variable(var_node)</code></pre>
<p>Creates a new assignment for the variable.</p>
<pre><code class="language-crystal">scope <span class="o">=</span> <span class="t">Scope</span>.<span class="k">new</span>(class_node, <span class="n">nil</span>)
<pre><code>scope <span class="o">=</span> <span class="t">Scope</span>.<span class="k">new</span>(class_node, <span class="n">nil</span>)
scope.assign_variable(var_name, assign_node)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L90" target="_blank">View source</a>]
</div>
</div>
@ -1075,6 +1096,8 @@ scope.assign_variable(var_name, assign_node)</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L119" target="_blank">View source</a>]
</div>
</div>
@ -1095,6 +1118,8 @@ false if not.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L96" target="_blank">View source</a>]
</div>
</div>
@ -1114,6 +1139,8 @@ false if not.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L145" target="_blank">View source</a>]
</div>
</div>
@ -1128,6 +1155,8 @@ false if not.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L30" target="_blank">View source</a>]
</div>
</div>
@ -1142,6 +1171,8 @@ false if not.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L30" target="_blank">View source</a>]
</div>
</div>
@ -1162,6 +1193,8 @@ the same Crystal node as <code>@node</code>.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L174" target="_blank">View source</a>]
</div>
</div>
@ -1177,13 +1210,15 @@ the same Crystal node as <code>@node</code>.</p>
<p>Returns variable by its name or nil if it does not exist.</p>
<pre><code class="language-crystal">scope <span class="o">=</span> <span class="t">Scope</span>.<span class="k">new</span>(class_node, <span class="n">nil</span>)
<pre><code>scope <span class="o">=</span> <span class="t">Scope</span>.<span class="k">new</span>(class_node, <span class="n">nil</span>)
scope.find_variable(<span class="s">&quot;foo&quot;</span>)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L80" target="_blank">View source</a>]
</div>
</div>
@ -1226,6 +1261,8 @@ scope.find_variable(<span class="s">&quot;foo&quot;</span>)</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L114" target="_blank">View source</a>]
</div>
</div>
@ -1245,6 +1282,8 @@ scope.find_variable(<span class="s">&quot;foo&quot;</span>)</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L23" target="_blank">View source</a>]
</div>
</div>
@ -1264,6 +1303,8 @@ scope.find_variable(<span class="s">&quot;foo&quot;</span>)</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L17" target="_blank">View source</a>]
</div>
</div>
@ -1278,6 +1319,8 @@ scope.find_variable(<span class="s">&quot;foo&quot;</span>)</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L29" target="_blank">View source</a>]
</div>
</div>
@ -1292,6 +1335,8 @@ scope.find_variable(<span class="s">&quot;foo&quot;</span>)</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L29" target="_blank">View source</a>]
</div>
</div>
@ -1311,6 +1356,8 @@ scope.find_variable(<span class="s">&quot;foo&quot;</span>)</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L26" target="_blank">View source</a>]
</div>
</div>
@ -1330,6 +1377,8 @@ scope.find_variable(<span class="s">&quot;foo&quot;</span>)</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L20" target="_blank">View source</a>]
</div>
</div>
@ -1349,6 +1398,8 @@ scope.find_variable(<span class="s">&quot;foo&quot;</span>)</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L11" target="_blank">View source</a>]
</div>
</div>
@ -1369,6 +1420,8 @@ false if not.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L137" target="_blank">View source</a>]
</div>
</div>
@ -1384,7 +1437,7 @@ false if not.</p>
<p>Returns true if current scope represents a spawn block, e. g.</p>
<pre><code class="language-crystal">spawn <span class="k">do</span>
<pre><code>spawn <span class="k">do</span>
<span class="c"># ...</span>
<span class="k">end</span></code></pre>
</div>
@ -1392,6 +1445,8 @@ false if not.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L107" target="_blank">View source</a>]
</div>
</div>
@ -1406,6 +1461,8 @@ false if not.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L28" target="_blank">View source</a>]
</div>
</div>
@ -1420,6 +1477,8 @@ false if not.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L28" target="_blank">View source</a>]
</div>
</div>
@ -1439,6 +1498,8 @@ false if not.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L150" target="_blank">View source</a>]
</div>
</div>
@ -1459,6 +1520,8 @@ type definition, for example a class.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L126" target="_blank">View source</a>]
</div>
</div>
@ -1478,6 +1541,8 @@ type definition, for example a class.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/scope.cr#L8" target="_blank">View source</a>]
</div>
</div>

35
Ameba/AST/ScopeVisitor.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST::ScopeVisitor - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::AST::ScopeVisitor - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -598,6 +598,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/scope_visitor.cr#L5" target="_blank">
ameba/ast/visitors/scope_visitor.cr
</a>
<br/>
@ -735,6 +742,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/visitors/scope_visitor.cr#L13" target="_blank">View source</a>]
</div>
</div>

53
Ameba/AST/Util.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST::Util - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::AST::Util - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -628,6 +628,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/util.cr#L2" target="_blank">
ameba/ast/util.cr
</a>
<br/>
@ -743,6 +750,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/util.cr#L141" target="_blank">View source</a>]
</div>
</div>
@ -762,6 +771,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/util.cr#L135" target="_blank">View source</a>]
</div>
</div>
@ -783,6 +794,8 @@ or special call node that interrupts execution (i.e. raise, exit, abort).</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/util.cr#L62" target="_blank">View source</a>]
</div>
</div>
@ -802,7 +815,7 @@ Node represents a flow expression if it is full-filled by a flow command.</p>
<p>For example, this node is a flow expression, because each branch contains
a flow command <code>return</code>:</p>
<pre><code class="language-crystal"><span class="k">if</span> a <span class="o">&gt;</span> <span class="n">0</span>
<pre><code><span class="k">if</span> a <span class="o">&gt;</span> <span class="n">0</span>
<span class="k">return</span> <span class="n">:positive</span>
<span class="k">elsif</span> a <span class="o">&lt;</span> <span class="n">0</span>
<span class="k">return</span> <span class="n">:negative</span>
@ -812,7 +825,7 @@ a flow command <code>return</code>:</p>
<p>This node is a not a flow expression:</p>
<pre><code class="language-crystal"><span class="k">if</span> a <span class="o">&gt;</span> <span class="n">0</span>
<pre><code><span class="k">if</span> a <span class="o">&gt;</span> <span class="n">0</span>
<span class="k">return</span> <span class="n">:positive</span>
<span class="k">end</span></code></pre>
@ -822,6 +835,8 @@ a flow command <code>return</code>:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/util.cr#L101" target="_blank">View source</a>]
</div>
</div>
@ -841,6 +856,8 @@ a flow command <code>return</code>:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/util.cr#L4" target="_blank">View source</a>]
</div>
</div>
@ -860,6 +877,8 @@ a flow command <code>return</code>:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/util.cr#L147" target="_blank">View source</a>]
</div>
</div>
@ -881,6 +900,8 @@ to determine and cut a piece of source of the node.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/util.cr#L33" target="_blank">View source</a>]
</div>
</div>
@ -900,6 +921,8 @@ to determine and cut a piece of source of the node.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/util.cr#L129" target="_blank">View source</a>]
</div>
</div>

97
Ameba/AST/Variable.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST::Variable - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::AST::Variable - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -613,6 +613,13 @@ Holds the var node and variable assigments.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L4" target="_blank">
ameba/ast/variabling/variable.cr
</a>
<br/>
@ -855,12 +862,14 @@ Holds the var node and variable assigments.</p>
<p>Creates a new variable(in the scope).</p>
<pre><code class="language-crystal"><span class="t">Variable</span>.<span class="k">new</span>(node, scope)</code></pre>
<pre><code><span class="t">Variable</span>.<span class="k">new</span>(node, scope)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L31" target="_blank">View source</a>]
</div>
</div>
@ -891,7 +900,7 @@ Holds the var node and variable assigments.</p>
<p>Assigns the variable (creates a new assignment).
Variable may have multiple assignments.</p>
<pre><code class="language-crystal">variable <span class="o">=</span> <span class="t">Variable</span>.<span class="k">new</span>(node, scope)
<pre><code>variable <span class="o">=</span> <span class="t">Variable</span>.<span class="k">new</span>(node, scope)
variable.assign(node1)
variable.assign(node2)
variable.assignment.size <span class="c"># =&gt; 2</span></code></pre>
@ -900,6 +909,8 @@ variable.assignment.size <span class="c"># =&gt; 2</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L49" target="_blank">View source</a>]
</div>
</div>
@ -919,6 +930,8 @@ variable.assignment.size <span class="c"># =&gt; 2</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L18" target="_blank">View source</a>]
</div>
</div>
@ -938,6 +951,8 @@ variable.assignment.size <span class="c"># =&gt; 2</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L6" target="_blank">View source</a>]
</div>
</div>
@ -955,18 +970,20 @@ variable.assignment.size <span class="c"># =&gt; 2</span></code></pre>
in the block. For example this variable is captured
by block:</p>
<pre><code class="language-crystal">a <span class="o">=</span> <span class="n">1</span>
<pre><code>a <span class="o">=</span> <span class="n">1</span>
<span class="n">3</span>.times { <span class="o">|</span>i<span class="o">|</span> a <span class="o">=</span> a <span class="o">+</span> i }</code></pre>
<p>And this variable is not captured by block.</p>
<pre><code class="language-crystal">i <span class="o">=</span> <span class="n">1</span>
<pre><code>i <span class="o">=</span> <span class="n">1</span>
<span class="n">3</span>.times { <span class="o">|</span>i<span class="o">|</span> i <span class="o">+</span> <span class="n">1</span> }</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L114" target="_blank">View source</a>]
</div>
</div>
@ -986,6 +1003,8 @@ by block:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L160" target="_blank">View source</a>]
</div>
</div>
@ -1000,6 +1019,8 @@ by block:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L21" target="_blank">View source</a>]
</div>
</div>
@ -1014,6 +1035,8 @@ by block:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L21" target="_blank">View source</a>]
</div>
</div>
@ -1034,6 +1057,8 @@ the same Crystal node as <code>@node</code>.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L153" target="_blank">View source</a>]
</div>
</div>
@ -1053,6 +1078,8 @@ the same Crystal node as <code>@node</code>.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L147" target="_blank">View source</a>]
</div>
</div>
@ -1067,6 +1094,8 @@ the same Crystal node as <code>@node</code>.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L20" target="_blank">View source</a>]
</div>
</div>
@ -1081,6 +1110,8 @@ the same Crystal node as <code>@node</code>.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L20" target="_blank">View source</a>]
</div>
</div>
@ -1095,6 +1126,8 @@ the same Crystal node as <code>@node</code>.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L22" target="_blank">View source</a>]
</div>
</div>
@ -1109,6 +1142,8 @@ the same Crystal node as <code>@node</code>.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L22" target="_blank">View source</a>]
</div>
</div>
@ -1128,6 +1163,8 @@ the same Crystal node as <code>@node</code>.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L12" target="_blank">View source</a>]
</div>
</div>
@ -1143,13 +1180,15 @@ the same Crystal node as <code>@node</code>.</p>
<p>Creates a reference to this variable in some scope.</p>
<pre><code class="language-crystal">variable <span class="o">=</span> <span class="t">Variable</span>.<span class="k">new</span>(node, scope)
<pre><code>variable <span class="o">=</span> <span class="t">Variable</span>.<span class="k">new</span>(node, scope)
variable.reference(var_node, some_scope)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L73" target="_blank">View source</a>]
</div>
</div>
@ -1165,7 +1204,7 @@ variable.reference(var_node, some_scope)</code></pre>
<p>Reference variable's assignments.</p>
<pre><code class="language-crystal">variable <span class="o">=</span> <span class="t">Variable</span>.<span class="k">new</span>(node, scope)
<pre><code>variable <span class="o">=</span> <span class="t">Variable</span>.<span class="k">new</span>(node, scope)
variable.assign(assign_node)
variable.reference_assignments!</code></pre>
</div>
@ -1173,6 +1212,8 @@ variable.reference_assignments!</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L87" target="_blank">View source</a>]
</div>
</div>
@ -1188,7 +1229,7 @@ variable.reference_assignments!</code></pre>
<p>Returns true if variable has any reference.</p>
<pre><code class="language-crystal">variable <span class="o">=</span> <span class="t">Variable</span>.<span class="k">new</span>(node, scope)
<pre><code>variable <span class="o">=</span> <span class="t">Variable</span>.<span class="k">new</span>(node, scope)
variable.reference(var_node)
variable.referenced? <span class="c"># =&gt; true</span></code></pre>
</div>
@ -1196,6 +1237,8 @@ variable.referenced? <span class="c"># =&gt; true</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L62" target="_blank">View source</a>]
</div>
</div>
@ -1215,6 +1258,8 @@ variable.referenced? <span class="c"># =&gt; true</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L9" target="_blank">View source</a>]
</div>
</div>
@ -1234,6 +1279,8 @@ variable.referenced? <span class="c"># =&gt; true</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L15" target="_blank">View source</a>]
</div>
</div>
@ -1253,6 +1300,8 @@ variable.referenced? <span class="c"># =&gt; true</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L35" target="_blank">View source</a>]
</div>
</div>
@ -1273,6 +1322,8 @@ false otherwise.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L135" target="_blank">View source</a>]
</div>
</div>
@ -1287,6 +1338,8 @@ false otherwise.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L23" target="_blank">View source</a>]
</div>
</div>
@ -1301,6 +1354,8 @@ false otherwise.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L23" target="_blank">View source</a>]
</div>
</div>
@ -1321,6 +1376,8 @@ false if not.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/ast/variabling/variable.cr#L125" target="_blank">View source</a>]
</div>
</div>

87
Ameba/Config.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Config - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Config - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,7 +578,7 @@
<p>Config can be loaded from configuration YAML file and adjusted.</p>
<pre><code class="language-crystal">config <span class="o">=</span> <span class="t">Config</span>.load
<pre><code>config <span class="o">=</span> <span class="t">Config</span>.load
config.formatter <span class="o">=</span> my_formatter</code></pre>
<p>By default config loads <code>.ameba.yml</code> file in a current directory.</p>
@ -619,6 +619,13 @@ config.formatter <span class="o">=</span> my_formatter</code></pre>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/config.cr#L15" target="_blank">
ameba/config.cr
</a>
<br/>
@ -851,6 +858,8 @@ config.formatter <span class="o">=</span> my_formatter</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/config.cr#L86" target="_blank">View source</a>]
</div>
</div>
@ -866,12 +875,14 @@ config.formatter <span class="o">=</span> my_formatter</code></pre>
<p>Loads YAML configuration file by <code>path</code>.</p>
<pre><code class="language-crystal">config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load</code></pre>
<pre><code>config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/config.cr#L78" target="_blank">View source</a>]
</div>
</div>
@ -900,13 +911,15 @@ config.formatter <span class="o">=</span> my_formatter</code></pre>
<p>Represents a list of paths to exclude from globs.
Can have wildcards.</p>
<pre><code class="language-crystal">config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
<pre><code>config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
config.excluded <span class="o">=</span> [<span class="s">&quot;spec&quot;</span>, <span class="s">&quot;src/server/*.cr&quot;</span>]</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/config.cr#L56" target="_blank">View source</a>]
</div>
</div>
@ -923,13 +936,15 @@ config.excluded <span class="o">=</span> [<span class="s">&quot;spec&quot;</span
<p>Represents a list of paths to exclude from globs.
Can have wildcards.</p>
<pre><code class="language-crystal">config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
<pre><code>config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
config.excluded <span class="o">=</span> [<span class="s">&quot;spec&quot;</span>, <span class="s">&quot;src/server/*.cr&quot;</span>]</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/config.cr#L56" target="_blank">View source</a>]
</div>
</div>
@ -946,7 +961,7 @@ config.excluded <span class="o">=</span> [<span class="s">&quot;spec&quot;</span
<p>Returns a formatter to be used while inspecting files.
If formatter is not set, it will return default formatter.</p>
<pre><code class="language-crystal">config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
<pre><code>config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
config.formatter <span class="o">=</span> custom_formatter
config.formatter</code></pre>
</div>
@ -954,6 +969,8 @@ config.formatter</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/config.cr#L114" target="_blank">View source</a>]
</div>
</div>
@ -968,6 +985,8 @@ config.formatter</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/config.cr#L34" target="_blank">View source</a>]
</div>
</div>
@ -983,13 +1002,15 @@ config.formatter</code></pre>
<p>Sets formatter by name.</p>
<pre><code class="language-crystal">config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
<pre><code>config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
config.formatter <span class="o">=</span> <span class="n">:progress</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/config.cr#L125" target="_blank">View source</a>]
</div>
</div>
@ -1007,7 +1028,7 @@ config.formatter <span class="o">=</span> <span class="n">:progress</span></code
Represents a list of sources to be inspected.
If globs are not set, it will return default list of files.</p>
<pre><code class="language-crystal">config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
<pre><code>config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
config.globs <span class="o">=</span> [<span class="s">&quot;**/*.cr&quot;</span>]
config.globs</code></pre>
</div>
@ -1015,6 +1036,8 @@ config.globs</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/config.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1032,7 +1055,7 @@ config.globs</code></pre>
Represents a list of sources to be inspected.
If globs are not set, it will return default list of files.</p>
<pre><code class="language-crystal">config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
<pre><code>config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
config.globs <span class="o">=</span> [<span class="s">&quot;**/*.cr&quot;</span>]
config.globs</code></pre>
</div>
@ -1040,6 +1063,8 @@ config.globs</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/config.cr#L47" target="_blank">View source</a>]
</div>
</div>
@ -1054,6 +1079,8 @@ config.globs</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/config.cr#L35" target="_blank">View source</a>]
</div>
</div>
@ -1068,6 +1095,8 @@ config.globs</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/config.cr#L36" target="_blank">View source</a>]
</div>
</div>
@ -1082,6 +1111,8 @@ config.globs</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/config.cr#L36" target="_blank">View source</a>]
</div>
</div>
@ -1097,7 +1128,7 @@ config.globs</code></pre>
<p>Returns a list of sources matching globs and excluded sections.</p>
<pre><code class="language-crystal">config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
<pre><code>config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
config.sources <span class="c"># =&gt; list of default sources</span>
config.globs <span class="o">=</span> [<span class="s">&quot;**/*.cr&quot;</span>]
config.excluded <span class="o">=</span> [<span class="s">&quot;spec&quot;</span>]
@ -1107,6 +1138,8 @@ config.sources <span class="c"># =&gt; list of sources pointing to files found b
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/config.cr#L100" target="_blank">View source</a>]
</div>
</div>
@ -1122,13 +1155,15 @@ config.sources <span class="c"># =&gt; list of sources pointing to files found b
<p>Updates rule properties.</p>
<pre><code class="language-crystal">config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
<pre><code>config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
config.update_rule <span class="s">&quot;MyRuleName&quot;</span>, enabled: <span class="n">false</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/config.cr#L140" target="_blank">View source</a>]
</div>
</div>
@ -1144,17 +1179,19 @@ config.update_rule <span class="s">&quot;MyRuleName&quot;</span>, enabled: <span
<p>Updates rules properties.</p>
<pre><code class="language-crystal">config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
<pre><code>config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
config.update_rules <span class="s">%w(Rule1 Rule2)</span>, enabled: <span class="n">true</span></code></pre>
<p>also it allows to update groups of rules:</p>
<pre><code class="language-crystal">config.update_rules <span class="s">%w(Group1 Group2)</span>, enabled: <span class="n">true</span></code></pre>
<pre><code>config.update_rules <span class="s">%w(Group1 Group2)</span>, enabled: <span class="n">true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/config.cr#L163" target="_blank">View source</a>]
</div>
</div>

82
Ameba/Formatter.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Formatter - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Formatter - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -596,6 +596,62 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/base_formatter.cr#L4" target="_blank">
ameba/formatter/base_formatter.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/disabled_formatter.cr#L1" target="_blank">
ameba/formatter/disabled_formatter.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/dot_formatter.cr#L3" target="_blank">
ameba/formatter/dot_formatter.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/explain_formatter.cr#L3" target="_blank">
ameba/formatter/explain_formatter.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/flycheck_formatter.cr#L1" target="_blank">
ameba/formatter/flycheck_formatter.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/json_formatter.cr#L3" target="_blank">
ameba/formatter/json_formatter.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/todo_formatter.cr#L1" target="_blank">
ameba/formatter/todo_formatter.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/util.cr#L1" target="_blank">
ameba/formatter/util.cr
</a>
<br/>

47
Ameba/Formatter/BaseFormatter.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Formatter::BaseFormatter - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Formatter::BaseFormatter - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -620,6 +620,13 @@ callbacks in <code><a href="../../Ameba/Runner.html#run-instance-method">Ameba::
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/base_formatter.cr#L8" target="_blank">
ameba/formatter/base_formatter.cr
</a>
<br/>
@ -747,6 +754,8 @@ callbacks in <code><a href="../../Ameba/Runner.html#run-instance-method">Ameba::
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/base_formatter.cr#L13" target="_blank">View source</a>]
</div>
</div>
@ -775,6 +784,8 @@ callbacks in <code><a href="../../Ameba/Runner.html#run-instance-method">Ameba::
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/base_formatter.cr#L11" target="_blank">View source</a>]
</div>
</div>
@ -795,6 +806,8 @@ A list of inspected sources is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/base_formatter.cr#L30" target="_blank">View source</a>]
</div>
</div>
@ -814,6 +827,8 @@ A list of inspected sources is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/base_formatter.cr#L10" target="_blank">View source</a>]
</div>
</div>
@ -834,6 +849,8 @@ A corresponding source is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/base_formatter.cr#L22" target="_blank">View source</a>]
</div>
</div>
@ -854,6 +871,8 @@ A corresponding source is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/base_formatter.cr#L26" target="_blank">View source</a>]
</div>
</div>
@ -874,6 +893,8 @@ A list of sources to inspect is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/base_formatter.cr#L18" target="_blank">View source</a>]
</div>
</div>

35
Ameba/Formatter/DisabledFormatter.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Formatter::DisabledFormatter - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Formatter::DisabledFormatter - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -598,6 +598,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/disabled_formatter.cr#L3" target="_blank">
ameba/formatter/disabled_formatter.cr
</a>
<br/>
@ -742,6 +749,8 @@ A list of inspected sources is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/disabled_formatter.cr#L4" target="_blank">View source</a>]
</div>
</div>

39
Ameba/Formatter/DotFormatter.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Formatter::DotFormatter - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Formatter::DotFormatter - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -627,6 +627,13 @@ It is similar to Crystal's dot formatter for specs.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/dot_formatter.cr#L6" target="_blank">
ameba/formatter/dot_formatter.cr
</a>
<br/>
@ -799,6 +806,8 @@ It is similar to Crystal's dot formatter for specs.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/dot_formatter.cr#L26" target="_blank">View source</a>]
</div>
</div>
@ -818,6 +827,8 @@ It is similar to Crystal's dot formatter for specs.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/dot_formatter.cr#L20" target="_blank">View source</a>]
</div>
</div>
@ -837,6 +848,8 @@ It is similar to Crystal's dot formatter for specs.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/dot_formatter.cr#L13" target="_blank">View source</a>]
</div>
</div>

43
Ameba/Formatter/ExplainFormatter.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Formatter::ExplainFormatter - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Formatter::ExplainFormatter - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -613,6 +613,13 @@ a specific location.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/explain_formatter.cr#L6" target="_blank">
ameba/formatter/explain_formatter.cr
</a>
<br/>
@ -770,13 +777,15 @@ a specific location.</p>
Accepts <em>output</em> which indicates the io where the explanation will be wrtitten to.
Second argument is <em>location</em> which indicates the location to explain.</p>
<pre><code class="language-crystal"><span class="t">ExplainFormatter</span>.<span class="k">new</span> output,
<pre><code><span class="t">ExplainFormatter</span>.<span class="k">new</span> output,
{file: path, line: line_number, column: column_number}</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/explain_formatter.cr#L25" target="_blank">View source</a>]
</div>
</div>
@ -810,6 +819,8 @@ Second argument is <em>location</em> which indicates the location to explain.</p
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/explain_formatter.cr#L30" target="_blank">View source</a>]
</div>
</div>
@ -824,6 +835,8 @@ Second argument is <em>location</em> which indicates the location to explain.</p
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/explain_formatter.cr#L14" target="_blank">View source</a>]
</div>
</div>
@ -838,6 +851,8 @@ Second argument is <em>location</em> which indicates the location to explain.</p
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/explain_formatter.cr#L13" target="_blank">View source</a>]
</div>
</div>

35
Ameba/Formatter/FlycheckFormatter.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Formatter::FlycheckFormatter - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Formatter::FlycheckFormatter - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -587,6 +587,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/flycheck_formatter.cr#L2" target="_blank">
ameba/formatter/flycheck_formatter.cr
</a>
<br/>
@ -731,6 +738,8 @@ A corresponding source is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/flycheck_formatter.cr#L5" target="_blank">View source</a>]
</div>
</div>

43
Ameba/Formatter/JSONFormatter.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Formatter::JSONFormatter - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Formatter::JSONFormatter - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,7 +578,7 @@
<p>Example:</p>
<pre><code class="language-crystal">{
<pre><code>{
<span class="s">&quot;metadata&quot;</span>: {
<span class="s">&quot;ameba_version&quot;</span>: <span class="s">&quot;x.x.x&quot;</span>,
<span class="s">&quot;crystal_version&quot;</span>: <span class="s">&quot;x.x.x&quot;</span>,
@ -656,6 +656,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/json_formatter.cr#L66" target="_blank">
ameba/formatter/json_formatter.cr
</a>
<br/>
@ -817,6 +824,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/json_formatter.cr#L67" target="_blank">View source</a>]
</div>
</div>
@ -855,6 +864,8 @@ A list of inspected sources is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/json_formatter.cr#L87" target="_blank">View source</a>]
</div>
</div>
@ -879,6 +890,8 @@ A corresponding source is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/json_formatter.cr#L75" target="_blank">View source</a>]
</div>
</div>
@ -903,6 +916,8 @@ A list of sources to inspect is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/json_formatter.cr#L71" target="_blank">View source</a>]
</div>
</div>

37
Ameba/Formatter/TODOFormatter.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Formatter::TODOFormatter - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Formatter::TODOFormatter - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -600,6 +600,13 @@ or excludes failed sources from these rules.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/todo_formatter.cr#L5" target="_blank">
ameba/formatter/todo_formatter.cr
</a>
<br/>
@ -795,6 +802,8 @@ or excludes failed sources from these rules.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/todo_formatter.cr#L6" target="_blank">View source</a>]
</div>
</div>
@ -832,6 +841,8 @@ or excludes failed sources from these rules.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/todo_formatter.cr#L9" target="_blank">View source</a>]
</div>
</div>

35
Ameba/Formatter/Util.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Formatter::Util - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Formatter::Util - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -601,6 +601,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/util.cr#L2" target="_blank">
ameba/formatter/util.cr
</a>
<br/>
@ -660,6 +667,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/formatter/util.cr#L3" target="_blank">View source</a>]
</div>
</div>

41
Ameba/GlobUtils.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::GlobUtils - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::GlobUtils - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -610,6 +610,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/glob_utils.cr#L3" target="_blank">
ameba/glob_utils.cr
</a>
<br/>
@ -679,12 +686,14 @@
<p>Expands globs. Globs can point to files or even directories.</p>
<pre><code class="language-crystal">expand([<span class="s">&quot;spec/*.cr&quot;</span>, <span class="s">&quot;src&quot;</span>]) <span class="c"># =&gt; all files in src folder + first level specs</span></code></pre>
<pre><code>expand([<span class="s">&quot;spec/*.cr&quot;</span>, <span class="s">&quot;src&quot;</span>]) <span class="c"># =&gt; all files in src folder + first level specs</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/glob_utils.cr#L24" target="_blank">View source</a>]
</div>
</div>
@ -701,12 +710,14 @@
<p>Returns all files that match specified globs.
Globs can have wildcards or be rejected:</p>
<pre><code class="language-crystal">find_files_by_globs([<span class="s">&quot;**/*.cr&quot;</span>, <span class="s">&quot;!lib&quot;</span>])</code></pre>
<pre><code>find_files_by_globs([<span class="s">&quot;**/*.cr&quot;</span>, <span class="s">&quot;!lib&quot;</span>])</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/glob_utils.cr#L11" target="_blank">View source</a>]
</div>
</div>

47
Ameba/InlineComments.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::InlineComments - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::InlineComments - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -610,6 +610,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/inline_comments.cr#L3" target="_blank">
ameba/inline_comments.cr
</a>
<br/>
@ -709,6 +716,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/inline_comments.cr#L80" target="_blank">View source</a>]
</div>
</div>
@ -731,14 +740,14 @@ false otherwise.</p>
<p>For example, here are two examples of disabled location:</p>
<pre><code class="language-crystal"><span class="c"># ameba:disable Style/LargeNumbers</span>
<pre><code><span class="c"># ameba:disable Style/LargeNumbers</span>
<span class="t">Time</span>.epoch(<span class="n">1483859302</span>)
<span class="t">Time</span>.epoch(<span class="n">1483859302</span>) <span class="c"># ameba:disable Style/LargeNumbers</span></code></pre>
<p>But here are examples which are not considered as disabled location:</p>
<pre><code class="language-crystal"><span class="c"># ameba:disable Style/LargeNumbers</span>
<pre><code><span class="c"># ameba:disable Style/LargeNumbers</span>
<span class="c">#</span>
<span class="t">Time</span>.epoch(<span class="n">1483859302</span>)
@ -750,6 +759,8 @@ false otherwise.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/inline_comments.cr#L40" target="_blank">View source</a>]
</div>
</div>
@ -766,20 +777,22 @@ false otherwise.</p>
<p>Parses inline comment directive. Returns a tuple that consists of
an action and parsed rules if directive found, nil otherwise.</p>
<pre><code class="language-crystal">line <span class="o">=</span> <span class="s">&quot;# ameba:disable Rule1, Rule2&quot;</span>
<pre><code>line <span class="o">=</span> <span class="s">&quot;# ameba:disable Rule1, Rule2&quot;</span>
directive <span class="o">=</span> parse_inline_directive(line)
directive[<span class="n">:action</span>] <span class="c"># =&gt; &quot;disable&quot;</span>
directive[<span class="n">:rules</span>] <span class="c"># =&gt; [&quot;Rule1&quot;, &quot;Rule2&quot;]</span></code></pre>
<p>It ignores the directive if it is commented out.</p>
<pre><code class="language-crystal">line <span class="o">=</span> <span class="s">&quot;# # ameba:disable Rule1, Rule2&quot;</span>
<pre><code>line <span class="o">=</span> <span class="s">&quot;# # ameba:disable Rule1, Rule2&quot;</span>
parse_inline_directive(line) <span class="c"># =&gt; nil</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/inline_comments.cr#L69" target="_blank">View source</a>]
</div>
</div>

37
Ameba/InlineComments/Action.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::InlineComments::Action - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::InlineComments::Action - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -596,6 +596,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/inline_comments.cr#L7" target="_blank">
ameba/inline_comments.cr
</a>
<br/>
@ -724,6 +731,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/inline_comments.cr#L8" target="_blank">View source</a>]
</div>
</div>
@ -738,6 +747,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/inline_comments.cr#L9" target="_blank">View source</a>]
</div>
</div>

43
Ameba/Issue.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Issue - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Issue - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -598,6 +598,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/issue.cr#L3" target="_blank">
ameba/issue.cr
</a>
<br/>
@ -740,6 +747,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/issue.cr#L3" target="_blank">View source</a>]
</div>
</div>
@ -768,6 +777,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/issue.cr#L3" target="_blank">View source</a>]
</div>
</div>
@ -782,6 +793,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/issue.cr#L3" target="_blank">View source</a>]
</div>
</div>
@ -796,6 +809,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/issue.cr#L18" target="_blank">View source</a>]
</div>
</div>
@ -880,6 +895,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/issue.cr#L22" target="_blank">View source</a>]
</div>
</div>

47
Ameba/Reportable.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Reportable - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Reportable - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -610,6 +610,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/reportable.cr#L3" target="_blank">
ameba/reportable.cr
</a>
<br/>
@ -718,6 +725,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/reportable.cr#L30" target="_blank">View source</a>]
</div>
</div>
@ -737,6 +746,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/reportable.cr#L8" target="_blank">View source</a>]
</div>
</div>
@ -756,6 +767,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/reportable.cr#L24" target="_blank">View source</a>]
</div>
</div>
@ -775,6 +788,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/reportable.cr#L14" target="_blank">View source</a>]
</div>
</div>
@ -794,6 +809,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/reportable.cr#L19" target="_blank">View source</a>]
</div>
</div>
@ -813,6 +830,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/reportable.cr#L5" target="_blank">View source</a>]
</div>
</div>
@ -832,6 +851,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/reportable.cr#L37" target="_blank">View source</a>]
</div>
</div>

37
Ameba/Rule.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -585,6 +585,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/base.cr#L1" target="_blank">
ameba/rule/base.cr
</a>
<br/>
@ -669,12 +676,14 @@ behave differently than usual rules.</p>
<p>Returns a list of all available rules.</p>
<pre><code class="language-crystal"><span class="t">Ameba</span><span class="t">::</span><span class="t">Rule</span>.rules <span class="c"># =&gt; [Rule1, Rule2, ....]</span></code></pre>
<pre><code><span class="t">Ameba</span><span class="t">::</span><span class="t">Rule</span>.rules <span class="c"># =&gt; [Rule1, Rule2, ....]</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/base.cr#L194" target="_blank">View source</a>]
</div>
</div>

77
Ameba/Rule/Base.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Base - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Base - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -577,7 +577,7 @@
<p>Represents a base of all rules. In other words, all rules
inherits from this struct:</p>
<pre><code class="language-crystal"><span class="k">struct</span> <span class="t">MyRule</span> <span class="o">&lt;</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Rule</span><span class="t">::</span><span class="t">Base</span>
<pre><code><span class="k">struct</span> <span class="t">MyRule</span> <span class="o">&lt;</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Rule</span><span class="t">::</span><span class="t">Base</span>
<span class="k">def</span> <span class="m">test</span>(source)
<span class="k">if</span> invalid?(source)
issue_for line, column, <span class="s">&quot;Something wrong.&quot;</span>
@ -729,6 +729,13 @@ that are tested by this rule, it should add an issue.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/base.cr#L30" target="_blank">
ameba/rule/base.cr
</a>
<br/>
@ -933,6 +940,8 @@ that are tested by this rule, it should add an issue.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/base.cr#L30" target="_blank">View source</a>]
</div>
</div>
@ -960,7 +969,7 @@ that are tested by this rule, it should add an issue.</p>
<p>Returns documentation for this rule if any.</p>
<pre><code class="language-crystal"><span class="k">module</span> <span class="t">Ameba</span>
<pre><code><span class="k">module</span> <span class="t">Ameba</span>
<span class="c"># This is a test rule.</span>
<span class="c"># Does nothing.</span>
<span class="k">struct</span> <span class="t">MyRule</span> <span class="o">&lt;</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Rule</span><span class="t">::</span><span class="t">Base</span>
@ -975,6 +984,8 @@ that are tested by this rule, it should add an issue.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/base.cr#L157" target="_blank">View source</a>]
</div>
</div>
@ -1006,12 +1017,12 @@ that are tested by this rule, it should add an issue.</p>
<p>Returns <code>true</code> if this struct is equal to <em>other</em>.</p>
<p>Both structs' instance vars are compared to each other. Thus, two
<p>Both structs's instance vars are compared to each other. Thus, two
structs are considered equal if each of their instance variables are
equal. Subclasses should override this method to provide specific
equality semantics.</p>
<pre><code class="language-crystal"><span class="k">struct</span> <span class="t">Point</span>
<pre><code><span class="k">struct</span> <span class="t">Point</span>
<span class="k">def</span> <span class="m">initialize</span>(@x : <span class="t">Int32</span>, @y : <span class="t">Int32</span>)
<span class="k">end</span>
<span class="k">end</span>
@ -1027,6 +1038,8 @@ p1 <span class="o">==</span> p3 <span class="c"># =&gt; false</span></code></pre
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/base.cr#L113" target="_blank">View source</a>]
</div>
</div>
@ -1043,13 +1056,15 @@ p1 <span class="o">==</span> p3 <span class="c"># =&gt; false</span></code></pre
<p>A convenient addition to <code><a href="../../Ameba/Rule/Base.html#test(source:Source,node:Crystal::ASTNode,*opts)-instance-method">#test</a></code> method that does the same
but returns a passed in <code>source</code> as an addition.</p>
<pre><code class="language-crystal">source <span class="o">=</span> <span class="t">MyRule</span>.<span class="k">new</span>.catch(source)
<pre><code>source <span class="o">=</span> <span class="t">MyRule</span>.<span class="k">new</span>.catch(source)
source.valid?</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/base.cr#L54" target="_blank">View source</a>]
</div>
</div>
@ -1067,12 +1082,14 @@ source.valid?</code></pre>
It searches for a path in <code>excluded</code> property which matches
the one of the given source.</p>
<pre><code class="language-crystal">my_rule.excluded?(source) <span class="c"># =&gt; true or false</span></code></pre>
<pre><code>my_rule.excluded?(source) <span class="c"># =&gt; true or false</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/base.cr#L95" target="_blank">View source</a>]
</div>
</div>
@ -1088,7 +1105,7 @@ the one of the given source.</p>
<p>Returns a group this rule belong to.</p>
<pre><code class="language-crystal"><span class="k">struct</span> <span class="t">MyGroup</span><span class="t">::</span><span class="t">MyRule</span> <span class="o">&lt;</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Rule</span><span class="t">::</span><span class="t">Base</span>
<pre><code><span class="k">struct</span> <span class="t">MyGroup</span><span class="t">::</span><span class="t">MyRule</span> <span class="o">&lt;</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Rule</span><span class="t">::</span><span class="t">Base</span>
<span class="c"># ...</span>
<span class="k">end</span>
@ -1098,6 +1115,8 @@ the one of the given source.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/base.cr#L83" target="_blank">View source</a>]
</div>
</div>
@ -1117,7 +1136,7 @@ the one of the given source.</p>
<p>Generates an <code>UInt64</code> hash value for this object.</p>
<p>This method must have the property that <code>a == b</code> implies <code>a.hash == b.hash</code>.</p>
<p>This method must have the property that <code>a == b</code> implies <code>a<a href="../../Ameba/Rule/Base.html#hash-instance-method">.hash</a> == b<a href="../../Ameba/Rule/Base.html#hash-instance-method">.hash</a></code>.</p>
<p>The hash value is used along with <code><a href="../../Ameba/Rule/Base.html#==(other)-instance-method">#==</a></code> by the <code>Hash</code> class to determine if two objects
reference the same hash key.</p>
@ -1129,6 +1148,8 @@ though usually the macro <code>def_hash</code> can be used to generate this meth
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/base.cr#L117" target="_blank">View source</a>]
</div>
</div>
@ -1144,7 +1165,7 @@ though usually the macro <code>def_hash</code> can be used to generate this meth
<p>Returns a name of this rule, which is basically a class name.</p>
<pre><code class="language-crystal"><span class="k">struct</span> <span class="t">MyRule</span> <span class="o">&lt;</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Rule</span><span class="t">::</span><span class="t">Base</span>
<pre><code><span class="k">struct</span> <span class="t">MyRule</span> <span class="o">&lt;</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Rule</span><span class="t">::</span><span class="t">Base</span>
<span class="k">def</span> <span class="m">test</span>(source)
<span class="k">end</span>
<span class="k">end</span>
@ -1155,6 +1176,8 @@ though usually the macro <code>def_hash</code> can be used to generate this meth
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/base.cr#L69" target="_blank">View source</a>]
</div>
</div>
@ -1171,12 +1194,14 @@ though usually the macro <code>def_hash</code> can be used to generate this meth
<p>Returns true if this rule is special and behaves differently than
usual rules.</p>
<pre><code class="language-crystal">my_rule.special? <span class="c"># =&gt; true or false</span></code></pre>
<pre><code>my_rule.special? <span class="c"># =&gt; true or false</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/base.cr#L109" target="_blank">View source</a>]
</div>
</div>
@ -1191,6 +1216,8 @@ usual rules.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/base.cr#L42" target="_blank">View source</a>]
</div>
</div>
@ -1214,6 +1241,8 @@ Must be overriten for other type of rules.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/base.cr#L38" target="_blank">View source</a>]
</div>
</div>
@ -1240,6 +1269,8 @@ Must be overriten for other type of rules.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/base.cr#L121" target="_blank">View source</a>]
</div>
</div>

47
Ameba/Rule/Layout.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Layout - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Layout - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -585,6 +585,27 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/layout/line_length.cr#L1" target="_blank">
ameba/rule/layout/line_length.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/layout/trailing_blank_lines.cr#L1" target="_blank">
ameba/rule/layout/trailing_blank_lines.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/layout/trailing_whitespace.cr#L1" target="_blank">
ameba/rule/layout/trailing_whitespace.cr
</a>
<br/>

45
Ameba/Rule/Layout/LineLength.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Layout::LineLength - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Layout::LineLength - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,9 +578,9 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Layout/LineLength:
<pre><code><span class="t">Layout</span><span class="s">/LineLength:
Enabled: true
MaxLength: 100</code></pre>
MaxLength: 100</span></code></pre>
@ -620,6 +620,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/layout/line_length.cr#L12" target="_blank">
ameba/rule/layout/line_length.cr
</a>
<br/>
@ -917,14 +924,16 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Layout/LineLength:
<pre><code><span class="t">Layout</span><span class="s">/LineLength:
Enabled: true
MaxLength: 100</code></pre>
MaxLength: 100</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/layout/line_length.cr#L12" target="_blank">View source</a>]
</div>
</div>
@ -1093,6 +1102,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/layout/line_length.cr#L21" target="_blank">View source</a>]
</div>
</div>

45
Ameba/Rule/Layout/TrailingBlankLines.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Layout::TrailingBlankLines - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Layout::TrailingBlankLines - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,8 +578,8 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Layout/TrailingBlankLines:
Enabled: true</code></pre>
<pre><code><span class="t">Layout</span><span class="s">/TrailingBlankLines:
Enabled: true</span></code></pre>
@ -619,6 +619,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/layout/trailing_blank_lines.cr#L11" target="_blank">
ameba/rule/layout/trailing_blank_lines.cr
</a>
<br/>
@ -911,13 +918,15 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Layout/TrailingBlankLines:
Enabled: true</code></pre>
<pre><code><span class="t">Layout</span><span class="s">/TrailingBlankLines:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/layout/trailing_blank_lines.cr#L11" target="_blank">View source</a>]
</div>
</div>
@ -1058,6 +1067,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/layout/trailing_blank_lines.cr#L19" target="_blank">View source</a>]
</div>
</div>

45
Ameba/Rule/Layout/TrailingWhitespace.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Layout::TrailingWhitespace - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Layout::TrailingWhitespace - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,8 +578,8 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Layout/TrailingWhitespace:
Enabled: true</code></pre>
<pre><code><span class="t">Layout</span><span class="s">/TrailingWhitespace:
Enabled: true</span></code></pre>
@ -619,6 +619,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/layout/trailing_whitespace.cr#L11" target="_blank">
ameba/rule/layout/trailing_whitespace.cr
</a>
<br/>
@ -906,13 +913,15 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Layout/TrailingWhitespace:
Enabled: true</code></pre>
<pre><code><span class="t">Layout</span><span class="s">/TrailingWhitespace:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/layout/trailing_whitespace.cr#L11" target="_blank">View source</a>]
</div>
</div>
@ -1053,6 +1062,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/layout/trailing_whitespace.cr#L18" target="_blank">View source</a>]
</div>
</div>

194
Ameba/Rule/Lint.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -585,6 +585,174 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/bad_directive.cr#L1" target="_blank">
ameba/rule/lint/bad_directive.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/comparison_to_boolean.cr#L1" target="_blank">
ameba/rule/lint/comparison_to_boolean.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/debugger_statement.cr#L1" target="_blank">
ameba/rule/lint/debugger_statement.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/empty_ensure.cr#L1" target="_blank">
ameba/rule/lint/empty_ensure.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/empty_expression.cr#L1" target="_blank">
ameba/rule/lint/empty_expression.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/empty_loop.cr#L1" target="_blank">
ameba/rule/lint/empty_loop.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/hash_duplicated_key.cr#L1" target="_blank">
ameba/rule/lint/hash_duplicated_key.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/literal_in_condition.cr#L1" target="_blank">
ameba/rule/lint/literal_in_condition.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/literal_in_interpolation.cr#L1" target="_blank">
ameba/rule/lint/literal_in_interpolation.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/percent_array.cr#L1" target="_blank">
ameba/rule/lint/percent_array.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/rand_zero.cr#L1" target="_blank">
ameba/rule/lint/rand_zero.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/redundant_string_coercion.cr#L1" target="_blank">
ameba/rule/lint/redundant_string_coercion.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/redundant_with_index.cr#L1" target="_blank">
ameba/rule/lint/redundant_with_index.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/redundant_with_object.cr#L1" target="_blank">
ameba/rule/lint/redundant_with_object.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shadowed_argument.cr#L1" target="_blank">
ameba/rule/lint/shadowed_argument.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shadowed_exception.cr#L1" target="_blank">
ameba/rule/lint/shadowed_exception.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shadowing_local_outer_var.cr#L1" target="_blank">
ameba/rule/lint/shadowing_local_outer_var.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shared_var_in_fiber.cr#L1" target="_blank">
ameba/rule/lint/shared_var_in_fiber.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/syntax.cr#L1" target="_blank">
ameba/rule/lint/syntax.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/unneeded_disable_directive.cr#L1" target="_blank">
ameba/rule/lint/unneeded_disable_directive.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/unreachable_code.cr#L1" target="_blank">
ameba/rule/lint/unreachable_code.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/unused_argument.cr#L1" target="_blank">
ameba/rule/lint/unused_argument.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/useless_assign.cr#L1" target="_blank">
ameba/rule/lint/useless_assign.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/useless_condition_in_when.cr#L1" target="_blank">
ameba/rule/lint/useless_condition_in_when.cr
</a>
<br/>

49
Ameba/Rule/Lint/BadDirective.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::BadDirective - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::BadDirective - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -579,15 +579,15 @@
<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>
<pre><code><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>
<pre><code><span class="t">Lint</span><span class="s">/BadDirective:
Enabled: true</span></code></pre>
@ -627,6 +627,13 @@ to disable a rule that even doesn't exist:</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/bad_directive.cr#L21" target="_blank">
ameba/rule/lint/bad_directive.cr
</a>
<br/>
@ -925,20 +932,22 @@ to disable a rule that even doesn't exist:</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>
<pre><code><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>
<pre><code><span class="t">Lint</span><span class="s">/BadDirective:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/bad_directive.cr#L21" target="_blank">View source</a>]
</div>
</div>
@ -1079,6 +1088,8 @@ to disable a rule that even doesn't exist:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/bad_directive.cr#L30" target="_blank">View source</a>]
</div>
</div>

49
Ameba/Rule/Lint/ComparisonToBoolean.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::ComparisonToBoolean - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::ComparisonToBoolean - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,7 +578,7 @@
<p>For example, these are considered invalid:</p>
<pre><code class="language-crystal">foo <span class="o">==</span> <span class="n">true</span>
<pre><code>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>
@ -588,8 +588,8 @@ or negating the variable.</p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/ComparisonToBoolean:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/ComparisonToBoolean:
Enabled: true</span></code></pre>
@ -629,6 +629,13 @@ or negating the variable.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/comparison_to_boolean.cr#L23" target="_blank">
ameba/rule/lint/comparison_to_boolean.cr
</a>
<br/>
@ -916,7 +923,7 @@ or negating the variable.</p>
<p>For example, these are considered invalid:</p>
<pre><code class="language-crystal">foo <span class="o">==</span> <span class="n">true</span>
<pre><code>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>
@ -926,13 +933,15 @@ or negating the variable.</p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/ComparisonToBoolean:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/ComparisonToBoolean:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/comparison_to_boolean.cr#L23" target="_blank">View source</a>]
</div>
</div>
@ -1073,6 +1082,8 @@ or negating the variable.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/comparison_to_boolean.cr#L31" target="_blank">View source</a>]
</div>
</div>

45
Ameba/Rule/Lint/DebuggerStatement.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::DebuggerStatement - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::DebuggerStatement - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -581,8 +581,8 @@ committed into our codebase.</p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/DebuggerStatement:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/DebuggerStatement:
Enabled: true</span></code></pre>
@ -622,6 +622,13 @@ committed into our codebase.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/debugger_statement.cr#L14" target="_blank">
ameba/rule/lint/debugger_statement.cr
</a>
<br/>
@ -912,13 +919,15 @@ committed into our codebase.</p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/DebuggerStatement:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/DebuggerStatement:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/debugger_statement.cr#L14" target="_blank">View source</a>]
</div>
</div>
@ -1059,6 +1068,8 @@ committed into our codebase.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/debugger_statement.cr#L21" target="_blank">View source</a>]
</div>
</div>

53
Ameba/Rule/Lint/EmptyEnsure.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::EmptyEnsure - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::EmptyEnsure - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,7 +578,7 @@
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">some_method</span>
<pre><code><span class="k">def</span> <span class="m">some_method</span>
do_some_stuff
<span class="k">ensure</span>
<span class="k">end</span>
@ -590,7 +590,7 @@
<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>
<pre><code><span class="k">def</span> <span class="m">some_method</span>
do_some_stuff
<span class="k">ensure</span>
do_something_else
@ -604,8 +604,8 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/EmptyEnsure
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/EmptyEnsure
Enabled: true</span></code></pre>
@ -645,6 +645,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/empty_ensure.cr#L42" target="_blank">
ameba/rule/lint/empty_ensure.cr
</a>
<br/>
@ -932,7 +939,7 @@
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">some_method</span>
<pre><code><span class="k">def</span> <span class="m">some_method</span>
do_some_stuff
<span class="k">ensure</span>
<span class="k">end</span>
@ -944,7 +951,7 @@
<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>
<pre><code><span class="k">def</span> <span class="m">some_method</span>
do_some_stuff
<span class="k">ensure</span>
do_something_else
@ -958,13 +965,15 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/EmptyEnsure
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/EmptyEnsure
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/empty_ensure.cr#L42" target="_blank">View source</a>]
</div>
</div>
@ -1105,6 +1114,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/empty_ensure.cr#L49" target="_blank">View source</a>]
</div>
</div>

55
Ameba/Rule/Lint/EmptyExpression.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::EmptyExpression - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::EmptyExpression - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,7 +578,7 @@
<p>This is considered invalid:</p>
<pre><code class="language-crystal">foo <span class="o">=</span> ()
<pre><code>foo <span class="o">=</span> ()
<span class="k">if</span> ()
bar
@ -586,7 +586,7 @@
<p>And this is valid:</p>
<pre><code class="language-crystal">foo <span class="o">=</span> (some_expression)
<pre><code>foo <span class="o">=</span> (some_expression)
<span class="k">if</span> (some_expression)
bar
@ -594,8 +594,8 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/EmptyExpression:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/EmptyExpression:
Enabled: true</span></code></pre>
@ -637,6 +637,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/empty_expression.cr#L31" target="_blank">
ameba/rule/lint/empty_expression.cr
</a>
<br/>
@ -988,7 +995,7 @@
<p>This is considered invalid:</p>
<pre><code class="language-crystal">foo <span class="o">=</span> ()
<pre><code>foo <span class="o">=</span> ()
<span class="k">if</span> ()
bar
@ -996,7 +1003,7 @@
<p>And this is valid:</p>
<pre><code class="language-crystal">foo <span class="o">=</span> (some_expression)
<pre><code>foo <span class="o">=</span> (some_expression)
<span class="k">if</span> (some_expression)
bar
@ -1004,13 +1011,15 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/EmptyExpression:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/EmptyExpression:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/empty_expression.cr#L31" target="_blank">View source</a>]
</div>
</div>
@ -1151,6 +1160,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/empty_expression.cr#L42" target="_blank">View source</a>]
</div>
</div>
@ -1165,6 +1176,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/empty_expression.cr#L50" target="_blank">View source</a>]
</div>
</div>

57
Ameba/Rule/Lint/EmptyLoop.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::EmptyLoop - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::EmptyLoop - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,7 +578,7 @@
<p>This is considered invalid:</p>
<pre><code class="language-crystal"><span class="k">while</span> <span class="n">false</span>
<pre><code><span class="k">while</span> <span class="n">false</span>
<span class="k">end</span>
<span class="k">until</span> <span class="n">10</span>
@ -590,7 +590,7 @@ loop <span class="k">do</span>
<p>And this is valid:</p>
<pre><code class="language-crystal">a <span class="o">=</span> <span class="n">1</span>
<pre><code>a <span class="o">=</span> <span class="n">1</span>
<span class="k">while</span> a <span class="o">&lt;</span> <span class="n">10</span>
a += <span class="n">1</span>
<span class="k">end</span>
@ -604,8 +604,8 @@ loop <span class="k">do</span>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/EmptyLoop:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/EmptyLoop:
Enabled: true</span></code></pre>
@ -647,6 +647,13 @@ loop <span class="k">do</span>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/empty_loop.cr#L40" target="_blank">
ameba/rule/lint/empty_loop.cr
</a>
<br/>
@ -998,7 +1005,7 @@ loop <span class="k">do</span>
<p>This is considered invalid:</p>
<pre><code class="language-crystal"><span class="k">while</span> <span class="n">false</span>
<pre><code><span class="k">while</span> <span class="n">false</span>
<span class="k">end</span>
<span class="k">until</span> <span class="n">10</span>
@ -1010,7 +1017,7 @@ loop <span class="k">do</span>
<p>And this is valid:</p>
<pre><code class="language-crystal">a <span class="o">=</span> <span class="n">1</span>
<pre><code>a <span class="o">=</span> <span class="n">1</span>
<span class="k">while</span> a <span class="o">&lt;</span> <span class="n">10</span>
a += <span class="n">1</span>
<span class="k">end</span>
@ -1024,13 +1031,15 @@ loop <span class="k">do</span>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/EmptyLoop:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/EmptyLoop:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/empty_loop.cr#L40" target="_blank">View source</a>]
</div>
</div>
@ -1171,6 +1180,8 @@ loop <span class="k">do</span>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/empty_loop.cr#L49" target="_blank">View source</a>]
</div>
</div>
@ -1185,6 +1196,8 @@ loop <span class="k">do</span>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/empty_loop.cr#L55" target="_blank">View source</a>]
</div>
</div>
@ -1199,6 +1212,8 @@ loop <span class="k">do</span>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/empty_loop.cr#L59" target="_blank">View source</a>]
</div>
</div>

53
Ameba/Rule/Lint/HashDuplicatedKey.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::HashDuplicatedKey - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::HashDuplicatedKey - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,16 +578,16 @@
<p>This is considered invalid:</p>
<pre><code class="language-crystal">h <span class="o">=</span> {<span class="s">&quot;foo&quot;</span> => <span class="n">1</span>, <span class="s">&quot;bar&quot;</span> => <span class="n">2</span>, <span class="s">&quot;foo&quot;</span> => <span class="n">3</span>}</code></pre>
<pre><code>h <span class="o">=</span> {<span class="s">&quot;foo&quot;</span> => <span class="n">1</span>, <span class="s">&quot;bar&quot;</span> => <span class="n">2</span>, <span class="s">&quot;foo&quot;</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">&quot;foo&quot;</span> => <span class="n">1</span>, <span class="s">&quot;bar&quot;</span> => <span class="n">2</span>}</code></pre>
<pre><code>h <span class="o">=</span> {<span class="s">&quot;foo&quot;</span> => <span class="n">1</span>, <span class="s">&quot;bar&quot;</span> => <span class="n">2</span>}</code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/HashDuplicatedKey:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/HashDuplicatedKey:
Enabled: true</span></code></pre>
@ -627,6 +627,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/hash_duplicated_key.cr#L23" target="_blank">
ameba/rule/lint/hash_duplicated_key.cr
</a>
<br/>
@ -914,21 +921,23 @@
<p>This is considered invalid:</p>
<pre><code class="language-crystal">h <span class="o">=</span> {<span class="s">&quot;foo&quot;</span> => <span class="n">1</span>, <span class="s">&quot;bar&quot;</span> => <span class="n">2</span>, <span class="s">&quot;foo&quot;</span> => <span class="n">3</span>}</code></pre>
<pre><code>h <span class="o">=</span> {<span class="s">&quot;foo&quot;</span> => <span class="n">1</span>, <span class="s">&quot;bar&quot;</span> => <span class="n">2</span>, <span class="s">&quot;foo&quot;</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">&quot;foo&quot;</span> => <span class="n">1</span>, <span class="s">&quot;bar&quot;</span> => <span class="n">2</span>}</code></pre>
<pre><code>h <span class="o">=</span> {<span class="s">&quot;foo&quot;</span> => <span class="n">1</span>, <span class="s">&quot;bar&quot;</span> => <span class="n">2</span>}</code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/HashDuplicatedKey:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/HashDuplicatedKey:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/hash_duplicated_key.cr#L23" target="_blank">View source</a>]
</div>
</div>
@ -1069,6 +1078,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/hash_duplicated_key.cr#L30" target="_blank">View source</a>]
</div>
</div>

55
Ameba/Rule/Lint/LiteralInCondition.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::LiteralInCondition - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::LiteralInCondition - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -583,14 +583,14 @@ 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">&quot;something&quot;</span>
<pre><code><span class="k">if</span> <span class="s">&quot;something&quot;</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>
<pre><code><span class="t">Lint</span><span class="s">/LiteralInCondition:
Enabled: true</span></code></pre>
@ -632,6 +632,13 @@ replaced with either the body of the construct, or deleted entirely.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/literal_in_condition.cr#L23" target="_blank">
ameba/rule/lint/literal_in_condition.cr
</a>
<br/>
@ -993,19 +1000,21 @@ 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">&quot;something&quot;</span>
<pre><code><span class="k">if</span> <span class="s">&quot;something&quot;</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>
<pre><code><span class="t">Lint</span><span class="s">/LiteralInCondition:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/literal_in_condition.cr#L23" target="_blank">View source</a>]
</div>
</div>
@ -1034,6 +1043,8 @@ replaced with either the body of the construct, or deleted entirely.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/literal_in_condition.cr#L33" target="_blank">View source</a>]
</div>
</div>
@ -1160,6 +1171,8 @@ replaced with either the body of the construct, or deleted entirely.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/literal_in_condition.cr#L38" target="_blank">View source</a>]
</div>
</div>
@ -1174,6 +1187,8 @@ replaced with either the body of the construct, or deleted entirely.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/literal_in_condition.cr#L42" target="_blank">View source</a>]
</div>
</div>
@ -1188,6 +1203,8 @@ replaced with either the body of the construct, or deleted entirely.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/literal_in_condition.cr#L46" target="_blank">View source</a>]
</div>
</div>

49
Ameba/Rule/Lint/LiteralInInterpolation.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::LiteralInInterpolation - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::LiteralInInterpolation - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -579,13 +579,13 @@ that contain a literal value instead of a variable or function.</p>
<p>For example:</p>
<pre><code class="language-crystal"><span class="s">&quot;Hello, </span><span class="i">#{</span><span class="n">:Ary</span><span class="i">}</span><span class="s">&quot;</span>
<pre><code><span class="s">&quot;Hello, </span><span class="i">#{</span><span class="n">:Ary</span><span class="i">}</span><span class="s">&quot;</span>
<span class="s">&quot;There are </span><span class="i">#{</span><span class="n">4</span><span class="i">}</span><span class="s"> cats&quot;</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/LiteralInInterpolation
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/LiteralInInterpolation
Enabled: true</span></code></pre>
@ -627,6 +627,13 @@ that contain a literal value instead of a variable or function.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/literal_in_interpolation.cr#L19" target="_blank">
ameba/rule/lint/literal_in_interpolation.cr
</a>
<br/>
@ -969,18 +976,20 @@ that contain a literal value instead of a variable or function.</p>
<p>For example:</p>
<pre><code class="language-crystal"><span class="s">&quot;Hello, </span><span class="i">#{</span><span class="n">:Ary</span><span class="i">}</span><span class="s">&quot;</span>
<pre><code><span class="s">&quot;Hello, </span><span class="i">#{</span><span class="n">:Ary</span><span class="i">}</span><span class="s">&quot;</span>
<span class="s">&quot;There are </span><span class="i">#{</span><span class="n">4</span><span class="i">}</span><span class="s"> cats&quot;</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/LiteralInInterpolation
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/LiteralInInterpolation
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/literal_in_interpolation.cr#L19" target="_blank">View source</a>]
</div>
</div>
@ -1121,6 +1130,8 @@ that contain a literal value instead of a variable or function.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/literal_in_interpolation.cr#L28" target="_blank">View source</a>]
</div>
</div>

57
Ameba/Rule/Lint/PercentArrays.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::PercentArrays - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::PercentArrays - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,20 +578,20 @@
<p>For example, this is usually written by mistake:</p>
<pre><code class="language-crystal"><span class="s">%i(:one, :two)</span>
<pre><code><span class="s">%i(:one, :two)</span>
<span class="s">%w(&quot;one&quot;, &quot;two&quot;)</span></code></pre>
<p>And the expected example is:</p>
<pre><code class="language-crystal"><span class="s">%i(one two)</span>
<pre><code><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:
<pre><code><span class="t">Lint</span><span class="s">/PercentArrays:
Enabled: true
StringArrayUnwantedSymbols: ',"'
SymbolArrayUnwantedSymbols: ',:'</code></pre>
StringArrayUnwantedSymbols: &#39;,&quot;&#39;
SymbolArrayUnwantedSymbols: &#39;,:&#39;</span></code></pre>
@ -631,6 +631,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/percent_array.cr#L27" target="_blank">
ameba/rule/lint/percent_array.cr
</a>
<br/>
@ -938,25 +945,27 @@
<p>For example, this is usually written by mistake:</p>
<pre><code class="language-crystal"><span class="s">%i(:one, :two)</span>
<pre><code><span class="s">%i(:one, :two)</span>
<span class="s">%w(&quot;one&quot;, &quot;two&quot;)</span></code></pre>
<p>And the expected example is:</p>
<pre><code class="language-crystal"><span class="s">%i(one two)</span>
<pre><code><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:
<pre><code><span class="t">Lint</span><span class="s">/PercentArrays:
Enabled: true
StringArrayUnwantedSymbols: ',"'
SymbolArrayUnwantedSymbols: ',:'</code></pre>
StringArrayUnwantedSymbols: &#39;,&quot;&#39;
SymbolArrayUnwantedSymbols: &#39;,:&#39;</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/percent_array.cr#L27" target="_blank">View source</a>]
</div>
</div>
@ -1153,6 +1162,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/percent_array.cr#L36" target="_blank">View source</a>]
</div>
</div>

53
Ameba/Rule/Lint/RandZero.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::RandZero - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::RandZero - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -579,18 +579,18 @@ 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>
<pre><code>rand(<span class="n">1</span>)</code></pre>
<p>Should be written as:</p>
<pre><code class="language-crystal">rand
<pre><code>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>
<pre><code><span class="t">Lint</span><span class="s">/RandZero:
Enabled: true</span></code></pre>
@ -630,6 +630,13 @@ rand(<span class="n">2</span>)</code></pre>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/rand_zero.cr#L26" target="_blank">
ameba/rule/lint/rand_zero.cr
</a>
<br/>
@ -918,23 +925,25 @@ 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>
<pre><code>rand(<span class="n">1</span>)</code></pre>
<p>Should be written as:</p>
<pre><code class="language-crystal">rand
<pre><code>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>
<pre><code><span class="t">Lint</span><span class="s">/RandZero:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/rand_zero.cr#L26" target="_blank">View source</a>]
</div>
</div>
@ -1075,6 +1084,8 @@ rand(<span class="n">2</span>)</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/rand_zero.cr#L33" target="_blank">View source</a>]
</div>
</div>

53
Ameba/Rule/Lint/RedundantStringCoercion.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::RedundantStringCoercion - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::RedundantStringCoercion - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -579,16 +579,16 @@ which is redundant.</p>
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal"><span class="s">&quot;Hello, </span><span class="i">#{</span>name.to_s<span class="i">}</span><span class="s">&quot;</span></code></pre>
<pre><code><span class="s">&quot;Hello, </span><span class="i">#{</span>name.to_s<span class="i">}</span><span class="s">&quot;</span></code></pre>
<p>And this is valid:</p>
<pre><code class="language-crystal"><span class="s">&quot;Hello, </span><span class="i">#{</span>name<span class="i">}</span><span class="s">&quot;</span></code></pre>
<pre><code><span class="s">&quot;Hello, </span><span class="i">#{</span>name<span class="i">}</span><span class="s">&quot;</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/RedundantStringCoersion
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/RedundantStringCoersion
Enabled: true</span></code></pre>
@ -630,6 +630,13 @@ which is redundant.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/redundant_string_coercion.cr#L24" target="_blank">
ameba/rule/lint/redundant_string_coercion.cr
</a>
<br/>
@ -972,21 +979,23 @@ which is redundant.</p>
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal"><span class="s">&quot;Hello, </span><span class="i">#{</span>name.to_s<span class="i">}</span><span class="s">&quot;</span></code></pre>
<pre><code><span class="s">&quot;Hello, </span><span class="i">#{</span>name.to_s<span class="i">}</span><span class="s">&quot;</span></code></pre>
<p>And this is valid:</p>
<pre><code class="language-crystal"><span class="s">&quot;Hello, </span><span class="i">#{</span>name<span class="i">}</span><span class="s">&quot;</span></code></pre>
<pre><code><span class="s">&quot;Hello, </span><span class="i">#{</span>name<span class="i">}</span><span class="s">&quot;</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/RedundantStringCoersion
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/RedundantStringCoersion
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/redundant_string_coercion.cr#L24" target="_blank">View source</a>]
</div>
</div>
@ -1127,6 +1136,8 @@ which is redundant.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/redundant_string_coercion.cr#L33" target="_blank">View source</a>]
</div>
</div>

57
Ameba/Rule/Lint/RedundantWithIndex.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::RedundantWithIndex - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::RedundantWithIndex - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,24 +578,24 @@
<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>
<pre><code>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>
collection.each_with_index <span class="k">do</span> <span class="o">|</span>e, _<span class="o">|</span>
collection.each_with_index <span class="k">do</span> <span class="o">|</span>e, UNDERSCORE<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>
<pre><code>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>
<pre><code><span class="t">Lint</span><span class="s">/RedundantWithIndex:
Enabled: true</span></code></pre>
@ -635,6 +635,13 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/redundant_with_index.cr#L30" target="_blank">
ameba/rule/lint/redundant_with_index.cr
</a>
<br/>
@ -903,29 +910,31 @@ collection.each_with_index <span class="k">do</span> <span class="o">|</span>e,
<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>
<pre><code>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>
collection.each_with_index <span class="k">do</span> <span class="o">|</span>e, _<span class="o">|</span>
collection.each_with_index <span class="k">do</span> <span class="o">|</span>e, UNDERSCORE<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>
<pre><code>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>
<pre><code><span class="t">Lint</span><span class="s">/RedundantWithIndex:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/redundant_with_index.cr#L30" target="_blank">View source</a>]
</div>
</div>
@ -1066,6 +1075,8 @@ 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/bedf3a68/src/ameba/rule/lint/redundant_with_index.cr#L35" target="_blank">View source</a>]
</div>
</div>

57
Ameba/Rule/Lint/RedundantWithObject.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::RedundantWithObject - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::RedundantWithObject - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,24 +578,24 @@
<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>
<pre><code>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>
collection.each_with_object(<span class="n">0</span>) <span class="k">do</span> <span class="o">|</span>e, _<span class="o">|</span>
collection.each_with_object(<span class="n">0</span>) <span class="k">do</span> <span class="o">|</span>e, UNDERSCORE<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>
<pre><code>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>
<pre><code><span class="t">Lint</span><span class="s">/RedundantWithObject:
Enabled: true</span></code></pre>
@ -635,6 +635,13 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/redundant_with_object.cr#L31" target="_blank">
ameba/rule/lint/redundant_with_object.cr
</a>
<br/>
@ -903,29 +910,31 @@ collection.each_with_object(<span class="n">0</span>) <span class="k">do</span>
<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>
<pre><code>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>
collection.each_with_object(<span class="n">0</span>) <span class="k">do</span> <span class="o">|</span>e, _<span class="o">|</span>
collection.each_with_object(<span class="n">0</span>) <span class="k">do</span> <span class="o">|</span>e, UNDERSCORE<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>
<pre><code>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>
<pre><code><span class="t">Lint</span><span class="s">/RedundantWithObject:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/redundant_with_object.cr#L31" target="_blank">View source</a>]
</div>
</div>
@ -1066,6 +1075,8 @@ 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/bedf3a68/src/ameba/rule/lint/redundant_with_object.cr#L36" target="_blank">View source</a>]
</div>
</div>

55
Ameba/Rule/Lint/ShadowedArgument.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::ShadowedArgument - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::ShadowedArgument - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,7 +578,7 @@
<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>
<pre><code>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
<span class="k">end</span>
@ -590,7 +590,7 @@
<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>
<pre><code>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
<span class="k">end</span>
@ -602,8 +602,8 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/ShadowedArgument:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/ShadowedArgument:
Enabled: true</span></code></pre>
@ -643,6 +643,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shadowed_argument.cr#L39" target="_blank">
ameba/rule/lint/shadowed_argument.cr
</a>
<br/>
@ -935,7 +942,7 @@
<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>
<pre><code>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
<span class="k">end</span>
@ -947,7 +954,7 @@
<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>
<pre><code>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
<span class="k">end</span>
@ -959,13 +966,15 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/ShadowedArgument:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/ShadowedArgument:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shadowed_argument.cr#L39" target="_blank">View source</a>]
</div>
</div>
@ -1106,6 +1115,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shadowed_argument.cr#L50" target="_blank">View source</a>]
</div>
</div>
@ -1120,6 +1131,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shadowed_argument.cr#L46" target="_blank">View source</a>]
</div>
</div>

53
Ameba/Rule/Lint/ShadowedException.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::ShadowedException - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::ShadowedException - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -580,7 +580,7 @@ exception is rescued.</p>
<p>For example, this is invalid:</p>
<pre><code class="language-crystal"><span class="k">begin</span>
<pre><code><span class="k">begin</span>
do_something
<span class="k">rescue</span> <span class="t">Exception</span>
handle_exception
@ -590,7 +590,7 @@ exception is rescued.</p>
<p>And it has to be written as follows:</p>
<pre><code class="language-crystal"><span class="k">begin</span>
<pre><code><span class="k">begin</span>
do_something
<span class="k">rescue</span> <span class="t">ArgumentError</span>
handle_argument_error_exception
@ -600,8 +600,8 @@ exception is rescued.</p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/ShadowedException:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/ShadowedException:
Enabled: true</span></code></pre>
@ -641,6 +641,13 @@ exception is rescued.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shadowed_exception.cr#L37" target="_blank">
ameba/rule/lint/shadowed_exception.cr
</a>
<br/>
@ -930,7 +937,7 @@ exception is rescued.</p>
<p>For example, this is invalid:</p>
<pre><code class="language-crystal"><span class="k">begin</span>
<pre><code><span class="k">begin</span>
do_something
<span class="k">rescue</span> <span class="t">Exception</span>
handle_exception
@ -940,7 +947,7 @@ exception is rescued.</p>
<p>And it has to be written as follows:</p>
<pre><code class="language-crystal"><span class="k">begin</span>
<pre><code><span class="k">begin</span>
do_something
<span class="k">rescue</span> <span class="t">ArgumentError</span>
handle_argument_error_exception
@ -950,13 +957,15 @@ exception is rescued.</p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/ShadowedException:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/ShadowedException:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shadowed_exception.cr#L37" target="_blank">View source</a>]
</div>
</div>
@ -1097,6 +1106,8 @@ exception is rescued.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shadowed_exception.cr#L44" target="_blank">View source</a>]
</div>
</div>

57
Ameba/Rule/Lint/ShadowingOuterLocalVar.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::ShadowingOuterLocalVar - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::ShadowingOuterLocalVar - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -579,7 +579,7 @@ 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>
<pre><code><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>
@ -588,7 +588,7 @@ for block or proc arguments.</p>
<p>and should be written as:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">some_method</span>
<pre><code><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>
@ -597,8 +597,8 @@ for block or proc arguments.</p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/ShadowingOuterLocalVar:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/ShadowingOuterLocalVar:
Enabled: true</span></code></pre>
@ -638,6 +638,13 @@ for block or proc arguments.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shadowing_local_outer_var.cr#L34" target="_blank">
ameba/rule/lint/shadowing_local_outer_var.cr
</a>
<br/>
@ -936,7 +943,7 @@ 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>
<pre><code><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>
@ -945,7 +952,7 @@ for block or proc arguments.</p>
<p>and should be written as:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">some_method</span>
<pre><code><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>
@ -954,13 +961,15 @@ for block or proc arguments.</p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/ShadowingOuterLocalVar:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/ShadowingOuterLocalVar:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shadowing_local_outer_var.cr#L34" target="_blank">View source</a>]
</div>
</div>
@ -1101,6 +1110,8 @@ for block or proc arguments.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shadowing_local_outer_var.cr#L46" target="_blank">View source</a>]
</div>
</div>
@ -1115,6 +1126,8 @@ for block or proc arguments.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shadowing_local_outer_var.cr#L50" target="_blank">View source</a>]
</div>
</div>
@ -1129,6 +1142,8 @@ for block or proc arguments.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shadowing_local_outer_var.cr#L42" target="_blank">View source</a>]
</div>
</div>

59
Ameba/Rule/Lint/SharedVarInFiber.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::SharedVarInFiber - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::SharedVarInFiber - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -581,7 +581,7 @@ which are mutated during iterations.</p>
<p>For example, having this example:</p>
<pre><code class="language-crystal">n <span class="o">=</span> <span class="n">0</span>
<pre><code>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>
<span class="k">while</span> n <span class="o">&lt;</span> <span class="n">3</span>
@ -596,7 +596,7 @@ and when <code>channel.receive</code> is executed its value is <code>3</code>.</
<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>
<pre><code>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>
<span class="k">while</span> n <span class="o">&lt;</span> <span class="n">3</span>
@ -612,12 +612,12 @@ 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>
<a href="https://crystal-lang.org/reference/guides/concurrency.html" target="_blank">officially documented</a></p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/SharedVarInFiber:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/SharedVarInFiber:
Enabled: true</span></code></pre>
@ -657,6 +657,13 @@ the second one.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shared_var_in_fiber.cr#L53" target="_blank">
ameba/rule/lint/shared_var_in_fiber.cr
</a>
<br/>
@ -952,7 +959,7 @@ which are mutated during iterations.</p>
<p>For example, having this example:</p>
<pre><code class="language-crystal">n <span class="o">=</span> <span class="n">0</span>
<pre><code>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>
<span class="k">while</span> n <span class="o">&lt;</span> <span class="n">3</span>
@ -967,7 +974,7 @@ and when <code>channel.receive</code> is executed its value is <code>3</code>.</
<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>
<pre><code>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>
<span class="k">while</span> n <span class="o">&lt;</span> <span class="n">3</span>
@ -983,17 +990,19 @@ 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>
<a href="https://crystal-lang.org/reference/guides/concurrency.html" target="_blank">officially documented</a></p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/SharedVarInFiber:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/SharedVarInFiber:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shared_var_in_fiber.cr#L53" target="_blank">View source</a>]
</div>
</div>
@ -1134,6 +1143,8 @@ the second one.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shared_var_in_fiber.cr#L64" target="_blank">View source</a>]
</div>
</div>
@ -1148,6 +1159,8 @@ the second one.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/shared_var_in_fiber.cr#L60" target="_blank">View source</a>]
</div>
</div>

45
Ameba/Rule/Lint/Syntax.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::Syntax - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::Syntax - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,14 +578,14 @@
<p>For example, this syntax is invalid:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">hello</span>
<pre><code><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>
<pre><code><span class="k">def</span> <span class="m">hello</span>
do_something
<span class="k">rescue</span> e : <span class="t">Exception</span>
<span class="k">end</span></code></pre>
@ -628,6 +628,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/syntax.cr#L22" target="_blank">
ameba/rule/lint/syntax.cr
</a>
<br/>
@ -896,14 +903,14 @@
<p>For example, this syntax is invalid:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">hello</span>
<pre><code><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>
<pre><code><span class="k">def</span> <span class="m">hello</span>
do_something
<span class="k">rescue</span> e : <span class="t">Exception</span>
<span class="k">end</span></code></pre>
@ -912,6 +919,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/syntax.cr#L22" target="_blank">View source</a>]
</div>
</div>
@ -1052,6 +1061,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/syntax.cr#L28" target="_blank">View source</a>]
</div>
</div>

53
Ameba/Rule/Lint/UnneededDisableDirective.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::UnneededDisableDirective - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::UnneededDisableDirective - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -577,7 +577,7 @@
<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>
<pre><code><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>
@ -585,14 +585,14 @@ For example, this is considered invalid:</p>
<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>
<pre><code><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>
<pre><code><span class="t">Lint</span><span class="s">/UnneededDisableDirective
Enabled: true</span></code></pre>
@ -632,6 +632,13 @@ have any effect, the snippet should be written as the following:</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/unneeded_disable_directive.cr#L28" target="_blank">
ameba/rule/lint/unneeded_disable_directive.cr
</a>
<br/>
@ -918,7 +925,7 @@ have any effect, the snippet should be written as the following:</p>
<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>
<pre><code><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>
@ -926,19 +933,21 @@ For example, this is considered invalid:</p>
<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>
<pre><code><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>
<pre><code><span class="t">Lint</span><span class="s">/UnneededDisableDirective
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/unneeded_disable_directive.cr#L28" target="_blank">View source</a>]
</div>
</div>
@ -1079,6 +1088,8 @@ have any effect, the snippet should be written as the following:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/unneeded_disable_directive.cr#L35" target="_blank">View source</a>]
</div>
</div>

63
Ameba/Rule/Lint/UnreachableCode.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::UnreachableCode - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::UnreachableCode - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,12 +578,12 @@
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>(a)
<pre><code><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>
<pre><code>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>
@ -591,12 +591,12 @@ loop <span class="k">do</span>
<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)
<pre><code><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>
<pre><code>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">&gt;</span> <span class="n">3</span>
a += <span class="n">1</span>
@ -604,8 +604,8 @@ loop <span class="k">do</span>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/UnreachableCode:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/UnreachableCode:
Enabled: true</span></code></pre>
@ -647,6 +647,13 @@ loop <span class="k">do</span>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/unreachable_code.cr#L45" target="_blank">
ameba/rule/lint/unreachable_code.cr
</a>
<br/>
@ -993,12 +1000,12 @@ loop <span class="k">do</span>
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>(a)
<pre><code><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>
<pre><code>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>
@ -1006,12 +1013,12 @@ loop <span class="k">do</span>
<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)
<pre><code><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>
<pre><code>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">&gt;</span> <span class="n">3</span>
a += <span class="n">1</span>
@ -1019,13 +1026,15 @@ loop <span class="k">do</span>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/UnreachableCode:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/UnreachableCode:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/unreachable_code.cr#L45" target="_blank">View source</a>]
</div>
</div>
@ -1166,6 +1175,8 @@ loop <span class="k">do</span>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/unreachable_code.cr#L58" target="_blank">View source</a>]
</div>
</div>
@ -1180,6 +1191,8 @@ loop <span class="k">do</span>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/unreachable_code.cr#L54" target="_blank">View source</a>]
</div>
</div>

59
Ameba/Rule/Lint/UnusedArgument.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::UnusedArgument - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::UnusedArgument - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -577,23 +577,23 @@
<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)
<pre><code><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)
<pre><code><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:
<pre><code><span class="t">Lint</span><span class="s">/UnusedArgument:
Enabled: true
IgnoreDefs: true
IgnoreBlocks: false
IgnoreProcs: false</code></pre>
IgnoreProcs: false</span></code></pre>
@ -633,6 +633,13 @@ For example, this is considered invalid:</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/unused_argument.cr#L28" target="_blank">
ameba/rule/lint/unused_argument.cr
</a>
<br/>
@ -964,28 +971,30 @@ For example, this is considered invalid:</p>
<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)
<pre><code><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)
<pre><code><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:
<pre><code><span class="t">Lint</span><span class="s">/UnusedArgument:
Enabled: true
IgnoreDefs: true
IgnoreBlocks: false
IgnoreProcs: false</code></pre>
IgnoreProcs: false</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/unused_argument.cr#L28" target="_blank">View source</a>]
</div>
</div>
@ -1210,6 +1219,8 @@ For example, this is considered invalid:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/unused_argument.cr#L44" target="_blank">View source</a>]
</div>
</div>
@ -1224,6 +1235,8 @@ For example, this is considered invalid:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/unused_argument.cr#L48" target="_blank">View source</a>]
</div>
</div>
@ -1238,6 +1251,8 @@ For example, this is considered invalid:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/unused_argument.cr#L52" target="_blank">View source</a>]
</div>
</div>
@ -1252,6 +1267,8 @@ For example, this is considered invalid:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/unused_argument.cr#L40" target="_blank">View source</a>]
</div>
</div>

55
Ameba/Rule/Lint/UselessAssign.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::UselessAssign - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::UselessAssign - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,22 +578,22 @@
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>
<pre><code><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>
<pre><code><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>
<pre><code><span class="t">Lint</span><span class="s">/UselessAssign:
Enabled: true</span></code></pre>
@ -633,6 +633,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/useless_assign.cr#L29" target="_blank">
ameba/rule/lint/useless_assign.cr
</a>
<br/>
@ -925,27 +932,29 @@
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>
<pre><code><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>
<pre><code><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>
<pre><code><span class="t">Lint</span><span class="s">/UselessAssign:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/useless_assign.cr#L29" target="_blank">View source</a>]
</div>
</div>
@ -1086,6 +1095,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/useless_assign.cr#L40" target="_blank">View source</a>]
</div>
</div>
@ -1100,6 +1111,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/useless_assign.cr#L36" target="_blank">View source</a>]
</div>
</div>

53
Ameba/Rule/Lint/UselessConditionInWhen.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Lint::UselessConditionInWhen - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Lint::UselessConditionInWhen - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -579,7 +579,7 @@ 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>
<pre><code><span class="k">case</span>
<span class="k">when</span> utc?
io <span class="o">&lt;&lt;</span> <span class="s">&quot; UTC&quot;</span>
<span class="k">when</span> local?
@ -588,7 +588,7 @@ where it is guaranteed to always return the same result.</p>
<p>And has to be written as the following:</p>
<pre><code class="language-crystal"><span class="k">case</span>
<pre><code><span class="k">case</span>
<span class="k">when</span> utc?
io <span class="o">&lt;&lt;</span> <span class="s">&quot; UTC&quot;</span>
<span class="k">when</span> local?
@ -597,8 +597,8 @@ where it is guaranteed to always return the same result.</p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/UselessConditionInWhen:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/UselessConditionInWhen:
Enabled: true</span></code></pre>
@ -638,6 +638,13 @@ where it is guaranteed to always return the same result.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/useless_condition_in_when.cr#L34" target="_blank">
ameba/rule/lint/useless_condition_in_when.cr
</a>
<br/>
@ -926,7 +933,7 @@ 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>
<pre><code><span class="k">case</span>
<span class="k">when</span> utc?
io <span class="o">&lt;&lt;</span> <span class="s">&quot; UTC&quot;</span>
<span class="k">when</span> local?
@ -935,7 +942,7 @@ where it is guaranteed to always return the same result.</p>
<p>And has to be written as the following:</p>
<pre><code class="language-crystal"><span class="k">case</span>
<pre><code><span class="k">case</span>
<span class="k">when</span> utc?
io <span class="o">&lt;&lt;</span> <span class="s">&quot; UTC&quot;</span>
<span class="k">when</span> local?
@ -944,13 +951,15 @@ where it is guaranteed to always return the same result.</p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Lint/UselessConditionInWhen:
Enabled: true</code></pre>
<pre><code><span class="t">Lint</span><span class="s">/UselessConditionInWhen:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/useless_condition_in_when.cr#L34" target="_blank">View source</a>]
</div>
</div>
@ -1091,6 +1100,8 @@ where it is guaranteed to always return the same result.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/lint/useless_condition_in_when.cr#L54" target="_blank">View source</a>]
</div>
</div>

33
Ameba/Rule/Metrics.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Metrics - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Metrics - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -585,6 +585,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/metrics/cyclomatic_complexity.cr#L1" target="_blank">
ameba/rule/metrics/cyclomatic_complexity.cr
</a>
<br/>

45
Ameba/Rule/Metrics/CyclomaticComplexity.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Metrics::CyclomaticComplexity - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Metrics::CyclomaticComplexity - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,9 +578,9 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Metrics/CyclomaticComplexity:
<pre><code><span class="t">Metrics</span><span class="s">/CyclomaticComplexity:
Enabled: true
MaxComplexity: 10</code></pre>
MaxComplexity: 10</span></code></pre>
@ -620,6 +620,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/metrics/cyclomatic_complexity.cr#L12" target="_blank">
ameba/rule/metrics/cyclomatic_complexity.cr
</a>
<br/>
@ -917,14 +924,16 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Metrics/CyclomaticComplexity:
<pre><code><span class="t">Metrics</span><span class="s">/CyclomaticComplexity:
Enabled: true
MaxComplexity: 10</code></pre>
MaxComplexity: 10</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/metrics/cyclomatic_complexity.cr#L12" target="_blank">View source</a>]
</div>
</div>
@ -1093,6 +1102,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/metrics/cyclomatic_complexity.cr#L20" target="_blank">View source</a>]
</div>
</div>

47
Ameba/Rule/Performance.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Performance - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Performance - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -585,6 +585,27 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/performance/any_after_filter.cr#L1" target="_blank">
ameba/rule/performance/any_after_filter.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/performance/first_last_after_filter.cr#L1" target="_blank">
ameba/rule/performance/first_last_after_filter.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/performance/size_after_filter.cr#L1" target="_blank">
ameba/rule/performance/size_after_filter.cr
</a>
<br/>

53
Ameba/Rule/Performance/AnyAfterFilter.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Performance::AnyAfterFilter - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Performance::AnyAfterFilter - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,21 +578,21 @@
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal">[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].<span class="k">select</span> { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">2</span> }.any?
<pre><code>[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].<span class="k">select</span> { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">2</span> }.any?
[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].reject { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;=</span> <span class="n">2</span> }.any?</code></pre>
<p>And it should be written as this:</p>
<pre><code class="language-crystal">[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].any? { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">2</span> }
<pre><code>[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].any? { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">2</span> }
[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].any? { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&lt;</span> <span class="n">2</span> }</code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Performance/AnyAfterFilter:
<pre><code><span class="t">Performance</span><span class="s">/AnyAfterFilter:
Enabled: true
FilterNames:
- select
- reject</code></pre>
- reject</span></code></pre>
@ -632,6 +632,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/performance/any_after_filter.cr#L28" target="_blank">
ameba/rule/performance/any_after_filter.cr
</a>
<br/>
@ -934,26 +941,28 @@
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal">[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].<span class="k">select</span> { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">2</span> }.any?
<pre><code>[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].<span class="k">select</span> { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">2</span> }.any?
[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].reject { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;=</span> <span class="n">2</span> }.any?</code></pre>
<p>And it should be written as this:</p>
<pre><code class="language-crystal">[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].any? { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">2</span> }
<pre><code>[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].any? { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">2</span> }
[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].any? { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&lt;</span> <span class="n">2</span> }</code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Performance/AnyAfterFilter:
<pre><code><span class="t">Performance</span><span class="s">/AnyAfterFilter:
Enabled: true
FilterNames:
- select
- reject</code></pre>
- reject</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/performance/any_after_filter.cr#L28" target="_blank">View source</a>]
</div>
</div>
@ -1122,6 +1131,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/performance/any_after_filter.cr#L37" target="_blank">View source</a>]
</div>
</div>

55
Ameba/Rule/Performance/FirstLastAfterFilter.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Performance::FirstLastAfterFilter - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Performance::FirstLastAfterFilter - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,20 +578,20 @@
<p>For example, this is considered inefficient:</p>
<pre><code class="language-crystal">[<span class="n">-1</span>, <span class="n">0</span>, <span class="n">1</span>, <span class="n">2</span>].<span class="k">select</span> { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">0</span> }.first?
<pre><code>[<span class="n">-1</span>, <span class="n">0</span>, <span class="n">1</span>, <span class="n">2</span>].<span class="k">select</span> { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">0</span> }.first?
[<span class="n">-1</span>, <span class="n">0</span>, <span class="n">1</span>, <span class="n">2</span>].<span class="k">select</span> { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">0</span> }.last?</code></pre>
<p>And can be written as this:</p>
<pre><code class="language-crystal">[<span class="n">-1</span>, <span class="n">0</span>, <span class="n">1</span>, <span class="n">2</span>].find { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">0</span> }
<pre><code>[<span class="n">-1</span>, <span class="n">0</span>, <span class="n">1</span>, <span class="n">2</span>].find { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">0</span> }
[<span class="n">-1</span>, <span class="n">0</span>, <span class="n">1</span>, <span class="n">2</span>].reverse_each.find { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">0</span> }</code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Performance/FirstLastAfterFilter
<pre><code><span class="t">Performance</span><span class="s">/FirstLastAfterFilter
Enabled: true
FilterNames:
- select</code></pre>
- select</span></code></pre>
@ -631,6 +631,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/performance/first_last_after_filter.cr#L27" target="_blank">
ameba/rule/performance/first_last_after_filter.cr
</a>
<br/>
@ -943,25 +950,27 @@
<p>For example, this is considered inefficient:</p>
<pre><code class="language-crystal">[<span class="n">-1</span>, <span class="n">0</span>, <span class="n">1</span>, <span class="n">2</span>].<span class="k">select</span> { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">0</span> }.first?
<pre><code>[<span class="n">-1</span>, <span class="n">0</span>, <span class="n">1</span>, <span class="n">2</span>].<span class="k">select</span> { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">0</span> }.first?
[<span class="n">-1</span>, <span class="n">0</span>, <span class="n">1</span>, <span class="n">2</span>].<span class="k">select</span> { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">0</span> }.last?</code></pre>
<p>And can be written as this:</p>
<pre><code class="language-crystal">[<span class="n">-1</span>, <span class="n">0</span>, <span class="n">1</span>, <span class="n">2</span>].find { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">0</span> }
<pre><code>[<span class="n">-1</span>, <span class="n">0</span>, <span class="n">1</span>, <span class="n">2</span>].find { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">0</span> }
[<span class="n">-1</span>, <span class="n">0</span>, <span class="n">1</span>, <span class="n">2</span>].reverse_each.find { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">0</span> }</code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Performance/FirstLastAfterFilter
<pre><code><span class="t">Performance</span><span class="s">/FirstLastAfterFilter
Enabled: true
FilterNames:
- select</code></pre>
- select</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/performance/first_last_after_filter.cr#L27" target="_blank">View source</a>]
</div>
</div>
@ -1130,6 +1139,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/performance/first_last_after_filter.cr#L46" target="_blank">View source</a>]
</div>
</div>
@ -1144,6 +1155,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/performance/first_last_after_filter.cr#L37" target="_blank">View source</a>]
</div>
</div>

55
Ameba/Rule/Performance/SizeAfterFilter.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Performance::SizeAfterFilter - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Performance::SizeAfterFilter - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,7 +578,7 @@
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal">[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].<span class="k">select</span> { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">2</span> }.size
<pre><code>[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].<span class="k">select</span> { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">2</span> }.size
[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].reject { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&lt;</span> <span class="n">2</span> }.size
[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].<span class="k">select</span>(<span class="o">&amp;</span>.<span class="o">&lt;</span> <span class="n">2</span>).size
[<span class="n">0</span>, <span class="n">1</span>, <span class="n">2</span>].<span class="k">select</span>(<span class="o">&amp;</span>.zero?).size
@ -586,7 +586,7 @@
<p>And it should be written as this:</p>
<pre><code class="language-crystal">[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].count { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">2</span> }
<pre><code>[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].count { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">2</span> }
[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].count { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;=</span> <span class="n">2</span> }
[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].count(<span class="o">&amp;</span>.<span class="o">&lt;</span> <span class="n">2</span>)
[<span class="n">0</span>, <span class="n">1</span>, <span class="n">2</span>].count(<span class="o">&amp;</span>.zero?)
@ -594,11 +594,11 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Performance/SizeAfterFilter:
<pre><code><span class="t">Performance</span><span class="s">/SizeAfterFilter:
Enabled: true
FilterNames:
- select
- reject</code></pre>
- reject</span></code></pre>
@ -638,6 +638,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/performance/size_after_filter.cr#L34" target="_blank">
ameba/rule/performance/size_after_filter.cr
</a>
<br/>
@ -945,7 +952,7 @@
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal">[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].<span class="k">select</span> { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">2</span> }.size
<pre><code>[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].<span class="k">select</span> { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">2</span> }.size
[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].reject { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&lt;</span> <span class="n">2</span> }.size
[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].<span class="k">select</span>(<span class="o">&amp;</span>.<span class="o">&lt;</span> <span class="n">2</span>).size
[<span class="n">0</span>, <span class="n">1</span>, <span class="n">2</span>].<span class="k">select</span>(<span class="o">&amp;</span>.zero?).size
@ -953,7 +960,7 @@
<p>And it should be written as this:</p>
<pre><code class="language-crystal">[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].count { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">2</span> }
<pre><code>[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].count { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;</span> <span class="n">2</span> }
[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].count { <span class="o">|</span>e<span class="o">|</span> e <span class="o">&gt;=</span> <span class="n">2</span> }
[<span class="n">1</span>, <span class="n">2</span>, <span class="n">3</span>].count(<span class="o">&amp;</span>.<span class="o">&lt;</span> <span class="n">2</span>)
[<span class="n">0</span>, <span class="n">1</span>, <span class="n">2</span>].count(<span class="o">&amp;</span>.zero?)
@ -961,16 +968,18 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Performance/SizeAfterFilter:
<pre><code><span class="t">Performance</span><span class="s">/SizeAfterFilter:
Enabled: true
FilterNames:
- select
- reject</code></pre>
- reject</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/performance/size_after_filter.cr#L34" target="_blank">View source</a>]
</div>
</div>
@ -1139,6 +1148,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/performance/size_after_filter.cr#L52" target="_blank">View source</a>]
</div>
</div>
@ -1153,6 +1164,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/performance/size_after_filter.cr#L43" target="_blank">View source</a>]
</div>
</div>

117
Ameba/Rule/Style.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Style - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Style - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -585,6 +585,97 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/constant_names.cr#L1" target="_blank">
ameba/rule/style/constant_names.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/is_a_nil.cr#L1" target="_blank">
ameba/rule/style/is_a_nil.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/large_numbers.cr#L1" target="_blank">
ameba/rule/style/large_numbers.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/method_names.cr#L1" target="_blank">
ameba/rule/style/method_names.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/negated_conditions_in_unless.cr#L1" target="_blank">
ameba/rule/style/negated_conditions_in_unless.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/predicate_name.cr#L1" target="_blank">
ameba/rule/style/predicate_name.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/redundant_begin.cr#L1" target="_blank">
ameba/rule/style/redundant_begin.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/redundant_next.cr#L1" target="_blank">
ameba/rule/style/redundant_next.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/redundant_return.cr#L1" target="_blank">
ameba/rule/style/redundant_return.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/type_names.cr#L1" target="_blank">
ameba/rule/style/type_names.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/unless_else.cr#L1" target="_blank">
ameba/rule/style/unless_else.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/variable_names.cr#L1" target="_blank">
ameba/rule/style/variable_names.cr
</a>
<br/>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/while_true.cr#L1" target="_blank">
ameba/rule/style/while_true.cr
</a>
<br/>

53
Ameba/Rule/Style/ConstantNames.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Style::ConstantNames - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Style::ConstantNames - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,18 +578,18 @@
<p>For example, these constant names are considered valid:</p>
<pre><code class="language-crystal"><span class="t">LUCKY_NUMBERS</span> <span class="o">=</span> [<span class="n">3</span>, <span class="n">7</span>, <span class="n">11</span>]
<pre><code><span class="t">LUCKY_NUMBERS</span> <span class="o">=</span> [<span class="n">3</span>, <span class="n">7</span>, <span class="n">11</span>]
<span class="t">DOCUMENTATION_URL</span> <span class="o">=</span> <span class="s">&quot;http://crystal-lang.org/docs&quot;</span></code></pre>
<p>And these are invalid names:</p>
<pre><code class="language-crystal">myBadConstant <span class="o">=</span> <span class="n">1</span>
<pre><code>myBadConstant <span class="o">=</span> <span class="n">1</span>
<span class="t">Wrong_NAME</span> <span class="o">=</span> <span class="n">2</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/ConstantNames:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/ConstantNames:
Enabled: true</span></code></pre>
@ -629,6 +629,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/constant_names.cr#L25" target="_blank">
ameba/rule/style/constant_names.cr
</a>
<br/>
@ -916,23 +923,25 @@
<p>For example, these constant names are considered valid:</p>
<pre><code class="language-crystal"><span class="t">LUCKY_NUMBERS</span> <span class="o">=</span> [<span class="n">3</span>, <span class="n">7</span>, <span class="n">11</span>]
<pre><code><span class="t">LUCKY_NUMBERS</span> <span class="o">=</span> [<span class="n">3</span>, <span class="n">7</span>, <span class="n">11</span>]
<span class="t">DOCUMENTATION_URL</span> <span class="o">=</span> <span class="s">&quot;http://crystal-lang.org/docs&quot;</span></code></pre>
<p>And these are invalid names:</p>
<pre><code class="language-crystal">myBadConstant <span class="o">=</span> <span class="n">1</span>
<pre><code>myBadConstant <span class="o">=</span> <span class="n">1</span>
<span class="t">Wrong_NAME</span> <span class="o">=</span> <span class="n">2</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/ConstantNames:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/ConstantNames:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/constant_names.cr#L25" target="_blank">View source</a>]
</div>
</div>
@ -1073,6 +1082,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/constant_names.cr#L32" target="_blank">View source</a>]
</div>
</div>

53
Ameba/Rule/Style/IsANil.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Style::IsANil - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Style::IsANil - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,16 +578,16 @@
<p>This is considered bad:</p>
<pre><code class="language-crystal">var.<span class="k">is_a?</span> <span class="t">Nil</span></code></pre>
<pre><code>var.<span class="k">is_a?</span> <span class="t">Nil</span></code></pre>
<p>And needs to be written as:</p>
<pre><code class="language-crystal">var.<span class="k">nil?</span></code></pre>
<pre><code>var.<span class="k">nil?</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/IsANil:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/IsANil:
Enabled: true</span></code></pre>
@ -627,6 +627,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/is_a_nil.cr#L23" target="_blank">
ameba/rule/style/is_a_nil.cr
</a>
<br/>
@ -919,21 +926,23 @@
<p>This is considered bad:</p>
<pre><code class="language-crystal">var.<span class="k">is_a?</span> <span class="t">Nil</span></code></pre>
<pre><code>var.<span class="k">is_a?</span> <span class="t">Nil</span></code></pre>
<p>And needs to be written as:</p>
<pre><code class="language-crystal">var.<span class="k">nil?</span></code></pre>
<pre><code>var.<span class="k">nil?</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/IsANil:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/IsANil:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/is_a_nil.cr#L23" target="_blank">View source</a>]
</div>
</div>
@ -1074,6 +1083,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/is_a_nil.cr#L31" target="_blank">View source</a>]
</div>
</div>

53
Ameba/Rule/Style/LargeNumbers.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Style::LargeNumbers - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Style::LargeNumbers - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -580,21 +580,21 @@ large numbers more easily.</p>
<p>For example, these are considered invalid:</p>
<pre><code class="language-crystal"><span class="n">10000</span>
<pre><code><span class="n">10000</span>
<span class="n">141592654</span>
<span class="n">5.12345</span></code></pre>
<p>And has to be rewritten as the following:</p>
<pre><code class="language-crystal"><span class="n">10_000</span>
<pre><code><span class="n">10_000</span>
<span class="n">141_592_654</span>
<span class="n">5.123_45</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/LargeNumbers:
<pre><code><span class="t">Style</span><span class="s">/LargeNumbers:
Enabled: true
IntMinDigits: 5 # i.e. integers higher than 9999</code></pre>
IntMinDigits: 5 # i.e. integers higher than 9999</span></code></pre>
@ -634,6 +634,13 @@ large numbers more easily.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/large_numbers.cr#L30" target="_blank">
ameba/rule/style/large_numbers.cr
</a>
<br/>
@ -933,26 +940,28 @@ large numbers more easily.</p>
<p>For example, these are considered invalid:</p>
<pre><code class="language-crystal"><span class="n">10000</span>
<pre><code><span class="n">10000</span>
<span class="n">141592654</span>
<span class="n">5.12345</span></code></pre>
<p>And has to be rewritten as the following:</p>
<pre><code class="language-crystal"><span class="n">10_000</span>
<pre><code><span class="n">10_000</span>
<span class="n">141_592_654</span>
<span class="n">5.123_45</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/LargeNumbers:
<pre><code><span class="t">Style</span><span class="s">/LargeNumbers:
Enabled: true
IntMinDigits: 5 # i.e. integers higher than 9999</code></pre>
IntMinDigits: 5 # i.e. integers higher than 9999</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/large_numbers.cr#L30" target="_blank">View source</a>]
</div>
</div>
@ -1121,6 +1130,8 @@ large numbers more easily.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/large_numbers.cr#L39" target="_blank">View source</a>]
</div>
</div>

53
Ameba/Rule/Style/MethodNames.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Style::MethodNames - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Style::MethodNames - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,7 +578,7 @@
<p>For example, these are considered valid:</p>
<pre><code class="language-crystal"><span class="k">class</span> <span class="t">Person</span>
<pre><code><span class="k">class</span> <span class="t">Person</span>
<span class="k">def</span> <span class="m">first_name</span>
<span class="k">end</span>
@ -591,7 +591,7 @@
<p>And these are invalid method names:</p>
<pre><code class="language-crystal"><span class="k">class</span> <span class="t">Person</span>
<pre><code><span class="k">class</span> <span class="t">Person</span>
<span class="k">def</span> <span class="m">firstName</span>
<span class="k">end</span>
@ -604,8 +604,8 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/MethodNames:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/MethodNames:
Enabled: true</span></code></pre>
@ -645,6 +645,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/method_names.cr#L41" target="_blank">
ameba/rule/style/method_names.cr
</a>
<br/>
@ -932,7 +939,7 @@
<p>For example, these are considered valid:</p>
<pre><code class="language-crystal"><span class="k">class</span> <span class="t">Person</span>
<pre><code><span class="k">class</span> <span class="t">Person</span>
<span class="k">def</span> <span class="m">first_name</span>
<span class="k">end</span>
@ -945,7 +952,7 @@
<p>And these are invalid method names:</p>
<pre><code class="language-crystal"><span class="k">class</span> <span class="t">Person</span>
<pre><code><span class="k">class</span> <span class="t">Person</span>
<span class="k">def</span> <span class="m">firstName</span>
<span class="k">end</span>
@ -958,13 +965,15 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/MethodNames:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/MethodNames:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/method_names.cr#L41" target="_blank">View source</a>]
</div>
</div>
@ -1105,6 +1114,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/method_names.cr#L48" target="_blank">View source</a>]
</div>
</div>

53
Ameba/Rule/Style/NegatedConditionsInUnless.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Style::NegatedConditionsInUnless - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Style::NegatedConditionsInUnless - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,13 +578,13 @@
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal"><span class="k">unless</span> <span class="o">!</span>s.empty?
<pre><code><span class="k">unless</span> <span class="o">!</span>s.empty?
<span class="n">:ok</span>
<span class="k">end</span></code></pre>
<p>And should be rewritten to the following:</p>
<pre><code class="language-crystal"><span class="k">if</span> s.emtpy?
<pre><code><span class="k">if</span> s.emtpy?
<span class="n">:ok</span>
<span class="k">end</span></code></pre>
@ -593,8 +593,8 @@ that is executed if a negated condition is NOT met.</p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/NegatedConditionsInUnless:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/NegatedConditionsInUnless:
Enabled: true</span></code></pre>
@ -634,6 +634,13 @@ that is executed if a negated condition is NOT met.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/negated_conditions_in_unless.cr#L30" target="_blank">
ameba/rule/style/negated_conditions_in_unless.cr
</a>
<br/>
@ -921,13 +928,13 @@ that is executed if a negated condition is NOT met.</p>
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal"><span class="k">unless</span> <span class="o">!</span>s.empty?
<pre><code><span class="k">unless</span> <span class="o">!</span>s.empty?
<span class="n">:ok</span>
<span class="k">end</span></code></pre>
<p>And should be rewritten to the following:</p>
<pre><code class="language-crystal"><span class="k">if</span> s.emtpy?
<pre><code><span class="k">if</span> s.emtpy?
<span class="n">:ok</span>
<span class="k">end</span></code></pre>
@ -936,13 +943,15 @@ that is executed if a negated condition is NOT met.</p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/NegatedConditionsInUnless:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/NegatedConditionsInUnless:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/negated_conditions_in_unless.cr#L30" target="_blank">View source</a>]
</div>
</div>
@ -1083,6 +1092,8 @@ that is executed if a negated condition is NOT met.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/negated_conditions_in_unless.cr#L37" target="_blank">View source</a>]
</div>
</div>

53
Ameba/Rule/Style/PredicateName.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Style::PredicateName - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Style::PredicateName - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -579,7 +579,7 @@ start with the prefix <code>has_</code> or the prefix <code>is_</code>. Ignores
<p>Favour these:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">valid?</span>(x)
<pre><code><span class="k">def</span> <span class="m">valid?</span>(x)
<span class="k">end</span>
<span class="k">def</span> <span class="m">picture?</span>(x)
@ -587,7 +587,7 @@ start with the prefix <code>has_</code> or the prefix <code>is_</code>. Ignores
<p>Over these:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">is_valid?</span>(x)
<pre><code><span class="k">def</span> <span class="m">is_valid?</span>(x)
<span class="k">end</span>
<span class="k">def</span> <span class="m">has_picture?</span>(x)
@ -595,8 +595,8 @@ start with the prefix <code>has_</code> or the prefix <code>is_</code>. Ignores
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/PredicateName:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/PredicateName:
Enabled: true</span></code></pre>
@ -636,6 +636,13 @@ start with the prefix <code>has_</code> or the prefix <code>is_</code>. Ignores
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/predicate_name.cr#L32" target="_blank">
ameba/rule/style/predicate_name.cr
</a>
<br/>
@ -924,7 +931,7 @@ start with the prefix <code>has_</code> or the prefix <code>is_</code>. Ignores
<p>Favour these:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">valid?</span>(x)
<pre><code><span class="k">def</span> <span class="m">valid?</span>(x)
<span class="k">end</span>
<span class="k">def</span> <span class="m">picture?</span>(x)
@ -932,7 +939,7 @@ start with the prefix <code>has_</code> or the prefix <code>is_</code>. Ignores
<p>Over these:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">is_valid?</span>(x)
<pre><code><span class="k">def</span> <span class="m">is_valid?</span>(x)
<span class="k">end</span>
<span class="k">def</span> <span class="m">has_picture?</span>(x)
@ -940,13 +947,15 @@ start with the prefix <code>has_</code> or the prefix <code>is_</code>. Ignores
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/PredicateName:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/PredicateName:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/predicate_name.cr#L32" target="_blank">View source</a>]
</div>
</div>
@ -1087,6 +1096,8 @@ start with the prefix <code>has_</code> or the prefix <code>is_</code>. Ignores
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/predicate_name.cr#L40" target="_blank">View source</a>]
</div>
</div>

61
Ameba/Rule/Style/RedundantBegin.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Style::RedundantBegin - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Style::RedundantBegin - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -582,7 +582,7 @@
<p>For example, this:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>
<pre><code><span class="k">def</span> <span class="m">method</span>
<span class="k">begin</span>
read_content
<span class="k">rescue</span>
@ -592,7 +592,7 @@
<p>should be rewritten as:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>
<pre><code><span class="k">def</span> <span class="m">method</span>
read_content
<span class="k">rescue</span>
close_file
@ -602,7 +602,7 @@
<p>For example this is considered invalid:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>
<pre><code><span class="k">def</span> <span class="m">method</span>
<span class="k">begin</span>
a <span class="o">=</span> <span class="n">1</span>
b <span class="o">=</span> <span class="n">2</span>
@ -611,15 +611,15 @@
<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>
<pre><code><span class="k">def</span> <span class="m">method</span>
a <span class="o">=</span> <span class="n">1</span>
b <span class="o">=</span> <span class="n">2</span>
<span class="k">end</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/RedundantBegin:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/RedundantBegin:
Enabled: true</span></code></pre>
@ -661,6 +661,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/redundant_begin.cr#L59" target="_blank">
ameba/rule/style/redundant_begin.cr
</a>
<br/>
@ -1006,7 +1013,7 @@
<p>For example, this:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>
<pre><code><span class="k">def</span> <span class="m">method</span>
<span class="k">begin</span>
read_content
<span class="k">rescue</span>
@ -1016,7 +1023,7 @@
<p>should be rewritten as:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>
<pre><code><span class="k">def</span> <span class="m">method</span>
read_content
<span class="k">rescue</span>
close_file
@ -1026,7 +1033,7 @@
<p>For example this is considered invalid:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>
<pre><code><span class="k">def</span> <span class="m">method</span>
<span class="k">begin</span>
a <span class="o">=</span> <span class="n">1</span>
b <span class="o">=</span> <span class="n">2</span>
@ -1035,20 +1042,22 @@
<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>
<pre><code><span class="k">def</span> <span class="m">method</span>
a <span class="o">=</span> <span class="n">1</span>
b <span class="o">=</span> <span class="n">2</span>
<span class="k">end</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/RedundantBegin:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/RedundantBegin:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/redundant_begin.cr#L59" target="_blank">View source</a>]
</div>
</div>
@ -1189,6 +1198,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/redundant_begin.cr#L67" target="_blank">View source</a>]
</div>
</div>

79
Ameba/Rule/Style/RedundantNext.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Style::RedundantNext - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Style::RedundantNext - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -581,11 +581,11 @@ into the node which is the last in a block.</p>
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal">block <span class="k">do</span> <span class="o">|</span>v<span class="o">|</span>
<pre><code>block <span class="k">do</span> <span class="o">|</span>v<span class="o">|</span>
<span class="k">next</span> v <span class="o">+</span> <span class="n">1</span>
<span class="k">end</span></code></pre>
<pre><code class="language-crystal">block <span class="k">do</span> <span class="o">|</span>v<span class="o">|</span>
<pre><code>block <span class="k">do</span> <span class="o">|</span>v<span class="o">|</span>
<span class="k">case</span> v
<span class="k">when</span> .<span class="k">nil?</span>
<span class="k">next</span> <span class="s">&quot;nil&quot;</span>
@ -598,11 +598,11 @@ into the node which is the last in a block.</p>
<p>And has to be written as the following:</p>
<pre><code class="language-crystal">block <span class="k">do</span> <span class="o">|</span>v<span class="o">|</span>
<pre><code>block <span class="k">do</span> <span class="o">|</span>v<span class="o">|</span>
v <span class="o">+</span> <span class="n">1</span>
<span class="k">end</span></code></pre>
<pre><code class="language-crystal">block <span class="k">do</span> <span class="o">|</span>v<span class="o">|</span>
<pre><code>block <span class="k">do</span> <span class="o">|</span>v<span class="o">|</span>
<span class="k">case</span> arg
<span class="k">when</span> .<span class="k">nil?</span>
<span class="s">&quot;nil&quot;</span>
@ -624,13 +624,13 @@ into the node which is the last in a block.</p>
<p>Allows end-user to configure whether to report or not the next statements
which yield tuple literals i.e.</p>
<pre><code class="language-crystal">block <span class="k">do</span>
<pre><code>block <span class="k">do</span>
<span class="k">next</span> a, b
<span class="k">end</span></code></pre>
<p>If this param equals to <code>false</code>, the block above will be forced to be written as:</p>
<pre><code class="language-crystal">block <span class="k">do</span>
<pre><code>block <span class="k">do</span>
{a, b}
<span class="k">end</span></code></pre>
@ -639,14 +639,14 @@ which yield tuple literals i.e.</p>
<p>Allows end-user to configure whether to report or not the next statements
without arguments. Sometimes such statements are used to yild the <code>nil</code> value explicitly.</p>
<pre><code class="language-crystal">block <span class="k">do</span>
<pre><code>block <span class="k">do</span>
@foo <span class="o">=</span> <span class="n">:empty</span>
<span class="k">next</span>
<span class="k">end</span></code></pre>
<p>If this param equals to <code>false</code>, the block above will be forced to be written as:</p>
<pre><code class="language-crystal">block <span class="k">do</span>
<pre><code>block <span class="k">do</span>
@foo <span class="o">=</span> <span class="n">:empty</span>
<span class="n">nil</span>
<span class="k">end</span></code></pre>
@ -657,10 +657,10 @@ without arguments. Sometimes such statements are used to yild the <code>nil</cod
</svg>
</a>YAML config example</h3>
<pre><code class="language-crystal">Style/RedundantNext:
<pre><code><span class="t">Style</span><span class="s">/RedundantNext:
Enabled: true
AllowMultiNext: true
AllowEmptyNext: true</code></pre>
AllowEmptyNext: true</span></code></pre>
@ -700,6 +700,13 @@ without arguments. Sometimes such statements are used to yild the <code>nil</cod
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/redundant_next.cr#L99" target="_blank">
ameba/rule/style/redundant_next.cr
</a>
<br/>
@ -1015,11 +1022,11 @@ into the node which is the last in a block.</p>
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal">block <span class="k">do</span> <span class="o">|</span>v<span class="o">|</span>
<pre><code>block <span class="k">do</span> <span class="o">|</span>v<span class="o">|</span>
<span class="k">next</span> v <span class="o">+</span> <span class="n">1</span>
<span class="k">end</span></code></pre>
<pre><code class="language-crystal">block <span class="k">do</span> <span class="o">|</span>v<span class="o">|</span>
<pre><code>block <span class="k">do</span> <span class="o">|</span>v<span class="o">|</span>
<span class="k">case</span> v
<span class="k">when</span> .<span class="k">nil?</span>
<span class="k">next</span> <span class="s">&quot;nil&quot;</span>
@ -1032,11 +1039,11 @@ into the node which is the last in a block.</p>
<p>And has to be written as the following:</p>
<pre><code class="language-crystal">block <span class="k">do</span> <span class="o">|</span>v<span class="o">|</span>
<pre><code>block <span class="k">do</span> <span class="o">|</span>v<span class="o">|</span>
v <span class="o">+</span> <span class="n">1</span>
<span class="k">end</span></code></pre>
<pre><code class="language-crystal">block <span class="k">do</span> <span class="o">|</span>v<span class="o">|</span>
<pre><code>block <span class="k">do</span> <span class="o">|</span>v<span class="o">|</span>
<span class="k">case</span> arg
<span class="k">when</span> .<span class="k">nil?</span>
<span class="s">&quot;nil&quot;</span>
@ -1058,13 +1065,13 @@ into the node which is the last in a block.</p>
<p>Allows end-user to configure whether to report or not the next statements
which yield tuple literals i.e.</p>
<pre><code class="language-crystal">block <span class="k">do</span>
<pre><code>block <span class="k">do</span>
<span class="k">next</span> a, b
<span class="k">end</span></code></pre>
<p>If this param equals to <code>false</code>, the block above will be forced to be written as:</p>
<pre><code class="language-crystal">block <span class="k">do</span>
<pre><code>block <span class="k">do</span>
{a, b}
<span class="k">end</span></code></pre>
@ -1073,14 +1080,14 @@ which yield tuple literals i.e.</p>
<p>Allows end-user to configure whether to report or not the next statements
without arguments. Sometimes such statements are used to yild the <code>nil</code> value explicitly.</p>
<pre><code class="language-crystal">block <span class="k">do</span>
<pre><code>block <span class="k">do</span>
@foo <span class="o">=</span> <span class="n">:empty</span>
<span class="k">next</span>
<span class="k">end</span></code></pre>
<p>If this param equals to <code>false</code>, the block above will be forced to be written as:</p>
<pre><code class="language-crystal">block <span class="k">do</span>
<pre><code>block <span class="k">do</span>
@foo <span class="o">=</span> <span class="n">:empty</span>
<span class="n">nil</span>
<span class="k">end</span></code></pre>
@ -1091,15 +1098,17 @@ without arguments. Sometimes such statements are used to yild the <code>nil</cod
</svg>
</a>YAML config example</h3>
<pre><code class="language-crystal">Style/RedundantNext:
<pre><code><span class="t">Style</span><span class="s">/RedundantNext:
Enabled: true
AllowMultiNext: true
AllowEmptyNext: true</code></pre>
AllowEmptyNext: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/redundant_next.cr#L99" target="_blank">View source</a>]
</div>
</div>
@ -1296,6 +1305,8 @@ without arguments. Sometimes such statements are used to yild the <code>nil</cod
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/redundant_next.cr#L112" target="_blank">View source</a>]
</div>
</div>
@ -1310,6 +1321,8 @@ without arguments. Sometimes such statements are used to yild the <code>nil</cod
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/redundant_next.cr#L108" target="_blank">View source</a>]
</div>
</div>

79
Ameba/Rule/Style/RedundantReturn.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Style::RedundantReturn - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Style::RedundantReturn - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,11 +578,11 @@
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">foo</span>
<pre><code><span class="k">def</span> <span class="m">foo</span>
<span class="k">return</span> <span class="n">:bar</span>
<span class="k">end</span></code></pre>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">bar</span>(arg)
<pre><code><span class="k">def</span> <span class="m">bar</span>(arg)
<span class="k">case</span> arg
<span class="k">when</span> .<span class="k">nil?</span>
<span class="k">return</span> <span class="s">&quot;nil&quot;</span>
@ -595,11 +595,11 @@
<p>And has to be written as the following:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">foo</span>
<pre><code><span class="k">def</span> <span class="m">foo</span>
<span class="n">:bar</span>
<span class="k">end</span></code></pre>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">bar</span>(arg)
<pre><code><span class="k">def</span> <span class="m">bar</span>(arg)
<span class="k">case</span> arg
<span class="k">when</span> .<span class="k">nil?</span>
<span class="s">&quot;nil&quot;</span>
@ -621,13 +621,13 @@
<p>Allows end-user to configure whether to report or not the return statements
which return tuple literals i.e.</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>(a, b)
<pre><code><span class="k">def</span> <span class="m">method</span>(a, b)
<span class="k">return</span> a, b
<span class="k">end</span></code></pre>
<p>If this param equals to <code>false</code>, the method above has to be written as:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>(a, b)
<pre><code><span class="k">def</span> <span class="m">method</span>(a, b)
{a, b}
<span class="k">end</span></code></pre>
@ -636,14 +636,14 @@ which return tuple literals i.e.</p>
<p>Allows end-user to configure whether to report or not the return statements
without arguments. Sometimes such returns are used to return the <code>nil</code> value explicitly.</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>
<pre><code><span class="k">def</span> <span class="m">method</span>
@foo <span class="o">=</span> <span class="n">:empty</span>
<span class="k">return</span>
<span class="k">end</span></code></pre>
<p>If this param equals to <code>false</code>, the method above has to be written as:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>
<pre><code><span class="k">def</span> <span class="m">method</span>
@foo <span class="o">=</span> <span class="n">:empty</span>
<span class="n">nil</span>
<span class="k">end</span></code></pre>
@ -654,10 +654,10 @@ without arguments. Sometimes such returns are used to return the <code>nil</code
</svg>
</a>YAML config example</h3>
<pre><code class="language-crystal">Style/RedundantReturn:
<pre><code><span class="t">Style</span><span class="s">/RedundantReturn:
Enabled: true
AllowMutliReturn: true
AllowEmptyReturn: true</code></pre>
AllowEmptyReturn: true</span></code></pre>
@ -697,6 +697,13 @@ without arguments. Sometimes such returns are used to return the <code>nil</code
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/redundant_return.cr#L96" target="_blank">
ameba/rule/style/redundant_return.cr
</a>
<br/>
@ -1009,11 +1016,11 @@ without arguments. Sometimes such returns are used to return the <code>nil</code
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">foo</span>
<pre><code><span class="k">def</span> <span class="m">foo</span>
<span class="k">return</span> <span class="n">:bar</span>
<span class="k">end</span></code></pre>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">bar</span>(arg)
<pre><code><span class="k">def</span> <span class="m">bar</span>(arg)
<span class="k">case</span> arg
<span class="k">when</span> .<span class="k">nil?</span>
<span class="k">return</span> <span class="s">&quot;nil&quot;</span>
@ -1026,11 +1033,11 @@ without arguments. Sometimes such returns are used to return the <code>nil</code
<p>And has to be written as the following:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">foo</span>
<pre><code><span class="k">def</span> <span class="m">foo</span>
<span class="n">:bar</span>
<span class="k">end</span></code></pre>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">bar</span>(arg)
<pre><code><span class="k">def</span> <span class="m">bar</span>(arg)
<span class="k">case</span> arg
<span class="k">when</span> .<span class="k">nil?</span>
<span class="s">&quot;nil&quot;</span>
@ -1052,13 +1059,13 @@ without arguments. Sometimes such returns are used to return the <code>nil</code
<p>Allows end-user to configure whether to report or not the return statements
which return tuple literals i.e.</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>(a, b)
<pre><code><span class="k">def</span> <span class="m">method</span>(a, b)
<span class="k">return</span> a, b
<span class="k">end</span></code></pre>
<p>If this param equals to <code>false</code>, the method above has to be written as:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>(a, b)
<pre><code><span class="k">def</span> <span class="m">method</span>(a, b)
{a, b}
<span class="k">end</span></code></pre>
@ -1067,14 +1074,14 @@ which return tuple literals i.e.</p>
<p>Allows end-user to configure whether to report or not the return statements
without arguments. Sometimes such returns are used to return the <code>nil</code> value explicitly.</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>
<pre><code><span class="k">def</span> <span class="m">method</span>
@foo <span class="o">=</span> <span class="n">:empty</span>
<span class="k">return</span>
<span class="k">end</span></code></pre>
<p>If this param equals to <code>false</code>, the method above has to be written as:</p>
<pre><code class="language-crystal"><span class="k">def</span> <span class="m">method</span>
<pre><code><span class="k">def</span> <span class="m">method</span>
@foo <span class="o">=</span> <span class="n">:empty</span>
<span class="n">nil</span>
<span class="k">end</span></code></pre>
@ -1085,15 +1092,17 @@ without arguments. Sometimes such returns are used to return the <code>nil</code
</svg>
</a>YAML config example</h3>
<pre><code class="language-crystal">Style/RedundantReturn:
<pre><code><span class="t">Style</span><span class="s">/RedundantReturn:
Enabled: true
AllowMutliReturn: true
AllowEmptyReturn: true</code></pre>
AllowEmptyReturn: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/redundant_return.cr#L96" target="_blank">View source</a>]
</div>
</div>
@ -1290,6 +1299,8 @@ without arguments. Sometimes such returns are used to return the <code>nil</code
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/redundant_return.cr#L109" target="_blank">View source</a>]
</div>
</div>
@ -1304,6 +1315,8 @@ without arguments. Sometimes such returns are used to return the <code>nil</code
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/redundant_return.cr#L105" target="_blank">View source</a>]
</div>
</div>

61
Ameba/Rule/Style/TypeNames.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Style::TypeNames - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Style::TypeNames - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,7 +578,7 @@
<p>For example, these are considered valid:</p>
<pre><code class="language-crystal"><span class="k">class</span> <span class="t">ParseError</span> <span class="o">&lt;</span> <span class="t">Exception</span>
<pre><code><span class="k">class</span> <span class="t">ParseError</span> <span class="o">&lt;</span> <span class="t">Exception</span>
<span class="k">end</span>
<span class="k">module</span> <span class="t">HTTP</span>
@ -599,7 +599,7 @@
<p>And these are invalid type names</p>
<pre><code class="language-crystal"><span class="k">class</span> <span class="t">My_class</span>
<pre><code><span class="k">class</span> <span class="t">My_class</span>
<span class="k">end</span>
<span class="k">module</span> <span class="t">HTT_p</span>
@ -618,8 +618,8 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/TypeNames:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/TypeNames:
Enabled: true</span></code></pre>
@ -659,6 +659,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/type_names.cr#L55" target="_blank">
ameba/rule/style/type_names.cr
</a>
<br/>
@ -966,7 +973,7 @@
<p>For example, these are considered valid:</p>
<pre><code class="language-crystal"><span class="k">class</span> <span class="t">ParseError</span> <span class="o">&lt;</span> <span class="t">Exception</span>
<pre><code><span class="k">class</span> <span class="t">ParseError</span> <span class="o">&lt;</span> <span class="t">Exception</span>
<span class="k">end</span>
<span class="k">module</span> <span class="t">HTTP</span>
@ -987,7 +994,7 @@
<p>And these are invalid type names</p>
<pre><code class="language-crystal"><span class="k">class</span> <span class="t">My_class</span>
<pre><code><span class="k">class</span> <span class="t">My_class</span>
<span class="k">end</span>
<span class="k">module</span> <span class="t">HTT_p</span>
@ -1006,13 +1013,15 @@
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/TypeNames:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/TypeNames:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/type_names.cr#L55" target="_blank">View source</a>]
</div>
</div>
@ -1153,6 +1162,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/type_names.cr#L70" target="_blank">View source</a>]
</div>
</div>
@ -1167,6 +1178,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/type_names.cr#L74" target="_blank">View source</a>]
</div>
</div>
@ -1181,6 +1194,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/type_names.cr#L78" target="_blank">View source</a>]
</div>
</div>
@ -1195,6 +1210,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/type_names.cr#L82" target="_blank">View source</a>]
</div>
</div>
@ -1209,6 +1226,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/type_names.cr#L86" target="_blank">View source</a>]
</div>
</div>

57
Ameba/Rule/Style/UnlessElse.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Style::UnlessElse - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Style::UnlessElse - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,7 +578,7 @@
<p>For example, the rule considers these valid:</p>
<pre><code class="language-crystal"><span class="k">unless</span> something
<pre><code><span class="k">unless</span> something
<span class="n">:ok</span>
<span class="k">end</span>
@ -590,7 +590,7 @@
<p>But it considers this one invalid as it is an <code>unless</code> with an <code>else</code>:</p>
<pre><code class="language-crystal"><span class="k">unless</span> something
<pre><code><span class="k">unless</span> something
<span class="n">:one</span>
<span class="k">else</span>
<span class="n">:two</span>
@ -599,7 +599,7 @@
<p>The solution is to swap the order of the blocks, and change the <code>unless</code> to
an <code>if</code>, so the previous invalid example would become this:</p>
<pre><code class="language-crystal"><span class="k">if</span> something
<pre><code><span class="k">if</span> something
<span class="n">:two</span>
<span class="k">else</span>
<span class="n">:one</span>
@ -607,8 +607,8 @@ an <code>if</code>, so the previous invalid example would become this:</p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/UnlessElse:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/UnlessElse:
Enabled: true</span></code></pre>
@ -648,6 +648,13 @@ an <code>if</code>, so the previous invalid example would become this:</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/unless_else.cr#L46" target="_blank">
ameba/rule/style/unless_else.cr
</a>
<br/>
@ -935,7 +942,7 @@ an <code>if</code>, so the previous invalid example would become this:</p>
<p>For example, the rule considers these valid:</p>
<pre><code class="language-crystal"><span class="k">unless</span> something
<pre><code><span class="k">unless</span> something
<span class="n">:ok</span>
<span class="k">end</span>
@ -947,7 +954,7 @@ an <code>if</code>, so the previous invalid example would become this:</p>
<p>But it considers this one invalid as it is an <code>unless</code> with an <code>else</code>:</p>
<pre><code class="language-crystal"><span class="k">unless</span> something
<pre><code><span class="k">unless</span> something
<span class="n">:one</span>
<span class="k">else</span>
<span class="n">:two</span>
@ -956,7 +963,7 @@ an <code>if</code>, so the previous invalid example would become this:</p>
<p>The solution is to swap the order of the blocks, and change the <code>unless</code> to
an <code>if</code>, so the previous invalid example would become this:</p>
<pre><code class="language-crystal"><span class="k">if</span> something
<pre><code><span class="k">if</span> something
<span class="n">:two</span>
<span class="k">else</span>
<span class="n">:one</span>
@ -964,13 +971,15 @@ an <code>if</code>, so the previous invalid example would become this:</p>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/UnlessElse:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/UnlessElse:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/unless_else.cr#L46" target="_blank">View source</a>]
</div>
</div>
@ -1111,6 +1120,8 @@ an <code>if</code>, so the previous invalid example would become this:</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/unless_else.cr#L53" target="_blank">View source</a>]
</div>
</div>

57
Ameba/Rule/Style/VariableNames.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Style::VariableNames - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Style::VariableNames - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,19 +578,19 @@
<p>For example, these variable names are considered valid:</p>
<pre><code class="language-crystal">var_name <span class="o">=</span> <span class="n">1</span>
<pre><code>var_name <span class="o">=</span> <span class="n">1</span>
name <span class="o">=</span> <span class="n">2</span>
_another_good_name <span class="o">=</span> <span class="n">3</span></code></pre>
<p>And these are invalid variable names:</p>
<pre><code class="language-crystal">myBadNamedVar <span class="o">=</span> <span class="n">1</span>
<pre><code>myBadNamedVar <span class="o">=</span> <span class="n">1</span>
wrong_Name <span class="o">=</span> <span class="n">2</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/VariableNames:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/VariableNames:
Enabled: true</span></code></pre>
@ -630,6 +630,13 @@ wrong_Name <span class="o">=</span> <span class="n">2</span></code></pre>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/variable_names.cr#L26" target="_blank">
ameba/rule/style/variable_names.cr
</a>
<br/>
@ -927,24 +934,26 @@ wrong_Name <span class="o">=</span> <span class="n">2</span></code></pre>
<p>For example, these variable names are considered valid:</p>
<pre><code class="language-crystal">var_name <span class="o">=</span> <span class="n">1</span>
<pre><code>var_name <span class="o">=</span> <span class="n">1</span>
name <span class="o">=</span> <span class="n">2</span>
_another_good_name <span class="o">=</span> <span class="n">3</span></code></pre>
<p>And these are invalid variable names:</p>
<pre><code class="language-crystal">myBadNamedVar <span class="o">=</span> <span class="n">1</span>
<pre><code>myBadNamedVar <span class="o">=</span> <span class="n">1</span>
wrong_Name <span class="o">=</span> <span class="n">2</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/VariableNames:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/VariableNames:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/variable_names.cr#L26" target="_blank">View source</a>]
</div>
</div>
@ -1085,6 +1094,8 @@ wrong_Name <span class="o">=</span> <span class="n">2</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/variable_names.cr#L39" target="_blank">View source</a>]
</div>
</div>
@ -1099,6 +1110,8 @@ wrong_Name <span class="o">=</span> <span class="n">2</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/variable_names.cr#L43" target="_blank">View source</a>]
</div>
</div>
@ -1113,6 +1126,8 @@ wrong_Name <span class="o">=</span> <span class="n">2</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/variable_names.cr#L47" target="_blank">View source</a>]
</div>
</div>

53
Ameba/Rule/Style/WhileTrue.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Rule::Style::WhileTrue - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Rule::Style::WhileTrue - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -578,22 +578,22 @@
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal"><span class="k">while</span> <span class="n">true</span>
<pre><code><span class="k">while</span> <span class="n">true</span>
do_something
<span class="k">break</span> <span class="k">if</span> some_condition
<span class="k">end</span></code></pre>
<p>And should be replaced by the following:</p>
<pre><code class="language-crystal">loop <span class="k">do</span>
<pre><code>loop <span class="k">do</span>
do_something
<span class="k">break</span> <span class="k">if</span> some_condition
<span class="k">end</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/WhileTrue:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/WhileTrue:
Enabled: true</span></code></pre>
@ -633,6 +633,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/while_true.cr#L29" target="_blank">
ameba/rule/style/while_true.cr
</a>
<br/>
@ -920,27 +927,29 @@
<p>For example, this is considered invalid:</p>
<pre><code class="language-crystal"><span class="k">while</span> <span class="n">true</span>
<pre><code><span class="k">while</span> <span class="n">true</span>
do_something
<span class="k">break</span> <span class="k">if</span> some_condition
<span class="k">end</span></code></pre>
<p>And should be replaced by the following:</p>
<pre><code class="language-crystal">loop <span class="k">do</span>
<pre><code>loop <span class="k">do</span>
do_something
<span class="k">break</span> <span class="k">if</span> some_condition
<span class="k">end</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal">Style/WhileTrue:
Enabled: true</code></pre>
<pre><code><span class="t">Style</span><span class="s">/WhileTrue:
Enabled: true</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/while_true.cr#L29" target="_blank">View source</a>]
</div>
</div>
@ -1081,6 +1090,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/rule/style/while_true.cr#L36" target="_blank">View source</a>]
</div>
</div>

53
Ameba/Runner.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Runner - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Runner - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -579,7 +579,7 @@ Holds a list of rules to do inspection based on,
list of sources to run inspection on and a formatter
to prepare a report.</p>
<pre><code class="language-crystal">config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
<pre><code>config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
runner <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Runner</span>.<span class="k">new</span> config
runner.run.success? <span class="c"># =&gt; true or false</span></code></pre>
@ -605,6 +605,13 @@ runner.run.success? <span class="c"># =&gt; true or false</span></code></pre>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/runner.cr#L13" target="_blank">
ameba/runner.cr
</a>
<br/>
@ -723,7 +730,7 @@ runner.run.success? <span class="c"># =&gt; true or false</span></code></pre>
<p>Instantiates a runner using a <code>config</code>.</p>
<pre><code class="language-crystal">config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
<pre><code>config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
config.files <span class="o">=</span> files
config.formatter <span class="o">=</span> formatter
@ -733,6 +740,8 @@ config.formatter <span class="o">=</span> formatter
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/runner.cr#L42" target="_blank">View source</a>]
</div>
</div>
@ -765,7 +774,7 @@ config.formatter <span class="o">=</span> formatter
<p>Runner should perform inspection before doing the explain.
This is necessary to be able to find the issue at a specified location.</p>
<pre><code class="language-crystal">runner <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Runner</span>.<span class="k">new</span> config
<pre><code>runner <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Runner</span>.<span class="k">new</span> config
runner.run
runner.explain({file: file, line: l, column: c})</code></pre>
</div>
@ -773,6 +782,8 @@ runner.explain({file: file, line: l, column: c})</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/runner.cr#L118" target="_blank">View source</a>]
</div>
</div>
@ -793,13 +804,15 @@ an issue to that source.</p>
<p>This action also notifies formatter when inspection is started/finished,
and when a specific source started/finished to be inspected.</p>
<pre><code class="language-crystal">runner <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Runner</span>.<span class="k">new</span> config
<pre><code>runner <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Runner</span>.<span class="k">new</span> config
runner.run <span class="c"># =&gt; returns runner again</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/runner.cr#L69" target="_blank">View source</a>]
</div>
</div>
@ -819,6 +832,8 @@ runner.run <span class="c"># =&gt; returns runner again</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/runner.cr#L18" target="_blank">View source</a>]
</div>
</div>
@ -835,7 +850,7 @@ runner.run <span class="c"># =&gt; returns runner again</span></code></pre>
<p>Indicates whether the last inspection successful or not.
It returns true if no issues matching severity in sources found, false otherwise.</p>
<pre><code class="language-crystal">runner <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Runner</span>.<span class="k">new</span> config
<pre><code>runner <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Runner</span>.<span class="k">new</span> config
runner.run
runner.success? <span class="c"># =&gt; true or false</span></code></pre>
</div>
@ -843,6 +858,8 @@ runner.success? <span class="c"># =&gt; true or false</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/runner.cr#L131" target="_blank">View source</a>]
</div>
</div>

47
Ameba/Severity.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Severity - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Severity - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -585,6 +585,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/severity.cr#L2" target="_blank">
ameba/severity.cr
</a>
<br/>
@ -748,13 +755,15 @@
<p>Creates Severity by the name.</p>
<pre><code class="language-crystal"><span class="t">Severity</span>.parse(<span class="s">&quot;convention&quot;</span>) <span class="c"># =&gt; Severity::Convention</span>
<pre><code><span class="t">Severity</span>.parse(<span class="s">&quot;convention&quot;</span>) <span class="c"># =&gt; Severity::Convention</span>
<span class="t">Severity</span>.parse(<span class="s">&quot;foo-bar&quot;</span>) <span class="c"># =&gt; Exception: Incorrect severity name</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/severity.cr#L23" target="_blank">View source</a>]
</div>
</div>
@ -781,6 +790,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/severity.cr#L5" target="_blank">View source</a>]
</div>
</div>
@ -795,6 +806,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/severity.cr#L3" target="_blank">View source</a>]
</div>
</div>
@ -810,12 +823,14 @@
<p>Returns a symbol uniquely indicating severity.</p>
<pre><code class="language-crystal"><span class="t">Severity</span><span class="t">::</span><span class="t">Warning</span>.symbol <span class="c"># =&gt; &#39;W&#39;</span></code></pre>
<pre><code><span class="t">Severity</span><span class="t">::</span><span class="t">Warning</span>.symbol <span class="c"># =&gt; &#39;W&#39;</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/severity.cr#L12" target="_blank">View source</a>]
</div>
</div>
@ -830,6 +845,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/severity.cr#L4" target="_blank">View source</a>]
</div>
</div>

37
Ameba/SeverityYamlConverter.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::SeverityYamlConverter - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::SeverityYamlConverter - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -598,6 +598,13 @@
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/severity.cr#L31" target="_blank">
ameba/severity.cr
</a>
<br/>
@ -680,6 +687,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/severity.cr#L32" target="_blank">View source</a>]
</div>
</div>
@ -694,6 +703,8 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/severity.cr#L45" target="_blank">View source</a>]
</div>
</div>

53
Ameba/Source.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Source - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Source - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -615,6 +615,13 @@ Has path, lines of code and issues reported by rules.</p>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/source.cr#L4" target="_blank">
ameba/source.cr
</a>
<br/>
@ -805,13 +812,15 @@ Has path, lines of code and issues reported by rules.</p>
<p>For example:</p>
<pre><code class="language-crystal">path <span class="o">=</span> <span class="s">&quot;./src/source.cr&quot;</span>
<pre><code>path <span class="o">=</span> <span class="s">&quot;./src/source.cr&quot;</span>
<span class="t">Ameba</span><span class="t">::</span><span class="t">Source</span>.<span class="k">new</span> <span class="t">File</span>.read(path), path</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/source.cr#L27" target="_blank">View source</a>]
</div>
</div>
@ -841,13 +850,15 @@ Has path, lines of code and issues reported by rules.</p>
<p>Returns AST nodes constructed by <code>Crystal::Parser</code>.</p>
<pre><code class="language-crystal">source <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Source</span>.<span class="k">new</span> code, path
<pre><code>source <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Source</span>.<span class="k">new</span> code, path
source.ast</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/source.cr#L52" target="_blank">View source</a>]
</div>
</div>
@ -867,6 +878,8 @@ source.ast</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/source.cr#L12" target="_blank">View source</a>]
</div>
</div>
@ -881,6 +894,8 @@ source.ast</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/source.cr#L60" target="_blank">View source</a>]
</div>
</div>
@ -900,13 +915,15 @@ method caches lines in an instance variable, so calling
it second time will not perform a split, but will return
lines instantly.</p>
<pre><code class="language-crystal">source <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Source</span>.<span class="k">new</span> <span class="s">&quot;a = 1\nb = 2&quot;</span>, path
<pre><code>source <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Source</span>.<span class="k">new</span> <span class="s">&quot;a = 1\nb = 2&quot;</span>, path
source.lines <span class="c"># =&gt; [&quot;a = 1&quot;, &quot;b = 2&quot;]</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/source.cr#L41" target="_blank">View source</a>]
</div>
</div>
@ -926,6 +943,8 @@ source.lines <span class="c"># =&gt; [&quot;a = 1&quot;, &quot;b = 2&quot;]</spa
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/source.cr#L65" target="_blank">View source</a>]
</div>
</div>
@ -945,6 +964,8 @@ source.lines <span class="c"># =&gt; [&quot;a = 1&quot;, &quot;b = 2&quot;]</spa
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/source.cr#L9" target="_blank">View source</a>]
</div>
</div>

47
Ameba/Tokenizer.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::Tokenizer - ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>Ameba::Tokenizer - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -576,7 +576,7 @@
<p>Represents Crystal syntax tokenizer based on <code>Crystal::Lexer</code>.</p>
<pre><code class="language-crystal">source <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Source</span>.<span class="k">new</span> code, path
<pre><code>source <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Source</span>.<span class="k">new</span> code, path
tokenizer <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Tokenizer</span>.<span class="k">new</span>(source)
tokenizer.run <span class="k">do</span> <span class="o">|</span>token<span class="o">|</span>
puts token
@ -604,6 +604,13 @@ tokenizer.run <span class="k">do</span> <span class="o">|</span>token<span class
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/tokenizer.cr#L14" target="_blank">
ameba/tokenizer.cr
</a>
<br/>
@ -708,13 +715,15 @@ tokenizer.run <span class="k">do</span> <span class="o">|</span>token<span class
<p>Instantiates Tokenizer using a <code>lexer</code>.</p>
<pre><code class="language-crystal">lexer <span class="o">=</span> <span class="t">Crystal</span><span class="t">::</span><span class="t">Lexer</span>.<span class="k">new</span>(code)
<pre><code>lexer <span class="o">=</span> <span class="t">Crystal</span><span class="t">::</span><span class="t">Lexer</span>.<span class="k">new</span>(code)
<span class="t">Ameba</span><span class="t">::</span><span class="t">Tokenizer</span>.<span class="k">new</span>(lexer)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/tokenizer.cr#L37" target="_blank">View source</a>]
</div>
</div>
@ -730,13 +739,15 @@ tokenizer.run <span class="k">do</span> <span class="o">|</span>token<span class
<p>Instantiates Tokenizer using a <code>source</code>.</p>
<pre><code class="language-crystal">source <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Source</span>.<span class="k">new</span> code, path
<pre><code>source <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Source</span>.<span class="k">new</span> code, path
<span class="t">Ameba</span><span class="t">::</span><span class="t">Tokenizer</span>.<span class="k">new</span>(source)</code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/tokenizer.cr#L22" target="_blank">View source</a>]
</div>
</div>
@ -766,7 +777,7 @@ tokenizer.run <span class="k">do</span> <span class="o">|</span>token<span class
<p>Runs the tokenizer and yields each token as a block argument.</p>
<pre><code class="language-crystal"><span class="t">Ameba</span><span class="t">::</span><span class="t">Tokenizer</span>.<span class="k">new</span>(source).run <span class="k">do</span> <span class="o">|</span>token<span class="o">|</span>
<pre><code><span class="t">Ameba</span><span class="t">::</span><span class="t">Tokenizer</span>.<span class="k">new</span>(source).run <span class="k">do</span> <span class="o">|</span>token<span class="o">|</span>
puts token
<span class="k">end</span></code></pre>
</div>
@ -774,6 +785,8 @@ tokenizer.run <span class="k">do</span> <span class="o">|</span>token<span class
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/bedf3a68/src/ameba/tokenizer.cr#L48" target="_blank">View source</a>]
</div>
</div>

56
index.html
View file

@ -3,28 +3,28 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.35.1">
<meta name="crystal_docs.project_version" content="0.13.3-dev">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>ameba 0.13.3-dev</title>
<script type="text/javascript">
CrystalDocs.base_path = "";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<meta id="repository-name" content="ameba">
<title>ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "";
</script>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -39,12 +39,12 @@
</h1>
<span class="project-version">
0.13.3-dev
master
</span>
</div>
</div>
<div class="search-results hidden">
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
@ -553,19 +553,19 @@
<div class="main-content">
<ul><li><a href="#about">About</a></li><li><a href="#usage">Usage</a></li></ul>
<ul><li><a href="#about" target="_blank">About</a></li><li><a href="#usage" target="_blank">Usage</a></li></ul>
<ul><li><a href="#run-in-parallel">Run in parallel</a></li></ul></ul>
<ul><li><a href="#run-in-parallel" target="_blank">Run in parallel</a></li></ul></ul>
<ul><li><a href="#installation">Installation</a></li></ul>
<ul><li><a href="#installation" target="_blank">Installation</a></li></ul>
<ul><li><a href="#as-a-project-dependency">As a project dependency:</a></li><li><a href="#os-x">OS X</a></li><li><a href="#docker">Docker</a></li><li><a href="#from-sources">From sources</a></li></ul></ul>
<ul><li><a href="#as-a-project-dependency" target="_blank">As a project dependency:</a></li><li><a href="#os-x" target="_blank">OS X</a></li><li><a href="#docker" target="_blank">Docker</a></li><li><a href="#from-sources" target="_blank">From sources</a></li></ul></ul>
<ul><li><a href="#configuration">Configuration</a></li></ul>
<ul><li><a href="#configuration" target="_blank">Configuration</a></li></ul>
<ul><li><a href="#sources">Sources</a></li><li><a href="#rules">Rules</a></li><li><a href="#explain-issues">Explain issues</a></li><li><a href="#inline-disabling">Inline disabling</a></li></ul></ul>
<ul><li><a href="#sources" target="_blank">Sources</a></li><li><a href="#rules" target="_blank">Rules</a></li><li><a href="#explain-issues" target="_blank">Explain issues</a></li><li><a href="#inline-disabling" target="_blank">Inline disabling</a></li></ul></ul>
<ul><li><a href="#editors--integrations">Editors & integrations</a></li><li><a href="#credits--inspirations">Credits & inspirations</a></li><li><a href="#contributors">Contributors</a></li></ul>
<ul><li><a href="#editors--integrations" target="_blank">Editors & integrations</a></li><li><a href="#credits--inspirations" target="_blank">Credits & inspirations</a></li><li><a href="#contributors" target="_blank">Contributors</a></li></ul>
<h2><a id="about" class="anchor" href="#about">
<svg class="octicon-link" aria-hidden="true">
@ -574,10 +574,10 @@
</a>About</h2>
<p>Ameba is a static code analysis tool for the Crystal language.
It enforces a consistent <a href="https://crystal-lang.org/docs/conventions/coding_style.html">Crystal code style</a>,
It enforces a consistent <a href="https://crystal-lang.org/docs/conventions/coding_style.html" target="_blank">Crystal code style</a>,
also catches code smells and wrong code constructions.</p>
<p>See also <a href="https://github.com/crystal-ameba/ameba/wiki">Roadmap</a>.</p>
<p>See also <a href="https://github.com/crystal-ameba/ameba/wiki" target="_blank">Roadmap</a>.</p>
<h2><a id="usage" class="anchor" href="#usage">
<svg class="octicon-link" aria-hidden="true">
@ -613,7 +613,7 @@ Finished in 542.64 milliseconds
</svg>
</a>Run in parallel</h3>
<p>Starting from 0.31.0 Crystal <a href="https://crystal-lang.org/2019/09/06/parallelism-in-crystal.html">supports parallelism</a>.
<p>Starting from 0.31.0 Crystal <a href="https://crystal-lang.org/2019/09/06/parallelism-in-crystal.html" target="_blank">supports parallelism</a>.
It allows to run linting in parallel too.
In order to take advantage of this feature you need to build ameba with preview_mt support:</p>
@ -648,7 +648,7 @@ $ CRYSTAL_WORKERS=8 ameba #=> 10.14 seconds</code></pre>
<p>Build <code>bin/ameba</code> binary within your project directory while running <code>shards install</code>.</p>
<p>You may also want to use it on <a href="travis-ci.org">Travis</a>:</p>
<p>You may also want to use it on <a href="travis-ci.org" target="_blank">Travis</a>:</p>
<pre><code class="language-yaml"># .travis.yml
language: crystal
@ -724,7 +724,7 @@ It allows to configure rule properties, disable specific rules and exclude sourc
<pre><code class="language-yaml">Globs:
- **/*.cr
- !lib
Excluded:
- src/compiler</code></pre>
@ -790,7 +790,7 @@ time <span class="o">=</span> <span class="t">Time</span>.epoch(<span class="n">
</svg>
</a>Editors & integrations</h2>
<ul><li>Vim: <a href="https://github.com/rhysd/vim-crystal">vim-crystal</a>, <a href="https://github.com/w0rp/ale">Ale</a></li><li>Emacs: <a href="https://github.com/crystal-ameba/ameba.el">ameba.el</a></li><li>Sublime Text: <a href="https://github.com/epergo/SublimeLinter-contrib-ameba">Sublime Linter Ameba</a></li><li>VSCode: <a href="https://github.com/crystal-ameba/vscode-crystal-ameba">vscode-crystal-ameba</a></li><li>Codacy: <a href="https://github.com/codacy/codacy-ameba">codacy-ameba</a></li><li>GitHub Actions: <a href="https://github.com/crystal-ameba/github-action">github-action</a></li></ul>
<ul><li>Vim: <a href="https://github.com/rhysd/vim-crystal" target="_blank">vim-crystal</a>, <a href="https://github.com/w0rp/ale" target="_blank">Ale</a></li><li>Emacs: <a href="https://github.com/crystal-ameba/ameba.el" target="_blank">ameba.el</a></li><li>Sublime Text: <a href="https://github.com/epergo/SublimeLinter-contrib-ameba" target="_blank">Sublime Linter Ameba</a></li><li>VSCode: <a href="https://github.com/crystal-ameba/vscode-crystal-ameba" target="_blank">vscode-crystal-ameba</a></li><li>Codacy: <a href="https://github.com/codacy/codacy-ameba" target="_blank">codacy-ameba</a></li><li>GitHub Actions: <a href="https://github.com/crystal-ameba/github-action" target="_blank">github-action</a></li></ul>
<h2><a id="credits-inspirations" class="anchor" href="#credits-inspirations">
<svg class="octicon-link" aria-hidden="true">
@ -798,7 +798,7 @@ time <span class="o">=</span> <span class="t">Time</span>.epoch(<span class="n">
</svg>
</a>Credits & inspirations</h2>
<ul><li><a href="https://crystal-lang.org">Crystal Language</a></li><li><a href="https://rubocop.readthedocs.io/en/latest/">Rubocop</a></li><li><a href="http://credo-ci.org/">Credo</a></li><li><a href="https://github.com/lpil/dogma">Dogma</a></li></ul>
<ul><li><a href="https://crystal-lang.org" target="_blank">Crystal Language</a></li><li><a href="https://rubocop.readthedocs.io/en/latest/" target="_blank">Rubocop</a></li><li><a href="http://credo-ci.org/" target="_blank">Credo</a></li><li><a href="https://github.com/lpil/dogma" target="_blank">Dogma</a></li></ul>
<h2><a id="contributors" class="anchor" href="#contributors">
<svg class="octicon-link" aria-hidden="true">
@ -806,7 +806,7 @@ time <span class="o">=</span> <span class="t">Time</span>.epoch(<span class="n">
</svg>
</a>Contributors</h2>
<ul><li><a href="https://github.com/veelenga">veelenga</a> Vitalii Elenhaupt - creator, maintainer</li></ul>
<ul><li><a href="https://github.com/veelenga" target="_blank">veelenga</a> Vitalii Elenhaupt - creator, maintainer</li></ul>
</div>
</body>
</html>

2
index.json
View file

File diff suppressed because one or more lines are too long

2
js/doc.js
View file

@ -908,7 +908,7 @@ document.addEventListener('DOMContentLoaded', function() {
};
}
var repositoryName = document.querySelector('[name=repository-name]').getAttribute('content');
var repositoryName = document.querySelector('#repository-name').getAttribute('content');
var typesList = document.querySelector('.types-list');
var searchInput = document.querySelector('.search-input');
var parents = document.querySelectorAll('.types-list li.parent');

2
search-index.js
View file

File diff suppressed because one or more lines are too long