33Websites are becoming increasingly heavy and complex over the years. They represent an important part
44of the digital environmental footprint. The objective of this project is to detect smells in a website source code
55that can have a negative ecological impact: overconsumption of energy, "fatware", shortening of the life span of
6- devices, etc. This project is part of [ ecoCode ] ( https://github.com/green-code-initiative/ecoCode ) .
6+ devices, etc. This project is part of [ Creedengo ] ( https://github.com/green-code-initiative/ecoCode ) (previously ecoCode).
77
88Rules in this repository are mainly based from book
99[ 115 Web Ecodesign Best Practices] ( https://github.com/cnumr/best-practices ) .
1010This reference is maintained by [ CNumR] ( https://collectif.greenit.fr/ ) , a french collective that works
1111for a responsible design of digital services. You can find all applicable rules in the [ RULES.md file] ( RULES.md ) .
1212
1313[ ![ License: GPL v3] ( https://img.shields.io/badge/License-GPLv3-blue.svg )] ( https://www.gnu.org/licenses/gpl-3.0 )
14- ![ Build ] ( https://github.com/green-code-initiative/ecoCode -javascript/actions/workflows/build .yml/badge.svg )
14+ [ ![ CI ] ( https://github.com/green-code-initiative/creedengo -javascript/actions/workflows/ci .yml/badge.svg?branch=main )] ( https://github.com/green-code-initiative/creedengo-javascript/actions/workflows/ci.yml )
1515[ ![ Sonar Quality gate] ( https://img.shields.io/sonar/quality_gate/green-code-initiative_ecoCode-linter?server=https%3A%2F%2Fsonarcloud.io )] ( https://sonarcloud.io/project/overview?id=green-code-initiative_ecoCode-linter )
1616
17- 🌿 SonarQube plugin
18- ---------------------------------
17+ ## 🌿 SonarQube plugin
1918
20- _ ecoCode _ JavaScript is an "eco-responsibility" static code analyzer for projects based on the JavaScript ecosystem. It
19+ _ Creedengo _ JavaScript is an "eco-responsibility" static code analyzer for projects based on the JavaScript ecosystem. It
2120can handle JavaScript, TypeScript and all frameworks that use them. Its main purpose is to work with website source
2221code, but it can also analyze back-end code.
2322
@@ -29,46 +28,42 @@ This project proposes rules for the following technologies:
2928- React (JSX)
3029- React Native / Expo
3130
32- 🔧 ESLint plugin
33- ----------------
31+ ## 🔧 ESLint plugin
3432
3533This project uses an internal ESLint plugin to analyze your source code.
3634
3735If you are not using SonarQube, we have a solution for you: the linter is working nicely on its own! \
3836Follow instructions in the [ dedicated README file] ( eslint-plugin/README.md ) to use it as a standalone plugin.
3937
40- 🛒 Distribution
41- ---------------
38+ ## 🛒 Distribution
4239
43- [ ![ sonar-plugin version] ( https://img.shields.io/github/v/release/green-code-initiative/ecoCode -javascript?label=SonarQube%20plugin )] ( https://github.com/green-code-initiative/ecoCode -javascript/releases/latest )
44- [ ![ eslint-plugin version] ( https://img.shields.io/npm/v/@ecocode /eslint-plugin?label=ESLint%20plugin )] ( https://npmjs.com/package/@ecocode /eslint-plugin )
40+ [ ![ sonar-plugin version] ( https://img.shields.io/github/v/release/green-code-initiative/creedengo -javascript?label=SonarQube%20plugin )] ( https://github.com/green-code-initiative/creedengo -javascript/releases/latest )
41+ [ ![ eslint-plugin version] ( https://img.shields.io/npm/v/@creedengo /eslint-plugin?label=ESLint%20plugin )] ( https://npmjs.com/package/@creedengo /eslint-plugin )
4542
4643** The plugin is available from the official SonarQube marketplace! Check the
4744[ version matrix here] ( https://docs.sonarsource.com/sonarqube/latest/instance-administration/plugin-version-matrix/ ) .**
4845
4946Ready to use binaries for SonarQube are also
50- available [ from GitHub] ( https://github.com/green-code-initiative/ecoCode -javascript/releases ) . \
47+ available [ from GitHub] ( https://github.com/green-code-initiative/creedengo -javascript/releases ) . \
5148Make sure to place the binary inside ` extensions/plugins/ ` folder of your SonarQube instance.
5249
53- The standalone version of the ESLint plugin is available from [ npmjs] ( https://npmjs.com/package/@ecocode /eslint-plugin ) .
50+ The standalone version of the ESLint plugin is available from [ npmjs] ( https://npmjs.com/package/@creedengo /eslint-plugin ) .
5451
55- 🧩 Compatibility
56- ----------------
52+ ## 🧩 Compatibility
5753
5854| Plugins Version | SonarQube version | ESLint version |
59- | ----------------- | ------------------- | ---------------- |
55+ | --------------- | ----------------- | -------------- |
6056| 1.4.+, 1.5.+ | 9.9.+ LTA to 10.7 | 7+ |
6157
62- 🤝 Contribution
63- ---------------
58+ ## 🤝 Contribution
6459
6560You have an idea or you want to help us improving this project? \
6661We are open to your suggestions and contributions! Open an issue or PR 🚀
6762
6863Check out the [ CONTRIBUTING.md] ( CONTRIBUTING.md ) file
6964and follow the various guides to start contributing.
7065
71- Thank you to all the people who already contributed to ecoCode -javascript!
66+ Thank you to all the people who already contributed to creedengo -javascript!
7267
7368- Elise Dubillot
7469- Laetitia Bézie
0 commit comments