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.
6 technologies are supported by ecoCode right now:
- "standard" plugins :
- mobile plugins :
There are two kinds 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
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.
You can quickly have a look of ecoCode plugins with docker. Plase have a look at "Getting started" section of each plugin :
The main way to get ecoCode plugins is to download them from your SonarQube Marketplace (available in Administration section). But if you want, you can also download them from GitHub releases.
We had split our plugins repository ecocode to one repository for each plugin on december 2023.
Thus, plugin versions are available on 2 repositories depending on version you want :
- Java plugin :
- from 0.x to 1.4.3 : ecocode repository
- since 1.5.0 : ecoCode-java repository
- PHP plugin :
- from 0.x to 1.3.1 : ecocode repository
- since 1.4.0 : ecoCode-php repository
- Python plugin :
- from 0.x to 1.3.1 : ecocode repository
- since 1.4.0 : ecoCode-python repository
- Javascript plugin :
- from 0.x to 1.3.0 : ecocode repository
- since 1.4.0 : ecoCode-javascript repository
- C# plugin :
- since 0.x : ecocode repository
- Android plugin : ecoCode-android repository
- iOS plugin : ecoCode-ios repository
| Plugins Version | SonarQube version |
|---|---|
| 1.4.+ | SonarQube 9.4.+ LTS to 10.1 |
| 1.3.+ | SonarQube 9.4.+ LTS to 10.0 |
| 1.2.+ | SonarQube 9.4.+ LTS to 10.0 |
| 1.1.+ | SonarQube 9.4.+ LTS to 9.9 |
| 1.0.+ | SonarQube 9.4.+ LTS to 9.9 |
| 0.2.+ | SonarQube 9.4.+ LTS to 9.9 |
| 0.1.+ | SonarQube 8.9.+ LTS to 9.3 |
| Plugins Version | Java version |
|---|---|
| 1.4.+ | 11 / 17 |
| 1.3.+ | 11 / 17 |
| 1.2.+ | 11 / 17 |
| 1.1.+ | 11 / 17 |
| 1.0.+ | 11 / 17 |
| 0.2.+ | 11 / 17 |
| 0.1.+ | 11 / 17 |
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
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
- Maxime MALGORN
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 :