green-code-initiative / ecoCode-kotlin-android

Reduce the environmental footprint of your Kotlin-based Android apps with SonarQube

Mobile apps running on top of battery-limited, android-powered devices are more than others concerned by the reduction of their environmental footprint. Hence, we created ecoCode android for Kotlin, the version of ecoCode project fully dedicated to the Android Kotlin projects.

It provides static code analyzers to highlight code structures that may have a negative ecological impact: energy over-consumption, "fatware", shortening devices' lifespan, etc.

ecoCode android for Kotlin is based on an evolving catalog of best practices for Android. A SonarQube plugin then implements this catalog as rules for scanning your native Android projects.

To work on Android projects developed in Java, you can use the ecoCode Android plugin for Java projects.

This project is based on SonarSource - sonar-kotlin project, fork of the version of the 2023/07/03.

🚀 Quickstart

To build the project and run the test simply launch:

./gradlew build

Then, a docker file is configured to launch a SonarQube instance with the plugin installed:

docker compose up --build -d

Wait a little bit during first start initialization, and go to http://localhost:9000. Default credentials are admin/admin

🧩 Plugins version compatibility

Plugins Version	SonarQube version
0.0.+	SonarQube 9.9.+ LTS to 10.3