SonarLint Eclipse Plugin

Building

mvn clean verify

Development setup in Eclipse

Install m2eclipse and then Tycho extension to m2eclipse:

1. Window -> Preferences -> Maven -> Discovery -> Open Catalog
2. Install Tycho Configurator
3. Import everything as Maven project
4. Run mvn compile on the command line to fetch artifacts referenced in the parent pom
5. Open target-platform-e46-dev.target
   • Click on Environment tab and add M2_REPO variable pointing to your local maven repo (for example /home/youruser/.m2/repository)
   • On the Definitions tab, if there are problems with the Locations entries, click Reload
   • Click Set as Target Platform in the top-right corner
6. Run mvn compile on the command line to generate and compile protobuf classes

Eclipse quirks

Strange issues in Eclipse and their remedies.

• Sometimes, for no apparent reason, the generated protobuf classes may disappear, and Eclipse may report compilation errors when resolving these class names, symbols. The workaround is to run mvn compile and refresh the views in Eclipse (click on the project and press F5).

Running

Open plugin.xml of org.sonarline.eclipse.core (for example), and see the Run and Debug buttons in the top-right corner.

Running tests

In Eclipse:

1. Create a run configuration by running a test class first with Run As... / JUnit Plug-in Test

2. Edit the configuration

   • On the Test tab, uncheck Run in UI thread
   • On the Main tab, under Program to Run, select Run an application with value [No Application] - Headless Mode

With Maven:

mvn clean verify

Adding a dependency

Must be osgi bundle.

For Maven

Add the artifact to the parent pom.

Run mvn compile to get the artifact downloaded so that you can inspect its manifest in the jar.

Find the name of the bundle from its manifest, see the Bundle-SymbolicName property.

Edit the manifest of the package where you want to add the dependency (for example: org.sonarlint.eclipse.core/META-INF/MANIFEST.MF), add the bundle in the Require-Bundle property, using its symbolic name.

If the bundle is not needed at runtime, don't forget to mark it optional, to avoid including in the package. (Edit properties on the Dependencies tab, or append ;resolution:=optional)

To verify the content of the package: mvn clean package and check content of the ZIP in plugins folder.

For Eclipse

Add to target-platform-e46/target-platform-e46-dev.target (or whatever target you use) the path of the artifact in your local maven repository as a filesystem path, similar to already existing dependencies.

In the target editor (or open plugin.xml), click Set as Target Platform. Note that this will trigger a compilation in Eclipse.

At this point, and if the artifact exists at the specified path, it should be usable, and Eclipse will be able to compile the project.