The latest articles on DEV Community by Jayesh Mann (@jayeshmann). https://dev.to/jayeshmann https://media2.dev.to/dynamic/image/width=90,height=90,fit=cover,gravity=auto,format=auto/https:%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Fuser%2Fprofile_image%2F191569%2F9b24cadd-8d7f-4057-a500-d68e25ddc523.png https://dev.to/jayeshmann en Jayesh Mann Wed, 17 Aug 2022 04:03:30 +0000 https://dev.to/jayeshmann/pre-commit-hooks-guide-for-ruby-5c3h https://dev.to/jayeshmann/pre-commit-hooks-guide-for-ruby-5c3h <blockquote> <p>Note: This guide assumes you are using rubocop for linting and RSpec for testing</p> </blockquote> <p>Git hook scripts are useful for identifying simple issues before submission to code review. We run our hooks on every commit to automatically point out issues in code such as missing semicolons, trailing whitespace, and debug statements. By pointing these issues out before code review, this allows a code reviewer to focus on the architecture of a change while not wasting time with trivial style nitpicks.</p> <h2> Installation </h2> <p>Using homebrew:<br> </p> <div class="highlight js-code-highlight"> <pre class="highlight shell"><code>brew <span class="nb">install </span>pre-commit </code></pre> </div> <h2> Configuration </h2> <p>create a file named <code>.pre-commit-config.yaml</code> in your project root.<br> </p> <div class="highlight js-code-highlight"> <pre class="highlight yaml"><code><span class="na">repos</span><span class="pi">:</span> <span class="pi">-</span> <span class="na">repo</span><span class="pi">:</span> <span class="s">https://github.com/pre-commit/pre-commit-hooks</span> <span class="na">rev</span><span class="pi">:</span> <span class="s">v4.3.0</span> <span class="na">hooks</span><span class="pi">:</span> <span class="pi">-</span> <span class="na">id</span><span class="pi">:</span> <span class="s">trailing-whitespace</span> <span class="pi">-</span> <span class="na">id</span><span class="pi">:</span> <span class="s">end-of-file-fixer</span> <span class="pi">-</span> <span class="na">repo</span><span class="pi">:</span> <span class="s">https://github.com/mattlqx/pre-commit-ruby</span> <span class="na">rev</span><span class="pi">:</span> <span class="s">v1.3.5</span> <span class="na">hooks</span><span class="pi">:</span> <span class="pi">-</span> <span class="na">id</span><span class="pi">:</span> <span class="s">rubocop</span> <span class="pi">-</span> <span class="na">id</span><span class="pi">:</span> <span class="s">rspec</span> </code></pre> </div> <p>Updated configuration &amp; discussion thread is maintained on <a href="https://gist.github.com/jayeshmann/a2f562972c70678ee3479bb12c5d1c36">GitHub.</a></p> <h2> Install git hooks </h2> <div class="highlight js-code-highlight"> <pre class="highlight shell"><code>pre-commit <span class="nb">install</span> </code></pre> </div> <blockquote> <p>now pre-commit will run automatically on git commit</p> </blockquote> <h3> Run against all files </h3> <p>Pre-Commit will only run on changed files during git commit.</p> <p>In case you would like to run it on all the files:<br> </p> <div class="highlight js-code-highlight"> <pre class="highlight shell"><code>pre-commit run <span class="nt">--all-files</span> </code></pre> </div> <p>Feel free to config pre-commit according to your requirements.</p> <p><a href="https://pre-commit.com/hooks.html">Supported hooks</a></p> <p><a href="https://pre-commit.com/">Official Website</a></p> <p><a href="https://github.com/pre-commit/demo-repo#readme">Official Demo</a></p> <p>License: <a href="https://spdx.org/licenses/AGPL-3.0-or-later.html">AGPL-3.0-or-later</a></p> ruby inthirtyseconds Jayesh Mann Wed, 10 Aug 2022 17:42:00 +0000 https://dev.to/jayeshmann/rubocop-linting-quickstart-for-ruby-46b4 https://dev.to/jayeshmann/rubocop-linting-quickstart-for-ruby-46b4 <blockquote> <p>Knowledge Base: Lint, or a linter, is a static code analysis tool used to flag programming errors, bugs, stylistic errors and suspicious constructs.</p> </blockquote> <p>Make sure you have your ruby environment(check <a href="https://docs.rubocop.org/rubocop/compatibility.html">compatibility</a>) working before proceeding.</p> <h2> Installation </h2> <p>Simply run<br> </p> <div class="highlight js-code-highlight"> <pre class="highlight shell"><code>% gem <span class="nb">install </span>rubocop </code></pre> </div> <h2> Configuration </h2> <p>Create a <code>.rubocop.yml</code> file in your home(<code>% cd ~</code>) directory for all ruby projects. Alternatively, you can create it in your project directory.</p> <h3> Default Configuration </h3> <p><a href="https://github.com/rubocop/rubocop/blob/master/config/default.yml">Default Configuration</a></p> <h3> Recommended Configuration </h3> <p><a href="https://gist.github.com/jayeshmann/ebdfb33aa27dabc3bc2f5ff1b5f694dc">Jayesh's rubocop configuration</a></p> <h2> Usage </h2> <h3> Check </h3> <p>In your project's directory,<br> </p> <div class="highlight js-code-highlight"> <pre class="highlight shell"><code>% rubocop </code></pre> </div> <p>or you can specify a file or a directory of your choosing.<br> </p> <div class="highlight js-code-highlight"> <pre class="highlight shell"><code>% rubocop lib/file.rb spec/ </code></pre> </div> <blockquote> <p>If you don't have rubocop on your terminal, try <code>bundle exec rubocop</code></p> </blockquote> <h3> Correct </h3> <div class="highlight js-code-highlight"> <pre class="highlight shell"><code>% rubocop <span class="nt">-a</span> </code></pre> </div> <blockquote> <p>Knowledge Base: Only safe offenses will be fixed with <code>-a</code></p> </blockquote> <h2> Official Links </h2> <p><a href="https://rubocop.org/">Official Website</a></p> <p><a href="https://docs.rubocop.org/">Official Documentation</a></p> <p><a href="https://rubystyle.guide/">Community Ruby Style Guide</a></p> <h3> All rules </h3> <p>Here is the list of rules with their categories:<br> <a href="https://docs.rubocop.org/rubocop/cops.html">https://docs.rubocop.org/rubocop/cops.html</a></p> <h4> More Guides </h4> <p><a href="https://sourcelevel.io/blog/rubocop-how-to-install-and-configure">RuboCop: How to install and configure</a></p> <p><a href="https://gist.github.com/stungeye/10423491">Installing and Running Rubocop</a></p> <p>License: <a href="https://spdx.org/licenses/AGPL-3.0-or-later.html">AGPL-3.0-or-later</a></p> ruby inthirtyseconds