piyapsri/sonar-developer-toolset

Developer Toolset for Sonar-* Projects

Developer Toolset for Sonar-* Projects

Toolset for the developers contributing to http://github.com/SonarSource and http://github.com/SonarCommunity repositories.

Git

If you have never used Git before, you need to do some setup first. Run the following commands so that Git knows your name and email.

git config --global user.name "Your Name"
git config --global user.email "[email protected]"

Setup line endings preferences:

# For Unix/Mac users
git config --global core.autocrlf input
git config --global core.safecrlf true

# For Windows users
git config --global core.autocrlf true
git config --global core.safecrlf true

The merge is working pretty well on small repositories (with move and rename of files). But it's not working on large repositories as the detection of file renaming is O(n²), so we need to update some threshold (more explanations are available in this post : http://blogs.atlassian.com/2011/10/confluence_git_rename_merge_oh_my/) :

git config --global merge.renameLimit 10000

Commit messages

Commits must relate to a JIRA issue. Convention for messages inspired by http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html :

• The first line should be short (72 chars or less) and auto-descriptive in a format " ", for example "SONAR-1937 Code review"
• Write your commit message in present imperative tense: "Fix bug" and not "Fixed bug".
• The second line is blank.
• Next lines optionally define a short summary of changes (wrap them to about 72 chars or so).

Example :

SONAR-2204,SONAR-2259 Fix URL encoding

* For correct URL encoding we must encode parameters on lower level -
in Query itself, but not in concrete implementation of Connector,
because in Query we can distinguish concrete parts of URL.

* Moreover in this case any additional encoding routines in Connector
are useless, so were removed.

If the change concerns a documentation-only change, then prefix it with "DOC ".

The (Almost) Unbreakable Build

To be sure that code changes do not break the build in master branch, the spush command can be executed to push commits. It's especially useful when many people work on the same codebase.

# To be executed in the root directory of the Git repository
spush

Codebase is forked, built then committed changes are pushed to the remote branch if the build passes. Forking in another directory allows developer to continue working and editing code in his workspace.

Build automatically executes the script build.sh if it exists, else it executes mvn clean install

Eclipse Configuration

Eclipse settings are available in the directory /eclipse.

Imports

sonar-formatter.xml: positions new lines, comments, spaces, parentheses, etc. To be imported in Window > Preferences > Java > Code Style > Formatter.

sonar.importorder: organizes the "import" lines. To be imported in Window > Preferences > Java > Code Style > Organize Imports.

sonar-cleanup.xml: cleans up the code, by organizing imports, formating source code, correcting indentation, etc. To be imported in Window > Preferences > Java > Code Style > Clean Up. If additionally you want to perform clean up at every "save" action, check the checkboxes in Window > Preferences > Java > Editor > Save Actions.

junit-templates.xml (optional): defines shortcuts "temp" and "thrown" in the unit tests. To be imported in Window > Preferences > Java > Editor > Template.

Additional Configuration

In Window > Preferences > Maven > Errors/Warnings, set "Plugin execution not covered by lifecycle execution" to "Ignore". This will silence out error messages when importing your Maven projects

On Windows, in Window > Preferences > General > Workspace, set "Text file encoding" to "UTF-8" and "New text file line delimiter" to "Unix".

In order to use the Maven Eclipse integration, you should download the os-maven-plugin and install it as an eclipse plugin (for example by putting it into your eclipse/plugins folder). The download link and installation steps are descriped in the os-maven-plugin readme.

Code Style Configuration for Intellij

Intellij IDEA users must install the plugin Eclipse Code Formatter and import Eclipse settings files:

• check the "Use the Eclipse code formatter" option and use sonar-formatter.xml as the Eclipse Java Formatter config file
• check the "From file" option in the "Import order" section and use sonar.importorder

Go to Preferences > Editor > General and check the option Ensure line feed at file end on Save (under the Other section).

Go to Preferences > Editor > Code Style > Java > Wrapping and Braces > Method declaration parameter and uncheck Align when multiline

Go to Preferences > Editor > Code Style > Java > Tabs and Indents and update:

• Tab size: 2
• Indent: 2
• Continuation indent: 2

Go to Preferences > Editor > Code Style > XML > Tabs and Indents and update:

• Tab size: 2
• Indent: 2
• Continuation indent: 2

Then go to Preferences > Editor > Code Style > XML > Other and set/check:

• Hard wrap at 140
• Keep line breaks in text
• Keep white spaces

IDEA must also be manually configured for imports : Preferences > Editor > Code Style > Java > Imports

• Class count to use import with '*'" -> 999
• Names count to use static import with '*' -> 999
• Import Layout
  • import all other imports
  • <blank line>
  • import static all other imports

Eclipse 4.4 formatter support must not be enable in order to use recent versions of the Eclipse Code Formatter plugin (at least 4.5.1):