Edited at

Code Climateで特定ファイルを解析対象から除外する

More than 3 years have passed since last update.

Node.jsでとあるサービスのSDKを書いた際に、browserifyしたファイルをリポジトリに入れたらCode ClimateのGPAが大変なことになったので、特定ファイルを解析から除外する方法を調べてみました。

(ちなみに)

とあるサービス→ニフティクラウド mobile backend

リポジトリ→NIFTYCloud-mbaas/ncmb_js

cc_before.png

全体が2000行程度のSDKなのにbrowserifyした生成物は24810行で評価F(0点換算)…。GPAも0.2まで低下。


設定ファイルの作成

Code Climate自体は設定ファイルなしでも利用可能ですが、詳細設定を.codeclimate.ymlに記述することができます。

今回は「ncmb.min.js」を解析から除外したいので、以下のようにexclude_pathsに該当ファイルを記述します。

.codeclimate.yml

languages:

JavaScript: true
exclude_paths:
- "ncmb.min.js"

その後.codeclimate.ymlを追加してプッシュすれば、設定が反映されていることが確認できます。



指定したファイルが除外されてGPAもまともな値に回復しました!

cc_after.png

また、正規表現でディレクトリごと除外するような設定ももちろん可能です。

その他設定ファイルの使い方は公式ドキュメント(英語)に記述があるので、そちらを確認してみてください。

Using a .codeclimate.yml File

以上です。

--

今回の内容を実践したリポジトリはこちら

NIFTYCloud-mbaas/ncmb_js

↑のSDKを利用するサービスの宣伝

ニフティクラウド mobile backend