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

Deploying to gh-pages from @ 48b15b9bf8 🚀

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

53
Ameba/Formatter/BaseFormatter.html
View file

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.36.1">
<meta name="generator" content="Crystal Docs 1.1.1">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
@ -286,6 +286,11 @@
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
<a href="../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
<a href="../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
@ -639,7 +644,7 @@
Overview
</h2>
<p>A base formatter for all formatters. It uses <code><a href="../../Ameba/Formatter/BaseFormatter.html#output:IO::FileDescriptor%7CIO::Memory-instance-method">#output</a></code> IO
<p>A base formatter for all formatters. It uses <code><a href="../../Ameba/Formatter/BaseFormatter.html#output%3AIO%3A%3AFileDescriptor%7CIO%3A%3AMemory-instance-method">#output</a></code> IO
to report results and also implements stub methods for
callbacks in <code><a href="../../Ameba/Runner.html#run-instance-method">Ameba::Runner#run</a></code> method.</p>
@ -686,7 +691,7 @@ callbacks in <code><a href="../../Ameba/Runner.html#run-instance-method">Ameba::
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/base_formatter.cr#L8" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/base_formatter.cr#L8" target="_blank">
ameba/formatter/base_formatter.cr
</a>
@ -708,7 +713,7 @@ callbacks in <code><a href="../../Ameba/Runner.html#run-instance-method">Ameba::
<ul class="list-summary">
<li class="entry-summary">
<a href="#new(output=STDOUT)-class-method" class="signature"><strong>.new</strong>(output = <span class="t">STDOUT</span>)</a>
<a href="#new%28output%3DSTDOUT%29-class-method" class="signature"><strong>.new</strong>(output = <span class="t">STDOUT</span>)</a>
</li>
@ -729,40 +734,40 @@ callbacks in <code><a href="../../Ameba/Runner.html#run-instance-method">Ameba::
<ul class="list-summary">
<li class="entry-summary">
<a href="#config:Hash(Symbol,Bool%7CString)-instance-method" class="signature"><strong>#config</strong> : Hash(Symbol, Bool | String)</a>
<a href="#config%3AHash%28Symbol%2CBool%7CString%29-instance-method" class="signature"><strong>#config</strong> : Hash(Symbol, Bool | String)</a>
</li>
<li class="entry-summary">
<a href="#finished(sources)-instance-method" class="signature"><strong>#finished</strong>(sources)</a>
<a href="#finished%28sources%29-instance-method" class="signature"><strong>#finished</strong>(sources)</a>
<div class="summary"><p>Callback that indicates when inspection is finished.</p></div>
</li>
<li class="entry-summary">
<a href="#output:IO::FileDescriptor%7CIO::Memory-instance-method" class="signature"><strong>#output</strong> : IO::FileDescriptor | IO::Memory</a>
<a href="#output%3AIO%3A%3AFileDescriptor%7CIO%3A%3AMemory-instance-method" class="signature"><strong>#output</strong> : IO::FileDescriptor | IO::Memory</a>
<div class="summary"><p><span class="flag orange">TODO</span> allow other IOs</p></div>
</li>
<li class="entry-summary">
<a href="#source_finished(source:Source)-instance-method" class="signature"><strong>#source_finished</strong>(source : Source)</a>
<a href="#source_finished%28source%3ASource%29-instance-method" class="signature"><strong>#source_finished</strong>(source : Source)</a>
<div class="summary"><p>Callback that indicates when source inspection is finished.</p></div>
</li>
<li class="entry-summary">
<a href="#source_started(source:Source)-instance-method" class="signature"><strong>#source_started</strong>(source : Source)</a>
<a href="#source_started%28source%3ASource%29-instance-method" class="signature"><strong>#source_started</strong>(source : Source)</a>
<div class="summary"><p>Callback that indicates when source inspection is finished.</p></div>
</li>
<li class="entry-summary">
<a href="#started(sources)-instance-method" class="signature"><strong>#started</strong>(sources)</a>
<a href="#started%28sources%29-instance-method" class="signature"><strong>#started</strong>(sources)</a>
<div class="summary"><p>Callback that indicates when inspecting is started.</p></div>
@ -813,13 +818,13 @@ callbacks in <code><a href="../../Ameba/Runner.html#run-instance-method">Ameba::
def self.<strong>new</strong>(output = <span class="t">STDOUT</span>)
<a class="method-permalink" href="#new(output=STDOUT)-class-method">#</a>
<a class="method-permalink" href="#new%28output%3DSTDOUT%29-class-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/base_formatter.cr#L13" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/base_formatter.cr#L13" target="_blank">View source</a>]
</div>
</div>
@ -843,13 +848,13 @@ callbacks in <code><a href="../../Ameba/Runner.html#run-instance-method">Ameba::
def <strong>config</strong> : Hash(Symbol, Bool | String)
<a class="method-permalink" href="#config:Hash(Symbol,Bool%7CString)-instance-method">#</a>
<a class="method-permalink" href="#config%3AHash%28Symbol%2CBool%7CString%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/base_formatter.cr#L11" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/base_formatter.cr#L11" target="_blank">View source</a>]
</div>
</div>
@ -859,7 +864,7 @@ callbacks in <code><a href="../../Ameba/Runner.html#run-instance-method">Ameba::
def <strong>finished</strong>(sources)
<a class="method-permalink" href="#finished(sources)-instance-method">#</a>
<a class="method-permalink" href="#finished%28sources%29-instance-method">#</a>
</div>
<div class="doc">
@ -871,7 +876,7 @@ A list of inspected sources is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/base_formatter.cr#L30" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/base_formatter.cr#L30" target="_blank">View source</a>]
</div>
</div>
@ -881,7 +886,7 @@ A list of inspected sources is passed as an argument.</p>
def <strong>output</strong> : IO::FileDescriptor | IO::Memory
<a class="method-permalink" href="#output:IO::FileDescriptor%7CIO::Memory-instance-method">#</a>
<a class="method-permalink" href="#output%3AIO%3A%3AFileDescriptor%7CIO%3A%3AMemory-instance-method">#</a>
</div>
<div class="doc">
@ -892,7 +897,7 @@ A list of inspected sources is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/base_formatter.cr#L10" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/base_formatter.cr#L10" target="_blank">View source</a>]
</div>
</div>
@ -902,7 +907,7 @@ A list of inspected sources is passed as an argument.</p>
def <strong>source_finished</strong>(source : <a href="../../Ameba/Source.html">Source</a>)
<a class="method-permalink" href="#source_finished(source:Source)-instance-method">#</a>
<a class="method-permalink" href="#source_finished%28source%3ASource%29-instance-method">#</a>
</div>
<div class="doc">
@ -914,7 +919,7 @@ A corresponding source is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/base_formatter.cr#L22" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/base_formatter.cr#L22" target="_blank">View source</a>]
</div>
</div>
@ -924,7 +929,7 @@ A corresponding source is passed as an argument.</p>
def <strong>source_started</strong>(source : <a href="../../Ameba/Source.html">Source</a>)
<a class="method-permalink" href="#source_started(source:Source)-instance-method">#</a>
<a class="method-permalink" href="#source_started%28source%3ASource%29-instance-method">#</a>
</div>
<div class="doc">
@ -936,7 +941,7 @@ A corresponding source is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/base_formatter.cr#L26" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/base_formatter.cr#L26" target="_blank">View source</a>]
</div>
</div>
@ -946,7 +951,7 @@ A corresponding source is passed as an argument.</p>
def <strong>started</strong>(sources)
<a class="method-permalink" href="#started(sources)-instance-method">#</a>
<a class="method-permalink" href="#started%28sources%29-instance-method">#</a>
</div>
<div class="doc">
@ -958,7 +963,7 @@ A list of sources to inspect is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/base_formatter.cr#L18" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/base_formatter.cr#L18" target="_blank">View source</a>]
</div>
</div>

29
Ameba/Formatter/DisabledFormatter.html
View file

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.36.1">
<meta name="generator" content="Crystal Docs 1.1.1">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
@ -286,6 +286,11 @@
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
<a href="../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
<a href="../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
@ -664,7 +669,7 @@
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/disabled_formatter.cr#L3" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/disabled_formatter.cr#L3" target="_blank">
ameba/formatter/disabled_formatter.cr
</a>
@ -690,7 +695,7 @@
<ul class="list-summary">
<li class="entry-summary">
<a href="#finished(sources)-instance-method" class="signature"><strong>#finished</strong>(sources)</a>
<a href="#finished%28sources%29-instance-method" class="signature"><strong>#finished</strong>(sources)</a>
<div class="summary"><p>Callback that indicates when inspection is finished.</p></div>
@ -709,32 +714,32 @@
<h3>Instance methods inherited from class <code><a href="../../Ameba/Formatter/BaseFormatter.html">Ameba::Formatter::BaseFormatter</a></code></h3>
<a href="../../Ameba/Formatter/BaseFormatter.html#config:Hash(Symbol,Bool%7CString)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#config%3AHash%28Symbol%2CBool%7CString%29-instance-method" class="tooltip">
<span>config : Hash(Symbol, Bool | String)</span>
config</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#finished(sources)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#finished%28sources%29-instance-method" class="tooltip">
<span>finished(sources)</span>
finished</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#output:IO::FileDescriptor%7CIO::Memory-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#output%3AIO%3A%3AFileDescriptor%7CIO%3A%3AMemory-instance-method" class="tooltip">
<span>output : IO::FileDescriptor | IO::Memory</span>
output</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#source_finished(source:Source)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#source_finished%28source%3ASource%29-instance-method" class="tooltip">
<span>source_finished(source : Source)</span>
source_finished</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#source_started(source:Source)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#source_started%28source%3ASource%29-instance-method" class="tooltip">
<span>source_started(source : Source)</span>
source_started</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#started(sources)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#started%28sources%29-instance-method" class="tooltip">
<span>started(sources)</span>
started</a>
@ -746,7 +751,7 @@
<h3>Constructor methods inherited from class <code><a href="../../Ameba/Formatter/BaseFormatter.html">Ameba::Formatter::BaseFormatter</a></code></h3>
<a href="../../Ameba/Formatter/BaseFormatter.html#new(output=STDOUT)-class-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#new%28output%3DSTDOUT%29-class-method" class="tooltip">
<span>new(output = <span class="t">STDOUT</span>)</span>
new</a>
@ -798,7 +803,7 @@
def <strong>finished</strong>(sources)
<a class="method-permalink" href="#finished(sources)-instance-method">#</a>
<a class="method-permalink" href="#finished%28sources%29-instance-method">#</a>
</div>
<div class="doc">
@ -814,7 +819,7 @@ A list of inspected sources is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/disabled_formatter.cr#L4" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/disabled_formatter.cr#L4" target="_blank">View source</a>]
</div>
</div>

49
Ameba/Formatter/DotFormatter.html
View file

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.36.1">
<meta name="generator" content="Crystal Docs 1.1.1">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
@ -286,6 +286,11 @@
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
<a href="../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
<a href="../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
@ -693,7 +698,7 @@ It is similar to Crystal's dot formatter for specs.</p>
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/dot_formatter.cr#L6" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/dot_formatter.cr#L6" target="_blank">
ameba/formatter/dot_formatter.cr
</a>
@ -719,21 +724,21 @@ It is similar to Crystal's dot formatter for specs.</p>
<ul class="list-summary">
<li class="entry-summary">
<a href="#finished(sources)-instance-method" class="signature"><strong>#finished</strong>(sources)</a>
<a href="#finished%28sources%29-instance-method" class="signature"><strong>#finished</strong>(sources)</a>
<div class="summary"><p>Reports a message when inspection is finished.</p></div>
</li>
<li class="entry-summary">
<a href="#source_finished(source:Source)-instance-method" class="signature"><strong>#source_finished</strong>(source : Source)</a>
<a href="#source_finished%28source%3ASource%29-instance-method" class="signature"><strong>#source_finished</strong>(source : Source)</a>
<div class="summary"><p>Reports a result of the inspection of a corresponding source.</p></div>
</li>
<li class="entry-summary">
<a href="#started(sources)-instance-method" class="signature"><strong>#started</strong>(sources)</a>
<a href="#started%28sources%29-instance-method" class="signature"><strong>#started</strong>(sources)</a>
<div class="summary"><p>Reports a message when inspection is started.</p></div>
@ -752,22 +757,22 @@ It is similar to Crystal's dot formatter for specs.</p>
<h3>Instance methods inherited from module <code><a href="../../Ameba/Formatter/Util.html">Ameba::Formatter::Util</a></code></h3>
<a href="../../Ameba/Formatter/Util.html#affected_code(source,location,end_location=nil,context_lines=0,max_length=120,ellipsis=&quot;...&quot;,prompt=&quot;&gt;&quot;)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/Util.html#affected_code%28source%2Clocation%2Cend_location%3Dnil%2Ccontext_lines%3D0%2Cmax_length%3D120%2Cellipsis%3D%22...%22%2Cprompt%3D%22%3E%22%29-instance-method" class="tooltip">
<span>affected_code(source, location, end_location = <span class="n">nil</span>, context_lines = <span class="n">0</span>, max_length = <span class="n">120</span>, ellipsis = <span class="s">&quot; ...&quot;</span>, prompt = <span class="s">&quot;&gt; &quot;</span>)</span>
affected_code</a>,
<a href="../../Ameba/Formatter/Util.html#context(lines,lineno,context_lines=3,remove_empty=true)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/Util.html#context%28lines%2Clineno%2Ccontext_lines%3D3%2Cremove_empty%3Dtrue%29-instance-method" class="tooltip">
<span>context(lines, lineno, context_lines = <span class="n">3</span>, remove_empty = <span class="n">true</span>)</span>
context</a>,
<a href="../../Ameba/Formatter/Util.html#deansify(message:String?):String?-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/Util.html#deansify%28message%3AString%3F%29%3AString%3F-instance-method" class="tooltip">
<span>deansify(message : String?) : String?</span>
deansify</a>,
<a href="../../Ameba/Formatter/Util.html#trim(str,max_length=120,ellipsis=&quot;...&quot;)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/Util.html#trim%28str%2Cmax_length%3D120%2Cellipsis%3D%22...%22%29-instance-method" class="tooltip">
<span>trim(str, max_length = <span class="n">120</span>, ellipsis = <span class="s">&quot; ...&quot;</span>)</span>
trim</a>
@ -786,32 +791,32 @@ It is similar to Crystal's dot formatter for specs.</p>
<h3>Instance methods inherited from class <code><a href="../../Ameba/Formatter/BaseFormatter.html">Ameba::Formatter::BaseFormatter</a></code></h3>
<a href="../../Ameba/Formatter/BaseFormatter.html#config:Hash(Symbol,Bool%7CString)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#config%3AHash%28Symbol%2CBool%7CString%29-instance-method" class="tooltip">
<span>config : Hash(Symbol, Bool | String)</span>
config</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#finished(sources)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#finished%28sources%29-instance-method" class="tooltip">
<span>finished(sources)</span>
finished</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#output:IO::FileDescriptor%7CIO::Memory-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#output%3AIO%3A%3AFileDescriptor%7CIO%3A%3AMemory-instance-method" class="tooltip">
<span>output : IO::FileDescriptor | IO::Memory</span>
output</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#source_finished(source:Source)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#source_finished%28source%3ASource%29-instance-method" class="tooltip">
<span>source_finished(source : Source)</span>
source_finished</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#source_started(source:Source)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#source_started%28source%3ASource%29-instance-method" class="tooltip">
<span>source_started(source : Source)</span>
source_started</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#started(sources)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#started%28sources%29-instance-method" class="tooltip">
<span>started(sources)</span>
started</a>
@ -823,7 +828,7 @@ It is similar to Crystal's dot formatter for specs.</p>
<h3>Constructor methods inherited from class <code><a href="../../Ameba/Formatter/BaseFormatter.html">Ameba::Formatter::BaseFormatter</a></code></h3>
<a href="../../Ameba/Formatter/BaseFormatter.html#new(output=STDOUT)-class-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#new%28output%3DSTDOUT%29-class-method" class="tooltip">
<span>new(output = <span class="t">STDOUT</span>)</span>
new</a>
@ -875,7 +880,7 @@ It is similar to Crystal's dot formatter for specs.</p>
def <strong>finished</strong>(sources)
<a class="method-permalink" href="#finished(sources)-instance-method">#</a>
<a class="method-permalink" href="#finished%28sources%29-instance-method">#</a>
</div>
<div class="doc">
@ -886,7 +891,7 @@ It is similar to Crystal's dot formatter for specs.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/dot_formatter.cr#L27" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/dot_formatter.cr#L27" target="_blank">View source</a>]
</div>
</div>
@ -896,7 +901,7 @@ It is similar to Crystal's dot formatter for specs.</p>
def <strong>source_finished</strong>(source : <a href="../../Ameba/Source.html">Source</a>)
<a class="method-permalink" href="#source_finished(source:Source)-instance-method">#</a>
<a class="method-permalink" href="#source_finished%28source%3ASource%29-instance-method">#</a>
</div>
<div class="doc">
@ -907,7 +912,7 @@ It is similar to Crystal's dot formatter for specs.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/dot_formatter.cr#L21" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/dot_formatter.cr#L21" target="_blank">View source</a>]
</div>
</div>
@ -917,7 +922,7 @@ It is similar to Crystal's dot formatter for specs.</p>
def <strong>started</strong>(sources)
<a class="method-permalink" href="#started(sources)-instance-method">#</a>
<a class="method-permalink" href="#started%28sources%29-instance-method">#</a>
</div>
<div class="doc">
@ -928,7 +933,7 @@ It is similar to Crystal's dot formatter for specs.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/dot_formatter.cr#L13" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/dot_formatter.cr#L13" target="_blank">View source</a>]
</div>
</div>

42
Ameba/Formatter/ExplainFormatter.html
View file

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.36.1">
<meta name="generator" content="Crystal Docs 1.1.1">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
@ -286,6 +286,11 @@
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
<a href="../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
<a href="../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
@ -679,7 +684,7 @@ a specific location.</p>
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/explain_formatter.cr#L6" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/explain_formatter.cr#L6" target="_blank">
ameba/formatter/explain_formatter.cr
</a>
@ -725,7 +730,7 @@ a specific location.</p>
<ul class="list-summary">
<li class="entry-summary">
<a href="#new(output,location)-class-method" class="signature"><strong>.new</strong>(output, location)</a>
<a href="#new%28output%2Clocation%29-class-method" class="signature"><strong>.new</strong>(output, location)</a>
<div class="summary"><p>Creates a new instance of ExplainFormatter.</p></div>
@ -748,19 +753,19 @@ a specific location.</p>
<ul class="list-summary">
<li class="entry-summary">
<a href="#finished(sources)-instance-method" class="signature"><strong>#finished</strong>(sources)</a>
<a href="#finished%28sources%29-instance-method" class="signature"><strong>#finished</strong>(sources)</a>
<div class="summary"><p>Reports the explainations at the <em>@location</em>.</p></div>
</li>
<li class="entry-summary">
<a href="#location:Crystal::Location-instance-method" class="signature"><strong>#location</strong> : Crystal::Location</a>
<a href="#location%3ACrystal%3A%3ALocation-instance-method" class="signature"><strong>#location</strong> : Crystal::Location</a>
</li>
<li class="entry-summary">
<a href="#output:IO::FileDescriptor%7CIO::Memory-instance-method" class="signature"><strong>#output</strong> : IO::FileDescriptor | IO::Memory</a>
<a href="#output%3AIO%3A%3AFileDescriptor%7CIO%3A%3AMemory-instance-method" class="signature"><strong>#output</strong> : IO::FileDescriptor | IO::Memory</a>
</li>
@ -777,22 +782,22 @@ a specific location.</p>
<h3>Instance methods inherited from module <code><a href="../../Ameba/Formatter/Util.html">Ameba::Formatter::Util</a></code></h3>
<a href="../../Ameba/Formatter/Util.html#affected_code(source,location,end_location=nil,context_lines=0,max_length=120,ellipsis=&quot;...&quot;,prompt=&quot;&gt;&quot;)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/Util.html#affected_code%28source%2Clocation%2Cend_location%3Dnil%2Ccontext_lines%3D0%2Cmax_length%3D120%2Cellipsis%3D%22...%22%2Cprompt%3D%22%3E%22%29-instance-method" class="tooltip">
<span>affected_code(source, location, end_location = <span class="n">nil</span>, context_lines = <span class="n">0</span>, max_length = <span class="n">120</span>, ellipsis = <span class="s">&quot; ...&quot;</span>, prompt = <span class="s">&quot;&gt; &quot;</span>)</span>
affected_code</a>,
<a href="../../Ameba/Formatter/Util.html#context(lines,lineno,context_lines=3,remove_empty=true)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/Util.html#context%28lines%2Clineno%2Ccontext_lines%3D3%2Cremove_empty%3Dtrue%29-instance-method" class="tooltip">
<span>context(lines, lineno, context_lines = <span class="n">3</span>, remove_empty = <span class="n">true</span>)</span>
context</a>,
<a href="../../Ameba/Formatter/Util.html#deansify(message:String?):String?-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/Util.html#deansify%28message%3AString%3F%29%3AString%3F-instance-method" class="tooltip">
<span>deansify(message : String?) : String?</span>
deansify</a>,
<a href="../../Ameba/Formatter/Util.html#trim(str,max_length=120,ellipsis=&quot;...&quot;)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/Util.html#trim%28str%2Cmax_length%3D120%2Cellipsis%3D%22...%22%29-instance-method" class="tooltip">
<span>trim(str, max_length = <span class="n">120</span>, ellipsis = <span class="s">&quot; ...&quot;</span>)</span>
trim</a>
@ -843,7 +848,7 @@ a specific location.</p>
def self.<strong>new</strong>(output, location)
<a class="method-permalink" href="#new(output,location)-class-method">#</a>
<a class="method-permalink" href="#new%28output%2Clocation%29-class-method">#</a>
</div>
<div class="doc">
@ -851,7 +856,6 @@ a specific location.</p>
<p>Creates a new instance of ExplainFormatter.
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,
{file: path, line: line_number, column: column_number}</code></pre>
</div>
@ -859,7 +863,7 @@ Second argument is <em>location</em> which indicates the location to explain.</p
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/explain_formatter.cr#L23" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/explain_formatter.cr#L23" target="_blank">View source</a>]
</div>
</div>
@ -883,7 +887,7 @@ Second argument is <em>location</em> which indicates the location to explain.</p
def <strong>finished</strong>(sources)
<a class="method-permalink" href="#finished(sources)-instance-method">#</a>
<a class="method-permalink" href="#finished%28sources%29-instance-method">#</a>
</div>
<div class="doc">
@ -894,7 +898,7 @@ Second argument is <em>location</em> which indicates the location to explain.</p
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/explain_formatter.cr#L28" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/explain_formatter.cr#L28" target="_blank">View source</a>]
</div>
</div>
@ -904,13 +908,13 @@ Second argument is <em>location</em> which indicates the location to explain.</p
def <strong>location</strong> : Crystal::Location
<a class="method-permalink" href="#location:Crystal::Location-instance-method">#</a>
<a class="method-permalink" href="#location%3ACrystal%3A%3ALocation-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/explain_formatter.cr#L13" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/explain_formatter.cr#L13" target="_blank">View source</a>]
</div>
</div>
@ -920,13 +924,13 @@ Second argument is <em>location</em> which indicates the location to explain.</p
def <strong>output</strong> : IO::FileDescriptor | IO::Memory
<a class="method-permalink" href="#output:IO::FileDescriptor%7CIO::Memory-instance-method">#</a>
<a class="method-permalink" href="#output%3AIO%3A%3AFileDescriptor%7CIO%3A%3AMemory-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/explain_formatter.cr#L12" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/explain_formatter.cr#L12" target="_blank">View source</a>]
</div>
</div>

29
Ameba/Formatter/FlycheckFormatter.html
View file

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.36.1">
<meta name="generator" content="Crystal Docs 1.1.1">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
@ -286,6 +286,11 @@
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
<a href="../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
<a href="../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
@ -653,7 +658,7 @@
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/flycheck_formatter.cr#L2" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/flycheck_formatter.cr#L2" target="_blank">
ameba/formatter/flycheck_formatter.cr
</a>
@ -679,7 +684,7 @@
<ul class="list-summary">
<li class="entry-summary">
<a href="#source_finished(source:Source)-instance-method" class="signature"><strong>#source_finished</strong>(source : Source)</a>
<a href="#source_finished%28source%3ASource%29-instance-method" class="signature"><strong>#source_finished</strong>(source : Source)</a>
<div class="summary"><p>Callback that indicates when source inspection is finished.</p></div>
@ -698,32 +703,32 @@
<h3>Instance methods inherited from class <code><a href="../../Ameba/Formatter/BaseFormatter.html">Ameba::Formatter::BaseFormatter</a></code></h3>
<a href="../../Ameba/Formatter/BaseFormatter.html#config:Hash(Symbol,Bool%7CString)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#config%3AHash%28Symbol%2CBool%7CString%29-instance-method" class="tooltip">
<span>config : Hash(Symbol, Bool | String)</span>
config</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#finished(sources)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#finished%28sources%29-instance-method" class="tooltip">
<span>finished(sources)</span>
finished</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#output:IO::FileDescriptor%7CIO::Memory-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#output%3AIO%3A%3AFileDescriptor%7CIO%3A%3AMemory-instance-method" class="tooltip">
<span>output : IO::FileDescriptor | IO::Memory</span>
output</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#source_finished(source:Source)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#source_finished%28source%3ASource%29-instance-method" class="tooltip">
<span>source_finished(source : Source)</span>
source_finished</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#source_started(source:Source)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#source_started%28source%3ASource%29-instance-method" class="tooltip">
<span>source_started(source : Source)</span>
source_started</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#started(sources)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#started%28sources%29-instance-method" class="tooltip">
<span>started(sources)</span>
started</a>
@ -735,7 +740,7 @@
<h3>Constructor methods inherited from class <code><a href="../../Ameba/Formatter/BaseFormatter.html">Ameba::Formatter::BaseFormatter</a></code></h3>
<a href="../../Ameba/Formatter/BaseFormatter.html#new(output=STDOUT)-class-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#new%28output%3DSTDOUT%29-class-method" class="tooltip">
<span>new(output = <span class="t">STDOUT</span>)</span>
new</a>
@ -787,7 +792,7 @@
def <strong>source_finished</strong>(source : <a href="../../Ameba/Source.html">Source</a>)
<a class="method-permalink" href="#source_finished(source:Source)-instance-method">#</a>
<a class="method-permalink" href="#source_finished%28source%3ASource%29-instance-method">#</a>
</div>
<div class="doc">
@ -803,7 +808,7 @@ A corresponding source is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/flycheck_formatter.cr#L5" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/flycheck_formatter.cr#L5" target="_blank">View source</a>]
</div>
</div>

49
Ameba/Formatter/JSONFormatter.html
View file

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.36.1">
<meta name="generator" content="Crystal Docs 1.1.1">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
@ -286,6 +286,11 @@
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
<a href="../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
<a href="../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
@ -640,9 +645,7 @@
</h2>
<p>A formatter that produces the result in a json format.</p>
<p>Example:</p>
<pre><code class="language-crystal">{
<span class="s">&quot;metadata&quot;</span>: {
<span class="s">&quot;ameba_version&quot;</span>: <span class="s">&quot;x.x.x&quot;</span>,
@ -722,7 +725,7 @@
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/json_formatter.cr#L66" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/json_formatter.cr#L66" target="_blank">
ameba/formatter/json_formatter.cr
</a>
@ -744,7 +747,7 @@
<ul class="list-summary">
<li class="entry-summary">
<a href="#new(output=STDOUT)-class-method" class="signature"><strong>.new</strong>(output = <span class="t">STDOUT</span>)</a>
<a href="#new%28output%3DSTDOUT%29-class-method" class="signature"><strong>.new</strong>(output = <span class="t">STDOUT</span>)</a>
</li>
@ -765,21 +768,21 @@
<ul class="list-summary">
<li class="entry-summary">
<a href="#finished(sources)-instance-method" class="signature"><strong>#finished</strong>(sources)</a>
<a href="#finished%28sources%29-instance-method" class="signature"><strong>#finished</strong>(sources)</a>
<div class="summary"><p>Callback that indicates when inspection is finished.</p></div>
</li>
<li class="entry-summary">
<a href="#source_finished(source:Source)-instance-method" class="signature"><strong>#source_finished</strong>(source : Source)</a>
<a href="#source_finished%28source%3ASource%29-instance-method" class="signature"><strong>#source_finished</strong>(source : Source)</a>
<div class="summary"><p>Callback that indicates when source inspection is finished.</p></div>
</li>
<li class="entry-summary">
<a href="#started(sources)-instance-method" class="signature"><strong>#started</strong>(sources)</a>
<a href="#started%28sources%29-instance-method" class="signature"><strong>#started</strong>(sources)</a>
<div class="summary"><p>Callback that indicates when inspecting is started.</p></div>
@ -798,32 +801,32 @@
<h3>Instance methods inherited from class <code><a href="../../Ameba/Formatter/BaseFormatter.html">Ameba::Formatter::BaseFormatter</a></code></h3>
<a href="../../Ameba/Formatter/BaseFormatter.html#config:Hash(Symbol,Bool%7CString)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#config%3AHash%28Symbol%2CBool%7CString%29-instance-method" class="tooltip">
<span>config : Hash(Symbol, Bool | String)</span>
config</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#finished(sources)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#finished%28sources%29-instance-method" class="tooltip">
<span>finished(sources)</span>
finished</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#output:IO::FileDescriptor%7CIO::Memory-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#output%3AIO%3A%3AFileDescriptor%7CIO%3A%3AMemory-instance-method" class="tooltip">
<span>output : IO::FileDescriptor | IO::Memory</span>
output</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#source_finished(source:Source)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#source_finished%28source%3ASource%29-instance-method" class="tooltip">
<span>source_finished(source : Source)</span>
source_finished</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#source_started(source:Source)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#source_started%28source%3ASource%29-instance-method" class="tooltip">
<span>source_started(source : Source)</span>
source_started</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#started(sources)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#started%28sources%29-instance-method" class="tooltip">
<span>started(sources)</span>
started</a>
@ -835,7 +838,7 @@
<h3>Constructor methods inherited from class <code><a href="../../Ameba/Formatter/BaseFormatter.html">Ameba::Formatter::BaseFormatter</a></code></h3>
<a href="../../Ameba/Formatter/BaseFormatter.html#new(output=STDOUT)-class-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#new%28output%3DSTDOUT%29-class-method" class="tooltip">
<span>new(output = <span class="t">STDOUT</span>)</span>
new</a>
@ -883,13 +886,13 @@
def self.<strong>new</strong>(output = <span class="t">STDOUT</span>)
<a class="method-permalink" href="#new(output=STDOUT)-class-method">#</a>
<a class="method-permalink" href="#new%28output%3DSTDOUT%29-class-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/json_formatter.cr#L67" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/json_formatter.cr#L67" target="_blank">View source</a>]
</div>
</div>
@ -913,7 +916,7 @@
def <strong>finished</strong>(sources)
<a class="method-permalink" href="#finished(sources)-instance-method">#</a>
<a class="method-permalink" href="#finished%28sources%29-instance-method">#</a>
</div>
<div class="doc">
@ -929,7 +932,7 @@ A list of inspected sources is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/json_formatter.cr#L87" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/json_formatter.cr#L87" target="_blank">View source</a>]
</div>
</div>
@ -939,7 +942,7 @@ A list of inspected sources is passed as an argument.</p>
def <strong>source_finished</strong>(source : <a href="../../Ameba/Source.html">Source</a>)
<a class="method-permalink" href="#source_finished(source:Source)-instance-method">#</a>
<a class="method-permalink" href="#source_finished%28source%3ASource%29-instance-method">#</a>
</div>
<div class="doc">
@ -955,7 +958,7 @@ A corresponding source is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/json_formatter.cr#L75" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/json_formatter.cr#L75" target="_blank">View source</a>]
</div>
</div>
@ -965,7 +968,7 @@ A corresponding source is passed as an argument.</p>
def <strong>started</strong>(sources)
<a class="method-permalink" href="#started(sources)-instance-method">#</a>
<a class="method-permalink" href="#started%28sources%29-instance-method">#</a>
</div>
<div class="doc">
@ -981,7 +984,7 @@ A list of sources to inspect is passed as an argument.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/json_formatter.cr#L71" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/json_formatter.cr#L71" target="_blank">View source</a>]
</div>
</div>

49
Ameba/Formatter/TODOFormatter.html
View file

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.36.1">
<meta name="generator" content="Crystal Docs 1.1.1">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
@ -286,6 +286,11 @@
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
<a href="../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
<a href="../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
@ -666,7 +671,7 @@ or excludes failed sources from these rules.</p>
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/todo_formatter.cr#L5" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/todo_formatter.cr#L5" target="_blank">
ameba/formatter/todo_formatter.cr
</a>
@ -688,7 +693,7 @@ or excludes failed sources from these rules.</p>
<ul class="list-summary">
<li class="entry-summary">
<a href="#new(output=STDOUT)-class-method" class="signature"><strong>.new</strong>(output = <span class="t">STDOUT</span>)</a>
<a href="#new%28output%3DSTDOUT%29-class-method" class="signature"><strong>.new</strong>(output = <span class="t">STDOUT</span>)</a>
</li>
@ -709,7 +714,7 @@ or excludes failed sources from these rules.</p>
<ul class="list-summary">
<li class="entry-summary">
<a href="#finished(sources)-instance-method" class="signature"><strong>#finished</strong>(sources)</a>
<a href="#finished%28sources%29-instance-method" class="signature"><strong>#finished</strong>(sources)</a>
<div class="summary"><p>Reports a message when inspection is finished.</p></div>
@ -728,17 +733,17 @@ or excludes failed sources from these rules.</p>
<h3>Instance methods inherited from class <code><a href="../../Ameba/Formatter/DotFormatter.html">Ameba::Formatter::DotFormatter</a></code></h3>
<a href="../../Ameba/Formatter/DotFormatter.html#finished(sources)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/DotFormatter.html#finished%28sources%29-instance-method" class="tooltip">
<span>finished(sources)</span>
finished</a>,
<a href="../../Ameba/Formatter/DotFormatter.html#source_finished(source:Source)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/DotFormatter.html#source_finished%28source%3ASource%29-instance-method" class="tooltip">
<span>source_finished(source : Source)</span>
source_finished</a>,
<a href="../../Ameba/Formatter/DotFormatter.html#started(sources)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/DotFormatter.html#started%28sources%29-instance-method" class="tooltip">
<span>started(sources)</span>
started</a>
@ -757,22 +762,22 @@ or excludes failed sources from these rules.</p>
<h3>Instance methods inherited from module <code><a href="../../Ameba/Formatter/Util.html">Ameba::Formatter::Util</a></code></h3>
<a href="../../Ameba/Formatter/Util.html#affected_code(source,location,end_location=nil,context_lines=0,max_length=120,ellipsis=&quot;...&quot;,prompt=&quot;&gt;&quot;)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/Util.html#affected_code%28source%2Clocation%2Cend_location%3Dnil%2Ccontext_lines%3D0%2Cmax_length%3D120%2Cellipsis%3D%22...%22%2Cprompt%3D%22%3E%22%29-instance-method" class="tooltip">
<span>affected_code(source, location, end_location = <span class="n">nil</span>, context_lines = <span class="n">0</span>, max_length = <span class="n">120</span>, ellipsis = <span class="s">&quot; ...&quot;</span>, prompt = <span class="s">&quot;&gt; &quot;</span>)</span>
affected_code</a>,
<a href="../../Ameba/Formatter/Util.html#context(lines,lineno,context_lines=3,remove_empty=true)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/Util.html#context%28lines%2Clineno%2Ccontext_lines%3D3%2Cremove_empty%3Dtrue%29-instance-method" class="tooltip">
<span>context(lines, lineno, context_lines = <span class="n">3</span>, remove_empty = <span class="n">true</span>)</span>
context</a>,
<a href="../../Ameba/Formatter/Util.html#deansify(message:String?):String?-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/Util.html#deansify%28message%3AString%3F%29%3AString%3F-instance-method" class="tooltip">
<span>deansify(message : String?) : String?</span>
deansify</a>,
<a href="../../Ameba/Formatter/Util.html#trim(str,max_length=120,ellipsis=&quot;...&quot;)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/Util.html#trim%28str%2Cmax_length%3D120%2Cellipsis%3D%22...%22%29-instance-method" class="tooltip">
<span>trim(str, max_length = <span class="n">120</span>, ellipsis = <span class="s">&quot; ...&quot;</span>)</span>
trim</a>
@ -791,32 +796,32 @@ or excludes failed sources from these rules.</p>
<h3>Instance methods inherited from class <code><a href="../../Ameba/Formatter/BaseFormatter.html">Ameba::Formatter::BaseFormatter</a></code></h3>
<a href="../../Ameba/Formatter/BaseFormatter.html#config:Hash(Symbol,Bool%7CString)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#config%3AHash%28Symbol%2CBool%7CString%29-instance-method" class="tooltip">
<span>config : Hash(Symbol, Bool | String)</span>
config</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#finished(sources)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#finished%28sources%29-instance-method" class="tooltip">
<span>finished(sources)</span>
finished</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#output:IO::FileDescriptor%7CIO::Memory-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#output%3AIO%3A%3AFileDescriptor%7CIO%3A%3AMemory-instance-method" class="tooltip">
<span>output : IO::FileDescriptor | IO::Memory</span>
output</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#source_finished(source:Source)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#source_finished%28source%3ASource%29-instance-method" class="tooltip">
<span>source_finished(source : Source)</span>
source_finished</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#source_started(source:Source)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#source_started%28source%3ASource%29-instance-method" class="tooltip">
<span>source_started(source : Source)</span>
source_started</a>,
<a href="../../Ameba/Formatter/BaseFormatter.html#started(sources)-instance-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#started%28sources%29-instance-method" class="tooltip">
<span>started(sources)</span>
started</a>
@ -828,7 +833,7 @@ or excludes failed sources from these rules.</p>
<h3>Constructor methods inherited from class <code><a href="../../Ameba/Formatter/BaseFormatter.html">Ameba::Formatter::BaseFormatter</a></code></h3>
<a href="../../Ameba/Formatter/BaseFormatter.html#new(output=STDOUT)-class-method" class="tooltip">
<a href="../../Ameba/Formatter/BaseFormatter.html#new%28output%3DSTDOUT%29-class-method" class="tooltip">
<span>new(output = <span class="t">STDOUT</span>)</span>
new</a>
@ -876,13 +881,13 @@ or excludes failed sources from these rules.</p>
def self.<strong>new</strong>(output = <span class="t">STDOUT</span>)
<a class="method-permalink" href="#new(output=STDOUT)-class-method">#</a>
<a class="method-permalink" href="#new%28output%3DSTDOUT%29-class-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/todo_formatter.cr#L6" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/todo_formatter.cr#L6" target="_blank">View source</a>]
</div>
</div>
@ -906,7 +911,7 @@ or excludes failed sources from these rules.</p>
def <strong>finished</strong>(sources)
<a class="method-permalink" href="#finished(sources)-instance-method">#</a>
<a class="method-permalink" href="#finished%28sources%29-instance-method">#</a>
</div>
<div class="doc">
@ -921,7 +926,7 @@ or excludes failed sources from these rules.</p>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/todo_formatter.cr#L9" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/todo_formatter.cr#L9" target="_blank">View source</a>]
</div>
</div>

33
Ameba/Formatter/Util.html
View file

@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.36.1">
<meta name="generator" content="Crystal Docs 1.1.1">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
@ -286,6 +286,11 @@
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
<a href="../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
<a href="../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
@ -667,7 +672,7 @@
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/util.cr#L2" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/util.cr#L2" target="_blank">
ameba/formatter/util.cr
</a>
@ -693,22 +698,22 @@
<ul class="list-summary">
<li class="entry-summary">
<a href="#affected_code(source,location,end_location=nil,context_lines=0,max_length=120,ellipsis=&quot;...&quot;,prompt=&quot;&gt;&quot;)-instance-method" class="signature"><strong>#affected_code</strong>(source, location, end_location = <span class="n">nil</span>, context_lines = <span class="n">0</span>, max_length = <span class="n">120</span>, ellipsis = <span class="s">&quot; ...&quot;</span>, prompt = <span class="s">&quot;&gt; &quot;</span>)</a>
<a href="#affected_code%28source%2Clocation%2Cend_location%3Dnil%2Ccontext_lines%3D0%2Cmax_length%3D120%2Cellipsis%3D%22...%22%2Cprompt%3D%22%3E%22%29-instance-method" class="signature"><strong>#affected_code</strong>(source, location, end_location = <span class="n">nil</span>, context_lines = <span class="n">0</span>, max_length = <span class="n">120</span>, ellipsis = <span class="s">&quot; ...&quot;</span>, prompt = <span class="s">&quot;&gt; &quot;</span>)</a>
</li>
<li class="entry-summary">
<a href="#context(lines,lineno,context_lines=3,remove_empty=true)-instance-method" class="signature"><strong>#context</strong>(lines, lineno, context_lines = <span class="n">3</span>, remove_empty = <span class="n">true</span>)</a>
<a href="#context%28lines%2Clineno%2Ccontext_lines%3D3%2Cremove_empty%3Dtrue%29-instance-method" class="signature"><strong>#context</strong>(lines, lineno, context_lines = <span class="n">3</span>, remove_empty = <span class="n">true</span>)</a>
</li>
<li class="entry-summary">
<a href="#deansify(message:String?):String?-instance-method" class="signature"><strong>#deansify</strong>(message : String?) : String?</a>
<a href="#deansify%28message%3AString%3F%29%3AString%3F-instance-method" class="signature"><strong>#deansify</strong>(message : String?) : String?</a>
</li>
<li class="entry-summary">
<a href="#trim(str,max_length=120,ellipsis=&quot;...&quot;)-instance-method" class="signature"><strong>#trim</strong>(str, max_length = <span class="n">120</span>, ellipsis = <span class="s">&quot; ...&quot;</span>)</a>
<a href="#trim%28str%2Cmax_length%3D120%2Cellipsis%3D%22...%22%29-instance-method" class="signature"><strong>#trim</strong>(str, max_length = <span class="n">120</span>, ellipsis = <span class="s">&quot; ...&quot;</span>)</a>
</li>
@ -741,13 +746,13 @@
def <strong>affected_code</strong>(source, location, end_location = <span class="n">nil</span>, context_lines = <span class="n">0</span>, max_length = <span class="n">120</span>, ellipsis = <span class="s">&quot; ...&quot;</span>, prompt = <span class="s">&quot;&gt; &quot;</span>)
<a class="method-permalink" href="#affected_code(source,location,end_location=nil,context_lines=0,max_length=120,ellipsis=&quot;...&quot;,prompt=&quot;&gt;&quot;)-instance-method">#</a>
<a class="method-permalink" href="#affected_code%28source%2Clocation%2Cend_location%3Dnil%2Ccontext_lines%3D0%2Cmax_length%3D120%2Cellipsis%3D%22...%22%2Cprompt%3D%22%3E%22%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/util.cr#L43" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/util.cr#L43" target="_blank">View source</a>]
</div>
</div>
@ -757,13 +762,13 @@
def <strong>context</strong>(lines, lineno, context_lines = <span class="n">3</span>, remove_empty = <span class="n">true</span>)
<a class="method-permalink" href="#context(lines,lineno,context_lines=3,remove_empty=true)-instance-method">#</a>
<a class="method-permalink" href="#context%28lines%2Clineno%2Ccontext_lines%3D3%2Cremove_empty%3Dtrue%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/util.cr#L17" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/util.cr#L17" target="_blank">View source</a>]
</div>
</div>
@ -773,13 +778,13 @@
def <strong>deansify</strong>(message : String?) : String?
<a class="method-permalink" href="#deansify(message:String?):String?-instance-method">#</a>
<a class="method-permalink" href="#deansify%28message%3AString%3F%29%3AString%3F-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/util.cr#L3" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/util.cr#L3" target="_blank">View source</a>]
</div>
</div>
@ -789,13 +794,13 @@
def <strong>trim</strong>(str, max_length = <span class="n">120</span>, ellipsis = <span class="s">&quot; ...&quot;</span>)
<a class="method-permalink" href="#trim(str,max_length=120,ellipsis=&quot;...&quot;)-instance-method">#</a>
<a class="method-permalink" href="#trim%28str%2Cmax_length%3D120%2Cellipsis%3D%22...%22%29-instance-method">#</a>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/9a91e42b/src/ameba/formatter/util.cr#L7" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/48b15b9b/src/ameba/formatter/util.cr#L7" target="_blank">View source</a>]
</div>
</div>