Skip to content

Commit

Permalink
migration from ecocode to creedengo : correction
Browse files Browse the repository at this point in the history
  • Loading branch information
dedece35 committed Dec 10, 2024
1 parent 987fcc3 commit 1a7ac12
Show file tree
Hide file tree
Showing 101 changed files with 139 additions and 147 deletions.
52 changes: 26 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ refer to the contribution section.
🌿 SonarQube Plugins
-------------------

7 technologies are supported by ecoCode right now:
7 technologies are supported by creedengo right now:

- "standard" plugins :
- [Java plugin](https://github.com/green-code-initiative/ecoCode-java)
- [JavaScript plugin](https://github.com/green-code-initiative/ecoCode-javascript)
- [PHP plugin](https://github.com/green-code-initiative/ecoCode-php)
- [Python plugin](https://github.com/green-code-initiative/ecoCode-python)
- [C# plugin](https://github.com/green-code-initiative/ecoCode-csharp)
- [Java plugin](https://github.com/green-code-initiative/creedengo-java)
- [JavaScript plugin](https://github.com/green-code-initiative/creedengo-javascript)
- [PHP plugin](https://github.com/green-code-initiative/creedengo-php)
- [Python plugin](https://github.com/green-code-initiative/creedengo-python)
- [C# plugin](https://github.com/green-code-initiative/creedengo-csharp)
- mobile plugins :
- [Android plugin](https://github.com/green-code-initiative/ecoCode-android)
- [iOS plugin](https://github.com/green-code-initiative/ecoCode-ios)
- [Android plugin](https://github.com/green-code-initiative/creedengo-android)
- [iOS plugin](https://github.com/green-code-initiative/creedengo-ios)

![Screenshot](docs/resources/screenshot.PNG)

Expand All @@ -44,7 +44,7 @@ There are two kinds of plugins :
The current repository is for web / backOffice
- One for mobile (Android), using [a set of smells](https://olegoaer.perso.univ-pau.fr/android-energy-smells/) theorised
by Olivier Le Goaër for Android.
You can find this plugin in the repository [here](https://github.com/green-code-initiative/ecocode-mobile)
You can find this plugin in the repository [here](https://github.com/green-code-initiative/creedengo-mobile)

### How a SonarQube plugin works

Expand All @@ -53,9 +53,9 @@ For example, you’ll be able to access of all your `for` loop, to explore conte

To better understand AST structure, you can use the [AST Explorer](https://astexplorer.net/).

### ecoCode rules specification repository
### creedengo rules specification repository

This project contains the specifications of all ecoCode rules, for all languages.
This project contains the specifications of all creedengo rules, for all languages.

#### Structure

Expand Down Expand Up @@ -103,7 +103,7 @@ See:
🚀 Getting Started
------------------

You can quickly have a look of ecoCode plugins with docker. Plase have a look at "Getting started" section of each plugin :
You can quickly have a look of creedengo plugins with docker. Plase have a look at "Getting started" section of each plugin :

- [Java plugin](https://github.com/green-code-initiative/creedengo-java?tab=readme-ov-file#-getting-started)
- [PHP plugin](https://github.com/green-code-initiative/creedengo-php?tab=readme-ov-file#-getting-started)
Expand All @@ -113,28 +113,28 @@ You can quickly have a look of ecoCode plugins with docker. Plase have a look at
🛒 Distribution
------------------

The main way to get ecoCode plugins is to download them from your SonarQube Marketplace (available in Administration section).
The main way to get creedengo 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.
We had split our plugins repository `creedengo` to one repository for each plugin on december 2023.
Thus, plugin versions are available on 2 repositories depending on version you want :

- Java plugin :
- from 0.x to 1.4.3 : [ecocode repository](https://github.com/green-code-initiative/ecoCode/releases)
- since 1.5.0 : [ecoCode-java repository](https://github.com/green-code-initiative/ecoCode-java/releases)
- from 0.x to 1.4.3 : [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications/releases)
- since 1.5.0 : [creedengo-java repository](https://github.com/green-code-initiative/creedengo-java/releases)
- PHP plugin :
- from 0.x to 1.3.1 : [ecocode repository](https://github.com/green-code-initiative/ecoCode/releases)
- since 1.4.0 : [ecoCode-php repository](https://github.com/green-code-initiative/ecoCode-php/releases)
- from 0.x to 1.3.1 : [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications/releases)
- since 1.4.0 : [creedengo-php repository](https://github.com/green-code-initiative/creedengo-php/releases)
- Python plugin :
- from 0.x to 1.3.1 : [ecocode repository](https://github.com/green-code-initiative/ecoCode/releases)
- since 1.4.0 : [ecoCode-python repository](https://github.com/green-code-initiative/ecoCode-python/releases)
- from 0.x to 1.3.1 : [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications/releases)
- since 1.4.0 : [creedengo-python repository](https://github.com/green-code-initiative/creedengo-python/releases)
- Javascript plugin :
- from 0.x to 1.3.0 : [ecocode repository](https://github.com/green-code-initiative/ecoCode/releases)
- since 1.4.0 : [ecoCode-javascript repository](https://github.com/green-code-initiative/ecoCode-javascript/releases)
- from 0.x to 1.3.0 : [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications/releases)
- since 1.4.0 : [creedengo-javascript repository](https://github.com/green-code-initiative/creedengo-javascript/releases)
- C# plugin :
- since 0.x : [ecocode repository](https://github.com/green-code-initiative/ecoCode-csharp/releases)
- Android plugin : [ecoCode-android repository](https://github.com/green-code-initiative/ecoCode-android/releases)
- iOS plugin : [ecoCode-ios repository](https://github.com/green-code-initiative/ecoCode-ios/releases)
- since 0.x : [creedengo repository](https://github.com/green-code-initiative/creedengo-csharp/releases)
- Android plugin : [creedengo-android repository](https://github.com/green-code-initiative/creedengo-android/releases)
- iOS plugin : [creedengo-ios repository](https://github.com/green-code-initiative/creedengo-ios/releases)

🧩 Plugins version compatibility
------------------
Expand Down Expand Up @@ -204,7 +204,7 @@ Here we honor some no-longer-active core team members who have made valuable con
- [Nicolas Daviet](https://github.com/NicolasDaviet)
- [Mathilde Grapin](https://github.com/fkotd)

They have contributed to the success of ecoCode :
They have contributed to the success of creedengo :

- [Davidson Consulting](https://www.davidson.fr/)
- [Orange Business](https://www.orange-business.com/)
Expand Down
10 changes: 5 additions & 5 deletions RULES.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@

## Rules support matrix by techno

This matrix lists all the rules identified as implementable within the standard ecoCode plugin.
This matrix lists all the rules identified as implementable within the standard creedengo plugin.

Some are applicable for different technologies.

- ✅ Rule included in current version of ecoCode
- ✅ Rule included in current version of creedengo
- 🚧 Rule implementation in progress
- 🚀 Rule to implement
- ❓ Rule to analyze for applicability
Expand Down Expand Up @@ -83,7 +83,7 @@ Some are applicable for different technologies.
## Rules to be reworked / measured / clarified

This table lists rules proposed by the community but they have to be reworked / measured / clarified before being
implemented in ecoCode plugins.
implemented in creedengo plugins.
(Issues and PR are closed, but they can be reopen once rework launched)

| Rule key | Language | Name | Description | Invalidation |
Expand All @@ -98,7 +98,7 @@ implemented in ecoCode plugins.

## Deprecated rules

This table lists rules proposed by the community but deprecated in ecoCode plugins with the justification. These rules
This table lists rules proposed by the community but deprecated in creedengo plugins with the justification. These rules
will be completely deleted in next releases and moved to bottom deleted rules array.

| Rule key | Language | Name | Description | Invalidation |
Expand All @@ -108,7 +108,7 @@ will be completely deleted in next releases and moved to bottom deleted rules ar

## Refused / Deleted rules

This table lists rules proposed by the community but refused or/and deleted in ecoCode plugins with the justification.
This table lists rules proposed by the community but refused or/and deleted in creedengo plugins with the justification.

| Rule key | Language | Name | Description | Invalidation |
|----------|------------|-------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

## 🌠 Official resources

Find official resources associated to ecoCode project [here](resources)
Find official resources associated to creedengo project [here](resources)

## 📜 Rules

ecoCode is based on evolving catalogs of [good practices](rules), for various technologies. A SonarQube plugin then implement these catalogs as rules for scanning your projects.
creedengo is based on evolving catalogs of [good practices](rules), for various technologies. A SonarQube plugin then implement these catalogs as rules for scanning your projects.

These catalogs of rules are listed [here](rules)
2 changes: 1 addition & 1 deletion docs/rules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ Web-oriented rules are based on :
- Référentiel général d'écoconception de services numériques (RGESN) (https://ecoresponsable.numerique.gouv.fr/publications/referentiel-general-ecoconception/)

We try to apply these rules to each supported language, so we maintain a matrix to follow current development.
Here are the selected rules currently used on ecoCode
Here are the selected rules currently used on creedengo

- [Rules support matrix by techno](/RULES.md)
26 changes: 9 additions & 17 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@
</scripts>
<options>
<option>-R "-DsourceDir=${project.build.directory}/rules-html"</option>
<option>-R "-DtargetDir=${project.build.outputDirectory}/io/ecocode/rules"</option>
<option>-R "-DtargetDir=${project.build.outputDirectory}/org/green-code-initiative/rules"</option>
</options>
</configuration>
</execution>
Expand All @@ -213,14 +213,6 @@
<plugin>
<!--
This module produce one artifact by language (with corresponding classifier)
For example, to add rule specifications for Python language, add following dependency in python sonarqube plugin:
<dependency>
<groupId>io.ecocode</groupId>
<artifactId>ecocode-rules-specifications</artifactId>
<version>${project.version}</version>
<classifier>python</classifier>
</dependency>
-->
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
Expand All @@ -234,7 +226,7 @@
</goals>
<configuration>
<descriptors>
<descriptor>../src/main/assembly/java.xml</descriptor>
<descriptor>${project.basedir}/src/main/assembly/java.xml</descriptor>
</descriptors>
</configuration>
</execution>
Expand All @@ -246,7 +238,7 @@
</goals>
<configuration>
<descriptors>
<descriptor>../src/main/assembly/php.xml</descriptor>
<descriptor>${project.basedir}/src/main/assembly/php.xml</descriptor>
</descriptors>
</configuration>
</execution>
Expand All @@ -258,7 +250,7 @@
</goals>
<configuration>
<descriptors>
<descriptor>../src/main/assembly/python.xml</descriptor>
<descriptor>${project.basedir}/src/main/assembly/python.xml</descriptor>
</descriptors>
</configuration>
</execution>
Expand All @@ -270,7 +262,7 @@
</goals>
<configuration>
<descriptors>
<descriptor>../src/main/assembly/javascript.xml</descriptor>
<descriptor>${project.basedir}/src/main/assembly/javascript.xml</descriptor>
</descriptors>
</configuration>
</execution>
Expand All @@ -282,7 +274,7 @@
</goals>
<configuration>
<descriptors>
<descriptor>../src/main/assembly/swift.xml</descriptor>
<descriptor>${project.basedir}/src/main/assembly/swift.xml</descriptor>
</descriptors>
</configuration>
</execution>
Expand All @@ -294,7 +286,7 @@
</goals>
<configuration>
<descriptors>
<descriptor>../src/main/assembly/xml.xml</descriptor>
<descriptor>${project.basedir}/src/main/assembly/xml.xml</descriptor>
</descriptors>
</configuration>
</execution>
Expand All @@ -306,7 +298,7 @@
</goals>
<configuration>
<descriptors>
<descriptor>../src/main/assembly/csharp.xml</descriptor>
<descriptor>${project.basedir}/src/main/assembly/csharp.xml</descriptor>
</descriptors>
</configuration>
</execution>
Expand All @@ -318,7 +310,7 @@
</goals>
<configuration>
<descriptors>
<descriptor>../src/main/assembly/html.xml</descriptor>
<descriptor>${project.basedir}/src/main/assembly/html.xml</descriptor>
</descriptors>
</configuration>
</execution>
Expand Down
2 changes: 1 addition & 1 deletion src/main/rules/GCI1/GCI1.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"performance",
"spring",
"eco-design",
"ecocode"
"creedengo"
],
"defaultSeverity": "Minor"
}
2 changes: 1 addition & 1 deletion src/main/rules/GCI10/GCI10.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
},
"tags": [
"eco-design",
"ecocode"
"creedengo"
],
"defaultSeverity": "Minor"
}
2 changes: 1 addition & 1 deletion src/main/rules/GCI11/GCI11.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"constantCost": "5min"
},
"tags": [
"ecocode",
"creedengo",
"eco-design",
"performance"
],
Expand Down
2 changes: 1 addition & 1 deletion src/main/rules/GCI12/GCI12.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"constantCost": "10min"
},
"tags": [
"ecocode",
"creedengo",
"eco-design",
"performance"
],
Expand Down
2 changes: 1 addition & 1 deletion src/main/rules/GCI13/GCI13.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"constantCost": "30min"
},
"tags": [
"ecocode",
"creedengo",
"eco-design",
"nestjs",
"performance"
Expand Down
2 changes: 1 addition & 1 deletion src/main/rules/GCI2/GCI2.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"tags": [
"eco-design",
"performance",
"ecocode"
"creedengo"
],
"defaultSeverity": "Minor"
}
2 changes: 1 addition & 1 deletion src/main/rules/GCI203/GCI203.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"performance",
"user-experience",
"eco-design",
"ecocode"
"creedengo"
],
"defaultSeverity": "Minor"
}
2 changes: 1 addition & 1 deletion src/main/rules/GCI22/GCI22.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"tags": [
"eco-design",
"performance",
"ecocode"
"creedengo"
],
"defaultSeverity": "Minor"
}
2 changes: 1 addition & 1 deletion src/main/rules/GCI24/GCI24.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"constantCost": "15min"
},
"tags": [
"ecocode",
"creedengo",
"eco-design",
"performance",
"sql"
Expand Down
2 changes: 1 addition & 1 deletion src/main/rules/GCI25/GCI25.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"constantCost": "5min"
},
"tags": [
"ecocode",
"creedengo",
"eco-design",
"jsx",
"performance",
Expand Down
2 changes: 1 addition & 1 deletion src/main/rules/GCI26/GCI26.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"constantCost": "5min"
},
"tags": [
"ecocode",
"creedengo",
"eco-design",
"jsx",
"performance",
Expand Down
2 changes: 1 addition & 1 deletion src/main/rules/GCI27/GCI27.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"tags": [
"performance",
"eco-design",
"ecocode"
"creedengo"
],
"defaultSeverity": "Minor"
}
2 changes: 1 addition & 1 deletion src/main/rules/GCI28/GCI28.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"performance",
"error-handling",
"eco-design",
"ecocode"
"creedengo"
],
"defaultSeverity": "Minor"
}
2 changes: 1 addition & 1 deletion src/main/rules/GCI29/GCI29.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"constantCost": "15min"
},
"tags": [
"ecocode",
"creedengo",
"eco-design",
"jsx",
"performance",
Expand Down
Loading

0 comments on commit 1a7ac12

Please sign in to comment.