Skip to main content
Jump to: navigation, search

Difference between revisions of "MoDisco/CodingConventions"

(Add the checkstyle version)
Line 3: Line 3:
 
=== Eclipse JDT Warnings Level<br> ===
 
=== Eclipse JDT Warnings Level<br> ===
  
For code style verification, it is recommended to configure Eclipse JDT settings for errors/warning levels : all rules levels set as "ignored" should be set as "warning".<br>
+
For code style verification, it is recommended to configure Eclipse jdt settings for errors/warning levels : all rules levels set as "ignored" should be set as "warning".<br>
  
Some rules might create too many constraints on Java code in some circumstances. The developer is allowed to deactivate the rules in specific areas :<br>
+
Some rules might create too many constraints in some java circumstances. The developer is allowed to disactivate the rules in specific areas :<br>
  
 
- with projects specific errors/warning levels.<br>
 
- with projects specific errors/warning levels.<br>
  
- with @SuppressWarnings, adding some explanation to justify the deviation.<br>
+
- with @SuppressWarnings, in adding some explanation to the deviation.<br>
  
 
=== Checkstyle Usage  ===
 
=== Checkstyle Usage  ===
  
 
For MoDisco internal developments, the ''org.eclipse.gmt.modisco.dev.core'' project defines a MoDisco.checkstyle file.
 
For MoDisco internal developments, the ''org.eclipse.gmt.modisco.dev.core'' project defines a MoDisco.checkstyle file.
This file defines coding rules. It was initiated from the "Sun Checks (Eclipse)" default configuration. Some rules which were deemed too restrictive have been disabled.
+
This file defines coding rules. It was initiated from the "sun conventions for Eclipse" checkstyle file. Some constraining rules have been disabled.
  
 
This project is available in SVN: https://dev.eclipse.org/svnroot/modeling/org.eclipse.gmt.modisco/plugins/trunk/org.eclipse.gmt.modisco.dev.core/checkstyle/MoDisco.checkstyle
 
This project is available in SVN: https://dev.eclipse.org/svnroot/modeling/org.eclipse.gmt.modisco/plugins/trunk/org.eclipse.gmt.modisco.dev.core/checkstyle/MoDisco.checkstyle
  
 
For configuring a new IDE :
 
For configuring a new IDE :
* Install the [http://eclipse-cs.sourceforge.net/ Checkstyle plug-in] (<code>http://eclipse-cs.sf.net/update/</code>)
+
* Install the [http://eclipse-cs.sourceforge.net/ Checkstyle plug-in] (http://eclipse-cs.sf.net/update/)
 
** version 5.1.0
 
** version 5.1.0
  
*Each new MoDisco source project should have checkstyle enabled (context menu on the project, '''Checkstyle > Activate Checkstyle'''). Additional warnings are then computed on source code. A new builder is associated to the project.
+
* Go in ''Window > Preferences > Checkstyle'', and define a new global configuration of type 'Project Relative Configuration', pointing to the MoDisco.checkstyle file
  
*The <code>local-check-config</code> tag must be manually added to the .checkstyle file (see below) so that it points to the main checkstyle configuration file in <code>org.eclipse.gmt.modisco.dev.core</code>.
+
Then each new MoDisco source project should have this checkstyle file applied (popup menu, ''Checkstyle > Activate Checkstyle''). Additional warnings are then computed on source code. A new builder is associated to the project.
  
Here is an example checkstyle configuration file (.checkstyle). It ignores warnings on "Messages.java":
+
.checkstyle files are not required (except for local configuration explained below). Beware of not committing a useless .checkstyle because it references a specific checkstyle configuration name.
 +
 
 +
Some generated files (such as EMF generated files) do not comply with these rules. For such files, the warnings should be ignored, or the checkstyle may be deactivated for the whole EMF generated project.
 +
 
 +
==== Local configuration ====
 +
It is also possible to configure checkstyle on a project, thus removing the need to configure it at the workspace level.
 +
 
 +
Here is an example checkstyle configuration file (.checkstyle). It references the checkstyle configuration file in the "modisco.dev.core" project and ignores warnings on "Messages.java":
  
 
   <?xml version="1.0" encoding="UTF-8"?>
 
   <?xml version="1.0" encoding="UTF-8"?>
Line 36: Line 43:
 
     </fileset>
 
     </fileset>
 
   </fileset-config>
 
   </fileset-config>
 
* Some generated files (such as EMF generated files) do not comply with the rules. For such files, the warnings can be ignored by selecting the package in section "Exclude from checking" in the checkstyle properties on the project, or checkstyle may be deactivated for the whole EMF generated project.
 
  
 
Reference:
 
Reference:
 
http://robertmarkbramprogrammer.blogspot.com/2007/07/eclipse-checkstyle-for-new-project.html
 
http://robertmarkbramprogrammer.blogspot.com/2007/07/eclipse-checkstyle-for-new-project.html
  
==== IP status ====
+
==== Checkstyle is not an Eclipse.org tool ====
  
 
Note that Checkstyle is not an Eclipse.org tool. However, its source code is under the EPL, and its current use has been formally IP-validated for the MoDisco project:  
 
Note that Checkstyle is not an Eclipse.org tool. However, its source code is under the EPL, and its current use has been formally IP-validated for the MoDisco project:  

Revision as of 06:38, 17 March 2010


Eclipse JDT Warnings Level

For code style verification, it is recommended to configure Eclipse jdt settings for errors/warning levels : all rules levels set as "ignored" should be set as "warning".

Some rules might create too many constraints in some java circumstances. The developer is allowed to disactivate the rules in specific areas :

- with projects specific errors/warning levels.

- with @SuppressWarnings, in adding some explanation to the deviation.

Checkstyle Usage

For MoDisco internal developments, the org.eclipse.gmt.modisco.dev.core project defines a MoDisco.checkstyle file. This file defines coding rules. It was initiated from the "sun conventions for Eclipse" checkstyle file. Some constraining rules have been disabled.

This project is available in SVN: https://dev.eclipse.org/svnroot/modeling/org.eclipse.gmt.modisco/plugins/trunk/org.eclipse.gmt.modisco.dev.core/checkstyle/MoDisco.checkstyle

For configuring a new IDE :

  • Go in Window > Preferences > Checkstyle, and define a new global configuration of type 'Project Relative Configuration', pointing to the MoDisco.checkstyle file

Then each new MoDisco source project should have this checkstyle file applied (popup menu, Checkstyle > Activate Checkstyle). Additional warnings are then computed on source code. A new builder is associated to the project.

.checkstyle files are not required (except for local configuration explained below). Beware of not committing a useless .checkstyle because it references a specific checkstyle configuration name.

Some generated files (such as EMF generated files) do not comply with these rules. For such files, the warnings should be ignored, or the checkstyle may be deactivated for the whole EMF generated project.

Local configuration

It is also possible to configure checkstyle on a project, thus removing the need to configure it at the workspace level.

Here is an example checkstyle configuration file (.checkstyle). It references the checkstyle configuration file in the "modisco.dev.core" project and ignores warnings on "Messages.java":

 <?xml version="1.0" encoding="UTF-8"?>
 <fileset-config file-format-version="1.2.0" simple-config="true">
   <local-check-config name="MoDisco" location="../org.eclipse.gmt.modisco.dev.core/checkstyle/MoDisco.checkstyle" type="project" description=""/>
   <fileset name="all" enabled="true" check-config-name="MoDisco" local="true">
     <file-match-pattern match-pattern="." include-pattern="true"/>
     <file-match-pattern match-pattern="Messages.java" include-pattern="false"/>
   </fileset>
 </fileset-config>

Reference: http://robertmarkbramprogrammer.blogspot.com/2007/07/eclipse-checkstyle-for-new-project.html

Checkstyle is not an Eclipse.org tool

Note that Checkstyle is not an Eclipse.org tool. However, its source code is under the EPL, and its current use has been formally IP-validated for the MoDisco project:

Also note that Checkstyle is not intended to be distributed with MoDisco.

Back to the top