Code Formatting and CheckStyle

Owned by Former user (Deleted)
Last updated: Apr 09, 2014Version comment
1 min read

Introduction

Pentaho enforces coding standards and style through the CheckStyle project ( http://checkstyle.sf.net ). Our CheckStyle template and installation instructions are located up on GitHub at: https://github.com/pentaho/pentaho-coding-standards

The following is taken from the pentaho-coding-standards repository:

CheckStyle will soon be integrated into our build system. Until that time, you'll need to configure your IDE using the instructions below to to ensure your contributions conform to the standard.

Installation (Eclipse):
  1. Install CheckStyle plugin http://eclipse-cs.sf.net/update/
  2. Clone the https://github.com/pentaho/pentaho-coding-standards to your machine.
  3. Configure the plugin to use the pentaho_checkStyle.xml
  4. Configure the Eclipse Code Formatter to use the attached pentaho_formatter.xml
  5. The Eclipse CheckStyle plugin documentation my be helpful: http://eclipse-cs.sourceforge.net
Installation (IntelliJ):
  1. Install the CheckStyle-IDEA plugin. (available in the default public repository)
  2. Clone the https://github.com/pentaho/pentaho-coding-standards to your machine.
  3. Configure the CheckStyle-IDEA with pentaho_checkStyle.xml.
  4. Copy the codeStyleSettings.xml into your IntelliJ project folder ( IdeaIntelliJProjectFolder/.idea/codeStyleSettings.xml). Overwrite if it's already there.
  5. Open IntelliJ, set the Project Settings -> Code Style -> Scheme to "Project"

Additional Information

Learn how to suppress CheckStyle modules for select areas: CheckStyle Tips