This is a developer documentation. If you want to analyze source code in SonarQube read the analysis of Ruby documentation.
We use whitequark parser to parse the Ruby language by embedding it using JRuby runtime.
- AST documentation for the parser can be found here
- We use simple Ruby script to call the parser and invoke our visitor written in Java
To provide feedback (request a feature, report a bug, etc.) use the SonarQube Community Forum. Please do not forget to specify the language, plugin version, and SonarQube version.
Build and run Unit Tests:
./gradlew build
By default, Integration Tests (ITs) are skipped during builds. If you want to run them, you need first to retrieve the related projects which are used as input:
git submodule update --init its/sources
Then build and run the Integration Tests using the its property:
./gradlew build -Pits --info --no-daemon
You can also build and run only Ruling Tests using the ruling property:
./gradlew build -Pruling --info --no-daemon
License headers are automatically updated by the spotless plugin but only for Java files.
Furthermore, there are files such as package-info.java and module-info.java that spotless ignores.
Copyright 2018-2024 SonarSource.
SonarQube analyzers released after November 29, 2024, including patch fixes for prior versions, are published under the Sonar Source-Available License Version 1 (SSALv1).
See individual files for details that specify the license applicable to each file. Files subject to the SSALv1 will be noted in their headers.