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 @ 51b0a07e81 🚀

Browse source
This commit is contained in:
veelenga 2021-01-31 14:41:59 +00:00
parent 2f03204df2
commit 8d0a0f7c6a
93 changed files with 1813 additions and 1813 deletions
Download patch file Download diff file Expand all files Collapse all files

40
Ameba/Runner.html
View file

@ -3,21 +3,16 @@
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.34.0">
<meta name="generator" content="Crystal Docs 0.35.1">
<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>
<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">
<meta name="repository-name" content="ameba">
<title>Ameba::Runner - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../";
@ -25,6 +20,11 @@
</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>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
@ -44,7 +44,7 @@
</div>
</div>
<div class="search-results" class="hidden">
<div class="search-results 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>config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
<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
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>
@ -606,7 +606,7 @@ runner.run.success? <span class="c"># =&gt; true or false</span></code></pre>
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/runner.cr#L13" target="_blank">
<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/runner.cr#L13" target="_blank">
ameba/runner.cr
</a>
@ -730,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>config <span class="o">=</span> <span class="t">Ameba</span><span class="t">::</span><span class="t">Config</span>.load
<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
config.files <span class="o">=</span> files
config.formatter <span class="o">=</span> formatter
@ -740,7 +740,7 @@ config.formatter <span class="o">=</span> formatter
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/runner.cr#L42" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/runner.cr#L42" target="_blank">View source</a>]
</div>
</div>
@ -774,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>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 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
runner.run
runner.explain({file: file, line: l, column: c})</code></pre>
</div>
@ -782,7 +782,7 @@ runner.explain({file: file, line: l, column: c})</code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/runner.cr#L118" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/runner.cr#L118" target="_blank">View source</a>]
</div>
</div>
@ -804,14 +804,14 @@ 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>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 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
runner.run <span class="c"># =&gt; returns runner again</span></code></pre>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/runner.cr#L69" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/runner.cr#L69" target="_blank">View source</a>]
</div>
</div>
@ -832,7 +832,7 @@ runner.run <span class="c"># =&gt; returns runner again</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/runner.cr#L18" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/runner.cr#L18" target="_blank">View source</a>]
</div>
</div>
@ -850,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>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 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
runner.run
runner.success? <span class="c"># =&gt; true or false</span></code></pre>
</div>
@ -858,7 +858,7 @@ runner.success? <span class="c"># =&gt; true or false</span></code></pre>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/d28f9f75/src/ameba/runner.cr#L131" target="_blank">View source</a>]
[<a href="https://github.com/crystal-ameba/ameba/blob/51b0a07e/src/ameba/runner.cr#L131" target="_blank">View source</a>]
</div>
</div>