- Install the Java Development Kit (JDK) version 11 or later (make sure it's an LTS version) - you can install it from here
- Install IntelliJ IDEA Community Edition
- Install Apache Maven
- Setup the Maven Settings (internal link)
- Setup the Orchestrator (internal link)
- Clone this repository
- Download sub-modules
git submodule update --init --recursive
- Build the plugin
- To build the plugin while embedding a local build of the analyzer you can either:
-
run
.\scripts\build\dev-build.ps1 -build -test -buildJava
The flags
-restore -build -test
need to be run only when you have changed the analyzer. Otherwise you can run only-buildJava
-
or run the following commands:
msbuild /t:rebuild .\analyzers\SonarAnalyzer.sln
mvn clean install -P local-analyzer -D analyzer.configuration=Debug
-
- To build the plugin while embedding a local build of the analyzer you can either:
When working with Eclipse or IntelliJ please follow the sonar guidelines
As for any maven project, the command mvn clean install
automatically runs the unit tests.
Before running ITs, you need to setup the NUGET_PATH environment variable to point to the nuget.exe executable. Additional information about the integration tests configuration can be found at the following internal link.
To run the ITs, from your command prompt, you can either:
- go to the
its
folder and runmvn clean install
- or run
.\scripts\build\dev-build.ps1 -itsJava
Please see the How to contribute section for details on contributing changes back to the code.