読者です 読者をやめる 読者になる 読者になる

SideCI Blog

自動コードレビューサービスSideCIを提供している株式会社アクトキャットのコーポレートブログです。



【アナウンス】SideCI内での各ツールのデフォルト設定の変更

SideCIをより気軽にお使い頂けるよう、各解析ツールでのデフォルトの挙動を一部変更いたします。
この変更は11月4日より適用されます。

対象ユーザ

下記記載の条件にあてはまるユーザ様・プロジェクトが対象になります。

  • rubocop.yml などの各ツールの設定ファイルをリポジトリ内に配置していない方

対象ツール

対象となる解析ツールは下記のとおりです。

  • rubocop
  • reek
  • JSHint
  • rails_best_practices

それぞれのツールに適用される新しい設定値については以下のリンク内のsideci_confignameといった名前のファイルになります。
GitHub - actcat/sideci_config: SideCI Linter Configuration Files

必要な対応

ツールのデフォルトでの設定値でご利用頂きたい方はツールのデフォルト設定値が記載されたファイルをリポジトリ内に配備下さい。SideCIの推奨設定をご利用になりたい方や、既にご自身でカスタマイズされていらっしゃる方は必要な対応はございません。

ツールのデフォルト設定値についても先に記載したリポジトリにも配置しておりますでの、必要でしたらご利用下さい。

各ツールでの設定値の変更概要

各ツールの変更内容の概要は下記のとおりです。

RuboCop

RuboCopでは下記の変更が適用されます。

  • Excludeへのrailsの自動生成系のディレクトリの追加

詳細は下記の設定ファイルを御覧ください。[sideci] と記載のある行が変更行になります。
https://raw.githubusercontent.com/actcat/sideci_config/master/ruby/rubocop/sideci_rubocop.yml

reek

Reekでは下記の変更が適用されます。

  • exclude_pathsへのrailsの自動生成系のディレクトリの追加
  • ネスト数などのルールの緩和

詳細は下記の設定ファイルを御覧ください。[sideci] と記載のある行が変更行になります。
https://raw.githubusercontent.com/actcat/sideci_config/master/ruby/reek/sideci_config.reek

JSHint

JSHintでは下記の変更が適用されます。

  • browser, JQueryの変数オプションの有効化
  • いくつかの設定ルールの緩和(無効化)
  • minimizeされたjavascript等の無効化

詳細は下記の設定ファイルを御覧ください。

また、上記は下記記事に記載のおすすめ設定と同じ設定になっております。

JavaScript用lintツール、JSHintとそのおすすめ設定(jshintrc, jshintignore) for Rails, PHP - SideCI Blog

Rails Best Practices

Rails Best Practicesでは下記の4つのルールが無効化されます。
RemoveTrailingWhitespaceCheck, RemoveUnusedMethodsInControllersCheck, RemoveUnusedMethodsInHelpersCheck, RemoveUnusedMethodsInModelsCheck

ただし、Rails Best Practicesでは以前よりこの設定にて提供しておりましたので、多くのユーザ様に影響はございません。
詳細は下記の設定ファイルを御覧ください。[sideci] と記載のある行が変更行になります。
https://raw.githubusercontent.com/actcat/sideci_config/master/ruby/rails_best_practices/sideci_rails_best_practices.yml

補足

その他の提供中のツールにつきましても現在設定値を作成中です。完成次第都度アナウンスさせて頂きます。
また、SideCIとしてのおすすめ設定については今後も変更の可能性がございます。もしよろしければみなさまのおすすめの設定をご共有頂けますと幸いです。

引き続きのご利用や、今からのご利用をお待ちしております。

www.sideci.com