https://github.com/green-code-initiative/creedengo-javascript
Reduce the environmental footprint of your JS/TS software programs
https://github.com/green-code-initiative/creedengo-javascript
ecodesign eslint-plugin javascript sonarqube sonarqube-plugin typescript
Last synced: about 1 year ago
JSON representation
Reduce the environmental footprint of your JS/TS software programs
- Host: GitHub
- URL: https://github.com/green-code-initiative/creedengo-javascript
- Owner: green-code-initiative
- License: gpl-3.0
- Created: 2023-02-10T13:54:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-31T21:14:15.000Z (about 1 year ago)
- Last Synced: 2025-03-31T21:15:14.763Z (about 1 year ago)
- Topics: ecodesign, eslint-plugin, javascript, sonarqube, sonarqube-plugin, typescript
- Language: JavaScript
- Homepage: https://green-code-initiative.org
- Size: 5.32 MB
- Stars: 25
- Watchers: 6
- Forks: 19
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Creedengo-JS
_creedengo_ 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.
Websites are becoming increasingly heavy and complex over the years. They represent an important part
of the digital environmental footprint. The JavaScript/TypeScript part of the project focuses on providing rules and guidelines to optimize web applications and server-side code written in JavaScript and TypeScript.
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://sonarcloud.io/project/overview?id=green-code-initiative_ecoCode-linter)
## 🌿 SonarQube plugin
_Creedengo_ JavaScript is an "eco-responsibility" static code analyzer for projects based on the JavaScript ecosystem. It
can handle JavaScript, TypeScript and all frameworks that use them. Its main purpose is to work with website source
code, but it can also analyze back-end code.
This project proposes rules for the following technologies:
- JavaScript
- TypeScript
- NestJS
- React (JSX)
- React Native / Expo
## 🔧 ESLint plugin
This project uses an internal ESLint plugin to analyze your source code.
If you are not using SonarQube, we have a solution for you: the linter is working nicely on its own! \
Follow instructions in the [dedicated README file](eslint-plugin/README.md) to use it as a standalone plugin.
## 🛒 Distribution
[](https://github.com/green-code-initiative/creedengo-javascript/releases/latest)
[](https://npmjs.com/package/@creedengo/eslint-plugin)
**The plugin is available from the official SonarQube marketplace! Check the
[version matrix here](https://docs.sonarsource.com/sonarqube/latest/instance-administration/plugin-version-matrix/).**
Ready to use binaries for SonarQube are also
available [from GitHub](https://github.com/green-code-initiative/creedengo-javascript/releases). \
Make sure to place the binary inside `extensions/plugins/` folder of your SonarQube instance.
The standalone version of the ESLint plugin is available from [npmjs](https://npmjs.com/package/@creedengo/eslint-plugin).
## 🧩 Compatibility
| Plugins Version | SonarQube version | ESLint version |
| --------------- | ----------------- | -------------- |
| 2.+ | 9.9.+ LTA to 25.3 | 7.x, 8.x |
| 1.4, 1.5 | 9.9.+ LTA to 10.7 | 7.x, 8.x |
## 🤝 Contribution
You have an idea or you want to help us improving this project? \
We are open to your suggestions and contributions! Open an issue or PR 🚀
Check out the [CONTRIBUTING.md](CONTRIBUTING.md) file
and follow the various guides to start contributing.
Thank you to all the people who already contributed to creedengo-javascript!
- Elise Dubillot
- Laetitia Bézie