Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 16 Next »


To create a Sonar plugin, you need Java 5 or later. Maven is not required to build sources but it is highly recommended. Moreover this guide uses Maven to create and compile sources.

Creating a new plugin

Use the following command to create a new plugin in the directory defined by the parameter <pluginArtifactId> :

Parameters are :

  • <archetypeId> can either be 'sonar-basic-plugin-archetype' for a vanilla plugin or 'sonar-gwt-plugin-archetype' for a plugin with Google Web Toolkit extensions.
  • <sonarVersion> is the minimum version required to install the plugin, for example '2.2'.
  • <pluginGroupId> is the Maven group id of the plugin, for example 'com.mycompany.sonar.mysonarplugin'
  • <pluginArtifactId> is the Maven artifact id of the plugin, for example 'mysonarplugin'
  • <pluginVersion> is the plugin initial version, for example '0.1-SNAPSHOT'
  • <pluginPackage> is the root package, for example 'com.mycompany.sonar.myplugin'

Example :

Building sources

Go to the project directory and execute :

The JAR file is generated in the directory target/.

Installing the plugin

It's really simple : copy the generated JAR file in the directory extensions/plugins/ of Sonar then restart the server.

Next step is: coding the plugin.

  • No labels