Deploying to gh-pages from @ crystal-ameba/ameba@3b87aa6490 🚀

This commit is contained in:
Sija 2023-11-14 09:25:36 +00:00
parent a72c690d5d
commit 78ed02da45
146 changed files with 939 additions and 848 deletions

View file

@ -964,7 +964,7 @@
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/accessor_method_name.cr#L38" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/accessor_method_name.cr#L38" target="_blank">
ameba/rule/naming/accessor_method_name.cr
</a>
@ -1287,7 +1287,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/accessor_method_name.cr#L38" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/accessor_method_name.cr#L38" target="_blank">View source</a>]
</div>
</div>
@ -1468,7 +1468,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/accessor_method_name.cr#L45" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/accessor_method_name.cr#L45" target="_blank">View source</a>]
</div>
</div>
@ -1484,7 +1484,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/accessor_method_name.cr#L61" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/accessor_method_name.cr#L61" target="_blank">View source</a>]
</div>
</div>

View file

@ -909,7 +909,8 @@
<span class="k">end</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal"><span class="t">Naming</span><span class="o">/</span><span class="t">AsciiIdentifiers</span>:
<span class="t">Enabled</span>: <span class="n">true</span></code></pre>
<span class="t">Enabled</span>: <span class="n">true</span>
<span class="t">IgnoreSymbols</span>: <span class="n">false</span></code></pre>
@ -950,7 +951,7 @@
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/ascii_identifiers.cr#L24" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/ascii_identifiers.cr#L25" target="_blank">
ameba/rule/naming/ascii_identifiers.cr
</a>
@ -1067,6 +1068,16 @@
</li>
<li class="entry-summary">
<a href="#ignore_symbols%3D%28ignore_symbols%3ABool%29-instance-method" class="signature"><strong>#ignore_symbols=</strong>(ignore_symbols : Bool)</a>
</li>
<li class="entry-summary">
<a href="#ignore_symbols%3F%3ABool-instance-method" class="signature"><strong>#ignore_symbols?</strong> : Bool</a>
</li>
<li class="entry-summary">
<a href="#severity%3AAmeba%3A%3ASeverity-instance-method" class="signature"><strong>#severity</strong> : Ameba::Severity</a>
@ -1087,6 +1098,11 @@
</li>
<li class="entry-summary">
<a href="#test%28source%2Cnode%3ACrystal%3A%3ACall%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Call)</a>
</li>
<li class="entry-summary">
<a href="#test%28source%2Cnode%3ACrystal%3A%3ADef%29-instance-method" class="signature"><strong>#test</strong>(source, node : Crystal::Def)</a>
@ -1268,13 +1284,14 @@
<span class="k">end</span></code></pre>
<p>YAML configuration example:</p>
<pre><code class="language-crystal"><span class="t">Naming</span><span class="o">/</span><span class="t">AsciiIdentifiers</span>:
<span class="t">Enabled</span>: <span class="n">true</span></code></pre>
<span class="t">Enabled</span>: <span class="n">true</span>
<span class="t">IgnoreSymbols</span>: <span class="n">false</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/ascii_identifiers.cr#L24" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/ascii_identifiers.cr#L25" target="_blank">View source</a>]
</div>
</div>
@ -1416,6 +1433,34 @@
</div>
</div>
<div class="entry-detail" id="ignore_symbols=(ignore_symbols:Bool)-instance-method">
<div class="signature">
def <strong>ignore_symbols=</strong>(ignore_symbols : Bool)
<a class="method-permalink" href="#ignore_symbols%3D%28ignore_symbols%3ABool%29-instance-method">#</a>
</div>
<br/>
<div>
</div>
</div>
<div class="entry-detail" id="ignore_symbols?:Bool-instance-method">
<div class="signature">
def <strong>ignore_symbols?</strong> : Bool
<a class="method-permalink" href="#ignore_symbols%3F%3ABool-instance-method">#</a>
</div>
<br/>
<div>
</div>
</div>
<div class="entry-detail" id="severity:Ameba::Severity-instance-method">
<div class="signature">
@ -1455,7 +1500,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/ascii_identifiers.cr#L31" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/ascii_identifiers.cr#L33" target="_blank">View source</a>]
</div>
</div>
@ -1471,7 +1516,23 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/ascii_identifiers.cr#L37" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/ascii_identifiers.cr#L40" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="test(source,node:Crystal::Call)-instance-method">
<div class="signature">
def <strong>test</strong>(source, node : Crystal::Call)
<a class="method-permalink" href="#test%28source%2Cnode%3ACrystal%3A%3ACall%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/ascii_identifiers.cr#L46" target="_blank">View source</a>]
</div>
</div>
@ -1487,7 +1548,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/ascii_identifiers.cr#L43" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/ascii_identifiers.cr#L55" target="_blank">View source</a>]
</div>
</div>
@ -1503,7 +1564,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/ascii_identifiers.cr#L51" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/ascii_identifiers.cr#L64" target="_blank">View source</a>]
</div>
</div>
@ -1519,7 +1580,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/ascii_identifiers.cr#L55" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/ascii_identifiers.cr#L68" target="_blank">View source</a>]
</div>
</div>

View file

@ -956,7 +956,7 @@ their sole parameter named <code>other</code>.</p>
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/binary_operator_parameter_name.cr#L30" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/binary_operator_parameter_name.cr#L30" target="_blank">
ameba/rule/naming/binary_operator_parameter_name.cr
</a>
@ -1276,7 +1276,7 @@ their sole parameter named <code>other</code>.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/binary_operator_parameter_name.cr#L30" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/binary_operator_parameter_name.cr#L30" target="_blank">View source</a>]
</div>
</div>
@ -1485,7 +1485,7 @@ their sole parameter named <code>other</code>.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/binary_operator_parameter_name.cr#L39" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/binary_operator_parameter_name.cr#L39" target="_blank">View source</a>]
</div>
</div>

View file

@ -952,7 +952,7 @@
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/block_parameter_name.cr#L26" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/block_parameter_name.cr#L26" target="_blank">
ameba/rule/naming/block_parameter_name.cr
</a>
@ -1298,7 +1298,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/block_parameter_name.cr#L26" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/block_parameter_name.cr#L26" target="_blank">View source</a>]
</div>
</div>
@ -1591,7 +1591,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/block_parameter_name.cr#L37" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/block_parameter_name.cr#L37" target="_blank">View source</a>]
</div>
</div>

View file

@ -950,7 +950,7 @@
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/constant_names.cr#L24" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/constant_names.cr#L24" target="_blank">
ameba/rule/naming/constant_names.cr
</a>
@ -1254,7 +1254,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/constant_names.cr#L24" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/constant_names.cr#L24" target="_blank">View source</a>]
</div>
</div>
@ -1435,7 +1435,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/constant_names.cr#L31" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/constant_names.cr#L31" target="_blank">View source</a>]
</div>
</div>

View file

@ -944,7 +944,7 @@
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/filename.cr#L10" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/filename.cr#L10" target="_blank">
ameba/rule/naming/filename.cr
</a>
@ -1244,7 +1244,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/filename.cr#L10" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/filename.cr#L10" target="_blank">View source</a>]
</div>
</div>
@ -1437,7 +1437,7 @@ that are tested by this rule, it should add an issue.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/filename.cr#L19" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/filename.cr#L19" target="_blank">View source</a>]
</div>
</div>

View file

@ -966,7 +966,7 @@
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/method_names.cr#L40" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/method_names.cr#L40" target="_blank">
ameba/rule/naming/method_names.cr
</a>
@ -1286,7 +1286,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/method_names.cr#L40" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/method_names.cr#L40" target="_blank">View source</a>]
</div>
</div>
@ -1467,7 +1467,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/method_names.cr#L47" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/method_names.cr#L47" target="_blank">View source</a>]
</div>
</div>

View file

@ -952,7 +952,7 @@ the ones that are not valid Crystal code (e.g. <code>is_404?</code>).</p>
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/predicate_name.cr#L26" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/predicate_name.cr#L26" target="_blank">
ameba/rule/naming/predicate_name.cr
</a>
@ -1258,7 +1258,7 @@ the ones that are not valid Crystal code (e.g. <code>is_404?</code>).</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/predicate_name.cr#L26" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/predicate_name.cr#L26" target="_blank">View source</a>]
</div>
</div>
@ -1439,7 +1439,7 @@ the ones that are not valid Crystal code (e.g. <code>is_404?</code>).</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/predicate_name.cr#L33" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/predicate_name.cr#L33" target="_blank">View source</a>]
</div>
</div>

View file

@ -957,7 +957,7 @@ using <code>Object#(class_)property</code> or <code>Object#(class_)getter</code>
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/query_bool_methods.cr#L29" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/query_bool_methods.cr#L29" target="_blank">
ameba/rule/naming/query_bool_methods.cr
</a>
@ -1365,7 +1365,7 @@ using <code>Object#(class_)property</code> or <code>Object#(class_)getter</code>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/query_bool_methods.cr#L29" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/query_bool_methods.cr#L29" target="_blank">View source</a>]
</div>
</div>
@ -1546,7 +1546,7 @@ using <code>Object#(class_)property</code> or <code>Object#(class_)getter</code>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/query_bool_methods.cr#L40" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/query_bool_methods.cr#L40" target="_blank">View source</a>]
</div>
</div>

View file

@ -957,7 +957,7 @@
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/rescued_exceptions_variable_name.cr#L27" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/rescued_exceptions_variable_name.cr#L27" target="_blank">
ameba/rule/naming/rescued_exceptions_variable_name.cr
</a>
@ -1283,7 +1283,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/rescued_exceptions_variable_name.cr#L27" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/rescued_exceptions_variable_name.cr#L27" target="_blank">View source</a>]
</div>
</div>
@ -1492,7 +1492,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/rescued_exceptions_variable_name.cr#L36" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/rescued_exceptions_variable_name.cr#L36" target="_blank">View source</a>]
</div>
</div>

View file

@ -980,7 +980,7 @@
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/type_names.cr#L54" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/type_names.cr#L54" target="_blank">
ameba/rule/naming/type_names.cr
</a>
@ -1314,7 +1314,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/type_names.cr#L54" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/type_names.cr#L54" target="_blank">View source</a>]
</div>
</div>
@ -1495,7 +1495,7 @@
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/type_names.cr#L61" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/type_names.cr#L61" target="_blank">View source</a>]
</div>
</div>

View file

@ -951,7 +951,7 @@ wrong_Name <span class="o">=</span> <span class="n">2</span></code></pre>
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/variable_names.cr#L25" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/variable_names.cr#L25" target="_blank">
ameba/rule/naming/variable_names.cr
</a>
@ -1263,7 +1263,7 @@ wrong_Name <span class="o">=</span> <span class="n">2</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/variable_names.cr#L25" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/variable_names.cr#L25" target="_blank">View source</a>]
</div>
</div>
@ -1444,7 +1444,7 @@ wrong_Name <span class="o">=</span> <span class="n">2</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/variable_names.cr#L36" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/variable_names.cr#L36" target="_blank">View source</a>]
</div>
</div>
@ -1472,7 +1472,7 @@ that are tested by this rule, it should add an issue.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/0b225da/src/ameba/rule/naming/variable_names.cr#L32" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/3b87aa6/src/ameba/rule/naming/variable_names.cr#L32" target="_blank">View source</a>]
</div>
</div>