The ecocode-kotlin-android from green-code-initiative

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

EC518 : BluetoothBleCheck - Add descriptions for terms Ble & Bc and optimise rule

current behavior

Ble & Bc terms are used in variables.
Ble & Bc checks are tightly coupled :

if (bleImports.isNotEmpty() || bcImports.isNotEmpty()) {
            if (bleImports.isNotEmpty()) {
                bleImports.forEach {
                    it.importedReference?.let { data?.reportIssue(it, GOOD_PRACTICE_MESSAGE) }
                }
            } else {
                bcImports.forEach {
                    it.importedReference?.let { data?.reportIssue(it, ERROR_MESSAGE) }
                }
            }
        }

enhancement suggested

Ble & Bc terms are technical terms unknown to junior android developers. Their usage is now a standard, so it won't be a good idea to rename all their usage in the codebase to bluetoothLowEnergy & bluetoothClassic.
So a good compromise will be to add 2 comments at the top of the file :

// ble stands for "Bluetooth Low Energy"
// bc stands for "Bluetooth Classic"

Their use in the codebase are totally independent : we can import the Ble without the Bc and inversely import the Bc without using the Ble. It is also possible to use both of them (really bad practice, but still, possible).
So we can make them totally independent, and remove conditional checks :

bleImports.forEach { import ->
    import.importedReference?.let { data?.reportIssue(it, GOOD_PRACTICE_MESSAGE) }
}

bcImports.forEach { import ->
    import.importedReference?.let { data?.reportIssue(it, ERROR_MESSAGE) }
}

green-code-initiative / ecocode-kotlin-android Goto Github PK

ecocode-kotlin-android's Introduction

🚀 Quickstart

🧩 Plugins version compatibility

ecocode-kotlin-android's People

Contributors

Stargazers

Watchers

Forkers

ecocode-kotlin-android's Issues

EC518 : BluetoothBleCheck - Add descriptions for terms Ble & Bc and optimise rule

current behavior

enhancement suggested

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent