[Ruby on Rails] Codeprüfung mit Rubocop-Airbnb

Entwicklungsumgebung

ruby 2.5.7 Rails 5.2.4.3 OS: macOS Catalina

Was ist RuboCop?

RuboCop ist ein statisches Code-Analyse-Tool, das prüft, ob Ruby-Code "gemäß Codierungsstandards geschrieben" ist.

Was ist Rubocop-Airbnb?

Dies ist eine Analyse, die von Airbnb erstellt wurde. Dieses Mal werden wir diese verwenden, um den Code zu überprüfen. Git ist wie folgt. https://github.com/airbnb/ruby/tree/master/rubocop-airbnb

Installation von "Rubocop-Airbnb"

Fügen Sie wie unten hinzu.

Gemfile

group :development do

...

  gem 'rubocop-airbnb'
end

Terminal

$ bundle install

Konfigurationsdatei erstellen

Unter dem Anwendungsordner Erstellen Sie die Dateien ".rubocop.yml" und ".rubocop_airbnb.yml". Geben Sie beim Erstellen dieser Dateien und Ordner an, für die Sie den Code nicht mit rubocop analysieren möchten.

• Geben Sie unbedingt das "." In den erforderlichen Dateinamen ein.

:.rubocop.yml

inherit_from:
  - .rubocop_airbnb.yml

AllCops:
  Exclude:
    - 'db/**/*'
    - 'bin/*'
    - 'config/environments/*'
    - 'config/application.rb'
    - 'config/initializers/*'
    - 'config/spring.rb'
    - 'lib/tasks/*'
    - 'vendor/**/*'
    - 'path/ruby'

:.rubocop_airbnb.yml

require:
  - rubocop-airbnb

Überprüfen Sie den Code mit Rubocop

Wechseln Sie im Terminal zum Anwendungsordner und führen Sie die folgenden Schritte aus.

Terminal

$ bundle exec rubocop --require rubocop-airbnb

...

50 files inspected, 150 offenses detected

Es wird so angezeigt. Dies bedeutet, dass wir 50 Dateien überprüft und 150 Codierungsverletzungen festgestellt haben. Wenn die Anzahl so groß wird, ist es schwierig, jede einzelne zu überprüfen. Führen Sie daher die folgenden Schritte aus.

Terminal

$ bundle exec rubocop --require rubocop-airbnb -a

...

50 files inspected, 150 offenses detected, 150 offenses corrected

Er hat alle 150 auf diese Weise repariert. Ist die Korrektur immer noch nicht möglich, wird sie visuell überprüft.

Zusammenfassung

Auf diese Weise können Sie den Code einfach automatisch ändern. Es ist sehr praktisch, also benutzen Sie es bitte.

Auf Twitter werden auch Technologien und Ideen hochgeladen, die nicht auf Qiita hochgeladen wurden Ich wäre Ihnen dankbar, wenn Sie mir folgen könnten. Klicken Sie hier für Details https://twitter.com/japwork