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

7 technologies are supported by ecoCode right now:

• "standard" plugins :
  • Java plugin
  • JavaScript plugin
  • PHP plugin
  • Python plugin
  • C# plugin
• mobile plugins :
  • Android plugin
  • iOS plugin

eco-design SonarQube plugin

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

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.

🚀 Getting Started

You can quickly have a look of ecoCode plugins with docker. Plase have a look at "Getting started" section of each plugin :

• Java plugin
• PHP plugin
• Python plugin
• C# plugin

🛒 Distribution

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 compatibility

☕ Plugin Java part compatibility

🤝 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
• Maxime MALGORN
• Vianney DE BELLABRE
• Jérôme CARDON

🧐 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
• Snapp'
• Université de Pau et des Pays de l'Adour (UPPA)
• Solocal / PagesJaunes.fr
• Capgemini
• Accenture

They supported the project :

• Région Nouvelle-Aquitaine

Links

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