INSTALL.md

• Common installation notes / requirements
• Special points for Mobile plugins
  • Project structure
  • Howto build the SonarQube ecoCode plugins
    • Preliminary steps (only Android)
    • Others steps

Common installation notes / requirements

Please read common INSTALL.md in ecoCode-common repository.

Special points for Mobile plugins

Project structure

Here is a preview of project tree :

ecoCode-mobile          # Root directory
|
+--android-plugin       # Android
|
+--codenarc-converter   # codenarc-converter
|
+--ios-plugin           # IOS
|
\--docker-compose.yml   # Docker compose file

You will find more information about the plugins’ architecture in their folders

Howto build the SonarQube ecoCode plugins

Preliminary steps (only Android)

The Android plugin uses CodeNarc to scan the gradle files of Android projects. To have more information about CodeNarc: CodeNarc.

CodeNarc must be built separately. Please build CodeNarc (Gradle 6.9.2, Java 11), then add this custom-built CodeNarc to Maven dependencies :

# Unix or MacOS
./tool_prepare-codenarc.sh

# Windows
tool_prepare-codenarc.bat

Others steps

please check above common installation notes.