Code Monkey home page Code Monkey logo

sonarlint-eclipse's Introduction

SonarLint for Eclipse

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-e47-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 Definition tab, if there are problems with the Locations entries, click Reload
    • Click Set as Target Platform in the top-right corner

At this point you should be all set, unless Eclipse is not able to generate protobuf sources. Following the explanations here may help. As a workaround, you can run mvn compile on the command line to generate protobuf sources, and in Eclipse hit F5 on the project with build errors.

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.

License

Copyright 2015-2017 SonarSource.

Licensed under the GNU Lesser General Public License, Version 3.0

sonarlint-eclipse's People

Contributors

bellingard avatar dbmeneses avatar dgageot avatar drautureau-sonarsource avatar ehartmann avatar godin avatar henryju avatar kalidasya avatar simonbrandhof avatar therealjsie avatar tomverin avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

catchsaravana

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.