https://github.com/green-code-initiative/creedengo-kotlin
Reduce the environmental footprint of your Kotlin software programs
https://github.com/green-code-initiative/creedengo-kotlin
ecodesign kotlin sonarqube sonarqube-plugin
Last synced: about 2 months ago
JSON representation
Reduce the environmental footprint of your Kotlin software programs
- Host: GitHub
- URL: https://github.com/green-code-initiative/creedengo-kotlin
- Owner: green-code-initiative
- License: gpl-3.0
- Created: 2025-03-26T20:46:45.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-03-28T10:26:57.000Z (about 2 months ago)
- Last Synced: 2025-03-28T11:31:41.826Z (about 2 months ago)
- Topics: ecodesign, kotlin, sonarqube, sonarqube-plugin
- Language: Java
- Homepage: https://green-code-initiative.org/
- Size: 31.3 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
creedengo-kotlin
===========
_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.
_creedengo_ is based on evolving catalogs
of [good practices](https://github.com/green-code-initiative/creedengo-rules-specifications/blob/main/docs/rules), for various technologies.
This
SonarQube plugin then implements these catalogs as rules for scanning your Kotlin projects.
> ⚠️ This is still a very early stage project. Any feedback or contribution will be highly appreciated. Please
> refer to the contribution section.
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://github.com/green-code-initiative/creedengo-common/blob/main/doc/CODE_OF_CONDUCT.md)
🌿 SonarQube Plugins
-------------------
This plugin is part of the creedengo project.\
You can find a list of all our other plugins in
the [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications#-sonarqube-plugins)
🚀 Getting Started
------------------
You can give a try with a one command:
```sh
./mvnw verify -Pkeep-running
```
... then you can use Kotlin test project repository to test the environment : see [Kotlin test project in `./src/it/test-projects/creedengo-kotlin-plugin-test-project`](./src/it/test-projects/creedengo-kotlin-plugin-test-project)
NB: To install other `creedengo` plugins, you can :
- add JAVA System properties `Dtest-it.additional-plugins` with a comma separated list of plugin IDs (`groupId:artifactId:version`), or plugins JAR (`file://....`) to install.
For example :
```sh
./mvnw verify -Pkeep-running -Dtest-it.additional-plugins=org.sonarsource.javascript:sonar-plugin:10.1.0.21143
```
- install different creedengo plugins with Marketplace (inside admin panel of SonarQube)
You can also directly use a [all-in-one docker-compose](https://github.com/green-code-initiative/creedengo-common/blob/main/doc/INSTALL.md#start-sonarqube-if-first-time)
... and configure local SonarQube (security config and quality profile : see [configuration](https://github.com/green-code-initiative/creedengo-common/blob/main/doc/INSTALL.md#configuration-sonarqube) for more details).
🛒 Distribution
------------------
Ready to use binaries are available [from GitHub](https://github.com/green-code-initiative/creedengo-java/releases).
🧩 Compatibility
-----------------
| Plugin version | SonarQube version | Kotlin version |
|----------------|---------------------|------------------------------------------------------------------------------------------------|
| 1.+ | 9.9.+ LTS to 25.3.0 | [17](https://docs.sonarsource.com/sonarqube/9.9/requirements/prerequisites-and-overview/#java) |
> Compatibility table of versions lower than 1.4.+ are available from the
> main [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications#-plugins-version-compatibility).
🤝 Contribution
---------------
check [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications#-contribution)
🤓 Main contributors
--------------------
check [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications#-main-contributors)
Links
-----
- https://docs.sonarqube.org/latest/analysis/overview/