svn commitする前にvar_dump, console.logが含まれてないかチェックするスクリプトをPHPで書いてみた

開発中にデバッグするために変数を出力する関数をプログラムに直接書きこむことがある。PHPであればvar_dump()、JavaScriptであれば、console.log()などがその関数になる。これらのプログラムに記述したデバッグ用のコードは、デバッグコードと呼ばれる。

プロジェクトを複数人で共有している場合、デバッグコードを書いたとしても、メンバーと共有する場合は消しておくことが必要だ。仕事でのプロジェクトであれば、デバッグコードによる余計な出力やプロセスの終了は不具合として扱われることになる。

自分も仕事でデバッグコードを書いて、それをそのままSubversionのリポジトリに上げてしまっていたので、svn commitする手前でvar_dump, console.logが含まれてないかチェックするスクリプトを作ってみた。

できたもの: svn-commit

• 開発環境がMacOSXなので、Macで動く。
• ターミナルから使うので、コマンドラインインターフェイス。
• どうせなのでPHPで書いてみた。
• svn commitコマンドの感覚で使える。
• ついでに、コミットコメントもいれやすい感じにしてみる。svn ci -m ""とかエディタの設定とかめんどくさいって人なので。

使い方

• svn-commitをダウンロード
• PATHの通っているところにsvn-commitをおく。
• svn-commitに実行権限を与えておく。
• あとは、svn ciをするかわりにsvn-commitを実行するだけ。