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.
4 technologies are supported by ecoCode right now:
There is two kind of plugins :
Code is parsed to be transformed as AST. AST will allow you to access one or more nodes of your code.
For example, youll 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 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-design 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.
Then you can use different test project repositories (please check
README.md files inside) to test the environment. Example : PHP test project
Or you can directly use a all-in-one docker-compose
Ready to use binaries are available from GitHub.
|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 ...
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 :