standardで手軽にコーディング規約を導入する

コーディングスタイルの一貫性はコードを可読性を保つのに重要だけど、導入しようとなるとけっこう大変。

• コーディングスタイルを選ぶ
  • 公開されてるコーディング規約を眺めたりする
  • 自分の好みにあわせて"最強のコーディング規約"をつくったりする
• 自動化のためにツールの設定を書く
  • ドキュメントを睨んで設定ファイルを修正したりする
• 既存のコードをできたコーディングスタイルになおす
  • めんどくさいから放置したりする

standard

standardを使えばこういうめんどくさいことなしに、お手軽にコーディング規約を導入できる。
"標準的"なコーディングスタイルがはじめから設定されているので設定を考える必要が一切ない。

だいたい、インデントの深さとか空白の数の良し悪しについて議論するのは不毛である。もっと生産的なことに時間を使いたい。

stardardに組み込まれてるスタイルは、npmに近い、モダンなコーディングスタイルである。セミコロンフリーなのが特徴。

使いかたもシンプルで、standardコマンドを実行するだけ。

$ standard
Error: Use JavaScript Standard Style
  lib/torrent.js:950:11: Expected '===' and instead saw '=='.

こういう風に package.jsonに書いておくと、npm testで実行される。あとはTravisなどのCIで設定しておけばコーディングスタイルのチェックを自動化できる。

{
  "name": "my-cool-package",
  "devDependencies": {
    "standard": "^3.0.0"
  },
  "scripts": {
    "test": "standard && node my-tests.js"
  }
}