ITエンジニア/デザイナ向けにオープンソースを毎日紹介

汚いコードは読みづらいですよね。行の折り返しをどこにするか、空の行の使い方などでぐっと可読性はあがってきます。そうした書き方も慣れてくると経験で分かってくるのですが、最初はなかなか難しいものです。

そこで使ってみたいのが機械的にコードを読みやすくしてくれるソフトウェアです。今回はRubyのコード整形ソフトウェア、RBeautifyを紹介します。

RBeautifyの使い方

インストールは Rubygemsで簡単にできます。

$ gem install ruby-beautify

後は

rbeautify
で使えます。

$ rbeautify filename

そうすると奇麗になったコードが出力できます。例えば整形後で比べることもできます。

235,236c235,236
< @article.comments.all(:order => "comment_type, comment_date desc", 
< :conditions => ["comment_approved = ? and comment_type like ?", "1", "feedbackbypar%"]).each do |comment|
---
>     @article.comments.all(:order => "comment_type, comment_date desc",
>     :conditions => ["comment_approved = ? and comment_type like ?", "1", "feedbackbypar%"]).each do |comment|

例えばこんな感じに違いが出ます。オプションは特になく、複数のファイルを同時に渡すこともできます。

自分のコードと奇麗なコードの違いが分かれば、より読みやすいコードを書くのが容易になるでしょう。プロジェクト全体で使ってみても面白そうですね。

RBeautifyはRuby製、MIT Licenseのオープンソース・ソフトウェアです。

erniebrodeur/ruby-beautify

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2