Home

Awesome

Logo

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.

License: GPL v3 Contributor Covenant

🌿 SonarQube Plugins

7 technologies are supported by ecoCode right now:

Screenshot

eco-design SonarQube plugin

Ekko logo

There are two kinds of plugins :

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 :

🛒 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 :

🧩 Plugins version compatibility

Plugins VersionSonarQube 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

☕ Plugin Java part compatibility

Plugins VersionJava 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

🤝 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 ...

🧐 Core Team Emeriti

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

They have contributed to the success of ecoCode :

They supported the project :

Links