Deploying to gh-pages from @ 51b0a07e81 🚀

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

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 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>
@ -553,19 +553,19 @@
<div class="main-content">
<ul><li><a href="#about" target="_blank">About</a></li><li><a href="#usage" target="_blank">Usage</a></li></ul>
<ul><li><a href="#about">About</a></li><li><a href="#usage">Usage</a></li></ul>
<ul><li><a href="#run-in-parallel" target="_blank">Run in parallel</a></li></ul></ul>
<ul><li><a href="#run-in-parallel">Run in parallel</a></li></ul></ul>
<ul><li><a href="#installation" target="_blank">Installation</a></li></ul>
<ul><li><a href="#installation">Installation</a></li></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="#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="#configuration" target="_blank">Configuration</a></li></ul>
<ul><li><a href="#configuration">Configuration</a></li></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="#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="#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>
<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>
<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" target="_blank">Crystal code style</a>,
It enforces a consistent <a href="https://crystal-lang.org/docs/conventions/coding_style.html">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" target="_blank">Roadmap</a>.</p>
<p>See also <a href="https://github.com/crystal-ameba/ameba/wiki">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" target="_blank">supports parallelism</a>.
<p>Starting from 0.31.0 Crystal <a href="https://crystal-lang.org/2019/09/06/parallelism-in-crystal.html">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" target="_blank">Travis</a>:</p>
<p>You may also want to use it on <a href="travis-ci.org">Travis</a>:</p>
<pre><code class="language-yaml"># .travis.yml
language: crystal
@ -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" 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>
<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>
<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" 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>
<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>
<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" target="_blank">veelenga</a> Vitalii Elenhaupt - creator, maintainer</li></ul>
<ul><li><a href="https://github.com/veelenga">veelenga</a> Vitalii Elenhaupt - creator, maintainer</li></ul>
</div>
</body>
</html>