Project

rubocop-sensei

0.0
Bugfix fork ofapiotics
The project is in a healthy, maintained state
rubocop-senseiigaiga/rubocop-senseiHomepageDocumentationSource CodeBug TrackerWiki
.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,707
Stars
6
Forks
0
Watchers
1
 Releases
Current version
0.1.7
Total releases
8
First release
2022-12-30
Latest release
2023-10-25
 Development
Primary Language
Ruby
Average date of last 50 commits
2023-05-18
Reverse Dependencies
0

 Dependencies

Runtime

rubocop
>= 0
typeprof
>= 0
 Project Readme

RuboSensei

  • RuboSensei は書いたRuby/Railsコードに対して、より良い書き方を教えてくれるツールです
  • RuboCop Gem の仕組みをつかっています
  • rubocopコマンドで良い書き方のアドバイスが表示されます
  • RuboCop に標準で入っているLSPをつかうとエディタ上で書いたコードのそばに表示できます

demo demo

実装されているアドバイス

つかい方

インストール

  • Gemfile に以下を追加します
gem "rubocop"
gem "rubocop-sensei"
  • RailsアプリのGemfileでは次のようにdevelopment環境へ追加します
group :development do
  gem "rubocop", require: false
  gem "rubocop-sensei", require: false
end

  • bundle installを実行します

    • $ bundle install

  • .rubocop.yml へ以下を追加します

require:
  - rubocop-sensei

Lecture:
  Enabled: true

rubocopコマンドからつかう

  • rubocop コマンドを実行します

    • $ bundle exec rubocop

  • rubocop コマンドに --autocorrect オプションを渡すと、対応している項目は自動修正も行います

    • $ bundle exec rubocop --autocorrect

  • 実行結果例

app/models/book.rb:12:5: C: Lecture/PreferMap: このeachメソッドはmapメソッドで置き換えられるかもしれません。

    array.each do |x| ...
    ^^^^^^^^^^^^^^^^^

VSCode で書いているコード上にアドバイスする

  • VSCode で書いているコード上でリアルタイムにアドバイスを表示できます
    • RuboCopに標準で入っているLSP機能と、VSCode拡張 vscode-rubocop をつかいます
  • VSCode拡張 vscode-rubocop をVSCodeへインストールして有効にします
  • rubocopコマンドが実行可能になっていれば、自動でRuboCopを実行して結果を表示します
    • 手動でLSPを起動するコマンドを実行する必要はありません

.rubocop.yml の書き方例

  • RuboSenseiのアドバイスはLectureカテゴリとしてまとめられています

プロジェクトの.rubocop.ymlがないとき

  • たとえば次のような内容で作成します
  • RuboCopデフォルトの検査のうちStyle, LintカテゴリだけをONにして、RuboSenseiのアドバイス(Lectureカテゴリ)をONにするときの.rubocop.ymlの例
AllCops:
  NewCops: enable
  SuggestExtensions: false

require:
  - rubocop-sensei

Style:
  Enabled: true

Lint:
  Enabled: true

Lecture:
  Enabled: true
  • RuboCopデフォルトの検査をオフにしてRuboSenseiのアドバイス(Lectureカテゴリ)をONにするときの.rubocop.ymlの例
AllCops:
  DisabledByDefault: true

require:
  - rubocop-sensei

Lecture:
  Enabled: true

Lecture/ReplaceElsif:
  Enabled: true

プロジェクトの.rubocop.ymlがあるとき

  • require設定に rubocop-sensei を追加します
require:
  - rubocop-sensei
  • カテゴリ設定に Lecture を有効にする設定を追加します
Lecture:
  Enabled: true

アドバイスを非表示にするとき

  • RuboSenseiのアドバイス表示時に書かれている名前を指定してEnabled: false設定を追記します
Lecture:
  Enabled: true

Lecture/ReplaceElsif:
  Enabled: false
  • 全アドバイスをオフにするときはLectureカテゴリをEnabled: falseにします
    • または、Lectureカテゴリの設定を削除します
Lecture:
  Enabled: false

License