Mobile/Fennec/Android/Static analysis/checkstyle-idea: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
Line 4: Line 4:


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


=== Adding the config file ===
=== Adding the config file ===
# Click the "+" in the Configuration File box
* Click the "+" in the Configuration File box
# Open the preferences
* Open the preferences
# Go to (or search for) "Checkstyle" menu item (it's under "Other Settings")
* Go to (or search for) "Checkstyle" menu item (it's under "Other Settings")
TODO: can we do this by code?
* Click the plus at the bottom of the "Configuration file" box
http://mxr.mozilla.org/mozilla-central/source/mobile/android/app/checkstyle.xml
* Add a description (e.g. "mozilla")
* Add the path to the checkstyle configuration: <pre>http://mxr.mozilla.org/mozilla-central/source/mobile/android/app/checkstyle.xml</pre>
* Accept
* Click the "Active" checkbox next to the new configuration
* Hit "OK" to close the preferences

Revision as of 22:20, 11 April 2016

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

  • Click the "+" in the Configuration File box
  • 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
  • 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=1127055"