lcanagui / ecoCode-1

Reduce the environmental footprint of your software programs with SonarQube

ecoCode is a collective project aiming to reduce environmental footprint of software at the code level. The goal of the project is to provide a list of static code analyzers to highlight code structures that may have a negative ecological impact: energy and resources over-consumption, "fatware", shortening terminals' lifespan, etc.

ecoCode is based on evolving catalogs of good practices, for various technologies. A SonarQube plugin then implements these catalogs as rules for scanning your projects.

Warning: this is still a very early stage project. Any feedback or contribution will be highly appreciated. Please refer to the contribution section.

🌿 SonarQube Plugins

4 technologies are supported by ecoCode right now:

• Java
• JavaScript
• PHP
• Python

eco-design SonarQube plugin

There is two kind of plugins :

• One for web / backoffice (PHP, Python, Java, JavaScript), using smells described in the 2nd edition of the repository published in september 2015. You can find all the rules here (in french). The current repository is for web / backOffice
• One for mobile (Android), using a set of smells theorised by Olivier Le Goaër for Android. You can find this plugin in the repository here

How a SonarQube plugin works

Code is parsed to be transformed as AST. AST will allow you to access one or more nodes of your code. For example, you’ll be able to access of all your for loop, to explore content etc.

To better understand AST structure, you can use the AST Explorer.

JavaScript plugin works differently because it does not use AST. More information here

🚀 Getting Started

You can give a try with a one command docker :

docker run -ti --rm \
       -v sq_ecocode_logs:/opt/sonarqube/logs \
       -v sq_ecocode_data:/opt/sonarqube/data \
       -p 9000:9000 \
       --name sonarqube-ecocode ghcr.io/green-code-initiative/sonarqube-ecocode:latest

And add the eco-conception tagged rules to Quality Profiles.

You can also download each plugin separatly and copy the plugin (jar file) to $SONAR_INSTALL_DIR/extensions/plugins and restart SonarQube.

Or you can directly use a all-in-one docker-compose

🛒 Distribution

Ready to use binaries are available from GitHub.

🧩 Plugins version compatibility

Plugins Version	SonarQube version
0.1.+	SonarQube 8.9.+ LTS to 9.3
0.2.+	SonarQube 9.4.+ LTS to 9.9

☕ Plugin Java part compatibility

Plugins Version	Java version
0.1.+	11 / 17
0.2.+	11 / 17

🤝 Contribution

You are a technical expert, a designer, a project manager, a CSR expert, an ecodesign expert...

You want to offer the help of your company, help us to organize, communicate on the project ?

You have ideas to submit to us ?

We are listening to you to make the project progress collectively, and maybe with you !

WE NEED YOU !

Here the Starter pack

🤓 Main contributors

Any question ? We are here for you ! first, create an issue, please. Then, if no answer, contact ...

• Jules Delecour
• Geoffrey Lalloué
• Julien Hertout
• Justin Berque
• Olivier Le Goaër
• Maxime DUBOIS
• David DE CARVALHO

🧐 Core Team Emeriti

Here we honor some no-longer-active core team members who have made valuable contributions in the past.

• Gaël Pellevoizin
• Nicolas Daviet
• Mathilde Grapin

They have contributed to the success of ecoCode :

• Davidson Consulting
• Orange Business Services
• Snapp'
• Université de Pau et des Pays de l'Adour (UPPA)
• Solocal / PagesJaunes.fr

They supported the project :

• Région Nouvelle-Aquitaine

Links

• https://docs.sonarqube.org/latest/analysis/overview/