[rubocop]　インデントを揃えるgem【初学者おすすめgem】

2794 ワード
RuboCop Gem インデント Rails Rails テキストリンク

概要

今回は効率よくインデントを揃えるgemの紹介をします。

プログラミングを学習してはや６ヶ月経ちました。
少しづつ転職も始め、ある企業様から私のgitをみてインデントがオカシイと非常にありがたいフィードバックを頂きました。
そこで第三者からみてコードの読みやすさの大切さに改めて気づきました。

こんな人に読んでほしい！！

  • 現在、プログラミングを独学またはプログラミングスクールで学び、転職しよう！って思っている方。
  • インデントを効率よく揃える方法を知りたい！って思っている方。
  • 綺麗なコードを書きたい！って方。

綺麗なコードを書く重要性

エンジニアとして働くにあたり、
他の人が読みやすいコードを意識する必要性があると思いました。

理由

（１）プロダクトの共同開発
（２）万が一、担当から外る or 担当のメンバーが増えた際に、プロダクトのスムーズな引き継ぎ
（３）バクが起きた際に、可読性が高いと解決できるスピードが早まる

※あくまで私が思い浮かんだ理由をあげました。もしかしたら他にも理由があるかも知れません。

以上の理由から、現場に入った後を考えると、他の人が読みやすいコードが重要性を増します。
今回は他の人が読みやすいコードにするための１つとして「インデントを揃える」をピックアップしました。

rubocupとは？

RuboCopは、あなたのプロジェクトのrubyコードが「コーディング規約どおりに書かれているか」をチェックする静的コード解析ツールです。
その１つの機能として、インデントを揃えてくれます。

使い方

導入

gemfile.
group :development do
  gem 'rubocop', require: false #追記
end

gemファイルのdevelopmentにgem 'rubocop', require: falseを追記します。

その後にターミナルで
$ rails bundle installを忘れずにします。

インデントを揃えよう

ターミナルで
$ rubocop 修正したいファイル名をすると自動修正されます。
【例】　$ rubocop sample.html.erb
これで修正されたと思います。
実行するとこのような感じで出ると思います。

出てきた内容を見ると、
[Corrected] Layout/IndentationWidth: Use 2 (not 4) spaces for indentation.
インデントを４つではなくて２つに修正しました。
こんな感じで実行後には、実行した内容を書いてくれてます。

rubocopは「ある程度」まで修正できます。どういう風に修正したらいいのかわからない場合はスキップされるみたいです。

参考URL

RuboCopをRailsオプションやLintオプションで使ってみよう
公式ドキュメント
【初心者向け】Railsの品質を上げるRuboCopのインストールと使い方！

最後に

まだまだ勉強不足なところがありますので、
アップデートできた知識は追加で記載していきます。

もし、何か修正点とかございましたらコメント等
大変恐縮ですが、宜しくおねがいします。