Mobile/Fennec/Android/Static analysis/checkstyle-idea

From MozillaWiki
Jump to: navigation, search

You can run checkstyle via the checkstyle-idea plugin within Android Studio or Intellij. It will highlight violations in red, e.g. package statements should not span more than one line:

Example of checkstyle-idea failure

Installation

  • Open the preferences
  • Find "Plugins" in the preferences
  • Click "Browse repositories"
  • Search for "checkstyle".
  • Select CheckStyle-IDEA
  • Click "Install plugin" on the right & confirm
  • Click restart Android Studio

Adding the config file

  • Open the preferences
  • Go to (or search for) "Checkstyle" menu item (it's under "Other Settings")
  • Click the plus at the bottom of the "Configuration file" box
  • Add a description (e.g. "mozilla")
  • Add the path to the checkstyle configuration: 
    http://mxr.mozilla.org/mozilla-central/source/mobile/android/app/checkstyle.xml?raw=1
  • Accept
  • Click the "Active" checkbox next to the new configuration
  • Hit "OK" to close the preferences
Retrieved from "https://wiki.mozilla.org/index.php?title=Mobile/Fennec/Android/Static_analysis/checkstyle-idea&oldid=1130536"