Development Guide

Checkstyle

Checkstyle

The checkstyle target "phpcs" generates an xml-file that holds information on code-style issues.
Here's how to set it up.

Prerequisite is, that your build includes the "phpcs" target, which writes a file build/logs/checkstyle.xml

This is what the report looks like:

12 Apr 2014 MB: The build contains a configuration on the checks that are made in this build step. Currently, a very limited rulest is in place.
  • Unused Function Parameters
  • Todo Comments
  • Inline Control Structures
  • Line Length
  • Line Endings
  • Multiple Statement Alignment
  • Double Quote Usage
The ruleset to be checked is subject to further development since the build would otherwise warn on irrelevant things for the ILIAS project.