今どきのJavaScriptで使われているインデント規約まとめ

177
369
170

みなさんは普段JavaScriptを使って開発する場合、インデントはどのようにしていますか? タブ、スペース2個、スペース4個・・・などいくつかの選択肢があります。

個人で開発している方は問題ありませんが、チームで開発している場合は意見が分かれ議論になることもあるでしょう。プロジェクト開始早々インデント論争でチーム内の雰囲気を悪くしたくはありません。

本記事はそんなインデント論争の1つの解決策となるべく、ブラウザベンダーやプロダクトで定めているJavaScriptコーディングのインデントルールを調べてみました

この記事のポイント

  • 海外のJS界隈ではスペース2個のインデントが多数派
  • ESLINTなどの設定ファイルからコーディングルールを調べられる

なぜインデント論争が起こるのか?

そもそもなぜインデント論争が起こってしまうのでしょうか? それはそれぞれ一長一短のため好みが分かれてしまうからです。ここではインデントの種類毎のメリット・デメリットをご紹介します。

タブ

メリット

  • 開発者が自分好みにインデント幅が変えられる
  • インデント移動時のキータイプが少ない

デメリット

  • 位置揃えとして使用すると環境によって崩れる

スペース

メリット

  • 環境に左右されず同じ見た目でソースが表示される

デメリット

  • 同じスペース派内でもスペースの数で派閥が生まれる
  • インデント移動時のキータイプが多い

スペース派内の派閥

スペースのデメリットに挙げたように同じスペース派の中でもスペースをいくつ使うかで派閥が生じます。主に2個派、4個派、8個派のいずれかです。スペースが少ない場合は冗長にならずコードの折り返しが起こりにくく、スペースが多い場合は入れ子構造が把握しやすく可読性が高いといったそれぞれの長所があります。

JSコーディング規約のインデントルールを調べてみた

それでは世の中でどういった形のインデントが使用されているのか見ていくことにしましょう。

企業や組織のJSコーディング規約内のインデントルール

まずはブラウザベンダーを中心に、公開されているコーディング規約からインデントルールを抜粋し次の表にまとめました。

組織名 インデントルール コーディング規約ページ
Mozilla スペース2個 JavaScript style guide - Mozilla Developer Network
Google スペース2個 Google JavaScript Style Guide 和訳
WebKit スペース4個 WebKit Coding Style Guidelines

JSライブラリ/JSフレームワークのインデントルール

続いてJavaScriptのライブラリやフレームワークで採用されているインデントルールを次の表にまとめました。尚、インデントルールはJSHintESLintなどの構文チェックツールの設定ファイルから抜粋しています。

プロダクト名 インデントルール 設定ファイル
Node.js スペース2個 .eslintrc.yaml
React スペース2個 .eslintrc
Vue.js スペース2個 .eslintrc
Riot.js スペース2個 .eslintrc
Underscore.js スペース2個 .eslintrc
AngularJS スペース2個 .editorconfig
Ember.js スペース2個 .jscsrc
lodash スペース2個 .editorconfig
gulp スペース2個 .editorconfig
Pixi.js スペース2個 .editorconfig
Moment.js スペース4個 .editorconfig
Mithril.js タブ .eslintrc
jQuery スペース2個 .editorconfig

※ .jshintrc, .eslintrc, .jscsrcは構文チェックの設定ファイルです。
※ .editorconfigはEditorConfigという開発者間でエディターの設定を共有できるツールの設定ファイルです。
※執筆当時(2015年12月)はjQueryはタブ、Pixi.jsはスペース4個でしたが、現在(2017年8月現在)はスペース2個になっています

調査によるとインデントはスペース2個と定めている場合が多いようですね。

国内のインデント事情はタブが多数

インデント数について弊社池田がTwitterでアンケートを実施。このアンケートではプログラム言語を指定していないため、JavaScriptに限った回答ではありませんが、44%が「タブ」、33%が「スペース2つ」、23%が「スペース4つ」という結果になりました。筆者はタブのほうが合理的だと思うのですが、海外のJavaScriptコーディング規約とは異なる傾向であり、興味深いですね。

アンケートについて、詳しくは記事「HTMLコーダーへのアンケート結果(コードの書き方)」で紹介してますので、あわせて参考ください。本記事はJavaScript界隈のインデントルールをほんの一部まとめたものに過ぎませんが、みなさんのプロジェクトの規約作成の際に参考にしていただけたら幸いです。

※この記事が公開されたのは3年9ヶ月前ですが、 平成29年8月14日に内容をメンテナンスしています。